From 0ffb7ae589e37b8c9bcf795256c9cf78958f0a3e Mon Sep 17 00:00:00 2001 From: SAIKAT KARMAKAR Date: Sun, 7 Jan 2024 01:29:27 +0530 Subject: [PATCH] project renamed reverted back to bee-py --- CONTRIBUTING.md | 8 ++++---- README.md | 34 +++++++++++++++++----------------- docs/index.md | 2 +- docs/usage.md | 2 +- pyproject.toml | 14 +++++++------- src/bee_py/bee_debug.py | 2 +- 6 files changed, 31 insertions(+), 31 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b15e953..53629d2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,9 +97,9 @@ This will allow a chance to talk it over with the owners and validate your appro [code of conduct]: CODE_OF_CONDUCT.md -[documentation]: https://beePy.readthedocs.io/ +[documentation]: https://bee-py.readthedocs.io/ [gpl 3.0 license]: https://opensource.org/licenses/GPL-3.0 -[issue tracker]: https://github.com/alienrobotninja/beePy/issues -[pull request]: https://github.com/alienrobotninja/beePy/pulls +[issue tracker]: https://github.com/alienrobotninja/bee-py/issues +[pull request]: https://github.com/alienrobotninja/bee-py/pulls [pytest]: https://pytest.readthedocs.io/ -[source code]: https://github.com/alienrobotninja/beePy +[source code]: https://github.com/alienrobotninja/bee-py diff --git a/README.md b/README.md index a9c864c..69f99d0 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,21 @@
-| Feature | Value | -| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Technology | [![Python](https://img.shields.io/badge/Python-3776AB.svg?style=flat&logo=Python&logoColor=white)](https://www.python.org/) [![Ape](https://img.shields.io/badge/Built%20with-Ape-blue.svg)](https://github.com/ApeWorX/ape) [![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-2088FF.svg?style=flat&logo=GitHub-Actions&logoColor=white)](https://github.com/features/actions) [![Pytest](https://img.shields.io/badge/Pytest-0A9EDC.svg?style=flat&logo=Pytest&logoColor=white)](https://github.com/alienrobotninja/beePy/actions/workflows/tests.yml/badge.svg) [![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm-project.org) | -| Linting | [![Code style: black](https://img.shields.io/badge/Code%20Style-black-000000.svg)](https://github.com/psf/black) ![Style Guide](https://img.shields.io/badge/Style%20Guide-Flake8-blue) [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) | -| Type Checking | [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/) | -| CI/CD | [![Tests](https://github.com/alienrobotninja/beePy/actions/workflows/tests.yml/badge.svg)](https://github.com/alienrobotninja/beePy/actions/workflows/tests.yml) [![Labeler](https://github.com/alienrobotninja/beePy/actions/workflows/labeler.yml/badge.svg)](https://github.com/alienrobotninja/beePy/actions/workflows/labeler.yml) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) | -| Docs | [![Read the Docs](https://img.shields.io/readthedocs/beePy/latest.svg?label=Read%20the%20Docs)](https://beePy.readthedocs.io/) | -| Package | [![PyPI - Version](https://img.shields.io/pypi/v/beePy.svg)](https://pypi.org/project/beePy/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/beePy)](https://pypi.org/project/beePy/) [![PyPI - License](https://img.shields.io/pypi/l/beePy)](https://pypi.org/project/beePy/) | -| Meta | [![GitHub license](https://img.shields.io/github/license/alienrobotninja/beePy?style=flat&color=1573D5)](https://github.com/alienrobotninja/beePy/blob/main/LICENSE) [![GitHub last commit](https://img.shields.io/github/last-commit/alienrobotninja/beePy?style=flat&color=1573D5)](https://github.com/alienrobotninja/beePy/commits/main) [![GitHub commit activity](https://img.shields.io/github/commit-activity/m/alienrobotninja/beePy?style=flat&color=1573D5)](https://github.com/alienrobotninja/beePy/graphs/commit-activity) [![GitHub top language](https://img.shields.io/github/languages/top/alienrobotninja/beePy?style=flat&color=1573D5)](https://github.com/alienrobotninja/beePy) | +| Feature | Value | +| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Technology | [![Python](https://img.shields.io/badge/Python-3776AB.svg?style=flat&logo=Python&logoColor=white)](https://www.python.org/) [![Ape](https://img.shields.io/badge/Built%20with-Ape-blue.svg)](https://github.com/ApeWorX/ape) [![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-2088FF.svg?style=flat&logo=GitHub-Actions&logoColor=white)](https://github.com/features/actions) [![Pytest](https://img.shields.io/badge/Pytest-0A9EDC.svg?style=flat&logo=Pytest&logoColor=white)](https://github.com/alienrobotninja/bee-py/actions/workflows/tests.yml/badge.svg) [![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm-project.org) | +| Linting | [![Code style: black](https://img.shields.io/badge/Code%20Style-black-000000.svg)](https://github.com/psf/black) ![Style Guide](https://img.shields.io/badge/Style%20Guide-Flake8-blue) [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) | +| Type Checking | [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/) | +| CI/CD | [![Tests](https://github.com/alienrobotninja/bee-py/actions/workflows/tests.yml/badge.svg)](https://github.com/alienrobotninja/bee-py/actions/workflows/tests.yml) [![Labeler](https://github.com/alienrobotninja/bee-py/actions/workflows/labeler.yml/badge.svg)](https://github.com/alienrobotninja/bee-py/actions/workflows/labeler.yml) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) | +| Docs | [![Read the Docs](https://img.shields.io/readthedocs/bee-py/latest.svg?label=Read%20the%20Docs)](https://bee-py.readthedocs.io/) | +| Package | [![PyPI - Version](https://img.shields.io/pypi/v/bee-py.svg)](https://pypi.org/project/bee-Py/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/bee-Py)](https://pypi.org/project/bee-py/) [![PyPI - License](https://img.shields.io/pypi/l/bee-Py)](https://pypi.org/project/bee-py/) | +| Meta | [![GitHub license](https://img.shields.io/github/license/alienrobotninja/bee-py?style=flat&color=1573D5)](https://github.com/alienrobotninja/bee-py/blob/main/LICENSE) [![GitHub last commit](https://img.shields.io/github/last-commit/alienrobotninja/bee-py?style=flat&color=1573D5)](https://github.com/alienrobotninja/bee-py/commits/main) [![GitHub commit activity](https://img.shields.io/github/commit-activity/m/alienrobotninja/bee-py?style=flat&color=1573D5)](https://github.com/alienrobotninja/bee-py/graphs/commit-activity) [![GitHub top language](https://img.shields.io/github/languages/top/alienrobotninja/bee-py?style=flat&color=1573D5)](https://github.com/alienrobotninja/bee-py) |
## 📖 Table of Contents -- [🐝 Bee Py](#-beePy) +- [🐝 Bee Py](#-bee-py) - [📖 Table of Contents](#-table-of-contents) - [🌐 Overview](#-overview) - [✨ Features](#-features) @@ -53,10 +53,10 @@ This is the library for connecting to Bee decentralised storage using python. ## 🛠️ Installation -You can install `beePy` via \[pip\] from \[PyPI\]: +You can install `bee-py` via \[pip\] from \[PyPI\]: ```sh -pip install beePy +pip install bee-py ``` ## 🚀 Usage @@ -134,8 +134,8 @@ print(batch_id) This project is developed using [pdm](https://pdm-project.org/). So the quickest way to get started is using `pdm`. Install pdm using `pip`, `pipx` etc & then follow the following steps ```sh -git clone https://github.com/alienrobotninja/beePy -cd beePy +git clone https://github.com/alienrobotninja/bee-py +cd bee-py # To install all the dev & lint dependencies pdm install -G:all ``` @@ -157,7 +157,7 @@ _Bee Py_ is free and open source software. There are some know issues like: - Some tests are perfomed on older versions of bee. -- Some tests are stuck for hours when using the latest Bee API(not `beePy` issue). +- Some tests are stuck for hours when using the latest Bee API(not `bee-py` issue). - Some tests are skipped because of outdated libraries used by various `ethersphere` projects. If you encounter any problems, @@ -173,5 +173,5 @@ Developed by [@Aviksaikat](https://github.com/aviksaikat) -[contributor guide]: https://github.com/alienrobotninja/beePy/blob/main/CONTRIBUTING.md -[license]: https://github.com/alienrobotninja/beePy/blob/main/LICENSE +[contributor guide]: https://github.com/alienrobotninja/bee-py/blob/main/CONTRIBUTING.md +[license]: https://github.com/alienrobotninja/bee-py/blob/main/LICENSE diff --git a/docs/index.md b/docs/index.md index a0f2e60..8e4d0c0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,5 +15,5 @@ reference contributing Code of Conduct License -Changelog +Changelog ``` diff --git a/docs/usage.md b/docs/usage.md index 002e84d..36de8a1 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -2,6 +2,6 @@ ```{eval-rst} .. click:: bee_py.__main__:main - :prog: beePy + :prog: bee-py :nested: full ``` diff --git a/pyproject.toml b/pyproject.toml index 2b8be55..ba0b0d5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ # Project specifications [project] -name = "beePy" +name = "bee-py" version = "0.1.0" description = "Python client library for connecting to Bee decentralised storage" authors = [ @@ -31,10 +31,10 @@ classifiers = [ ] [project.urls] -homepage = "https://github.com/alienrobotninja/beePy" -repository = "https://github.com/alienrobotninja/beePy" -Issues = "https://github.com/alienrobotninja/beePy/issues" -Changelog = "https://github.com/alienrobotninja/beePy/releases" +homepage = "https://github.com/alienrobotninja/bee-py" +repository = "https://github.com/alienrobotninja/bee-py" +Issues = "https://github.com/alienrobotninja/bee-py/issues" +Changelog = "https://github.com/alienrobotninja/bee-py/releases" # build system to use [build-system] @@ -178,8 +178,8 @@ parallel = true omit = ["src/bee_py/__about__.py"] [tool.coverage.paths] -bee_py = ["src/bee_py", "*/beePy/src/bee_py"] -tests = ["tests", "*/beePy/tests"] +bee_py = ["src/bee_py", "*/bee-py/src/bee_py"] +tests = ["tests", "*/bee-py/tests"] [tool.coverage.report] exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"] diff --git a/src/bee_py/bee_debug.py b/src/bee_py/bee_debug.py index 18df027..3306007 100644 --- a/src/bee_py/bee_debug.py +++ b/src/bee_py/bee_debug.py @@ -637,7 +637,7 @@ def get_node_info(self, options: Optional[Union[BeeRequestOptions, dict]] = None return status.get_node_info(self.__get_request_options_for_call(options)) # type: ignore def is_supported_exact_version(self, options: Optional[Union[BeeRequestOptions, dict]] = None) -> bool: - """**Deprecated:** Checks if the connected Bee node version is supported by beePy. + """**Deprecated:** Checks if the connected Bee node version is supported by bee-py. Use `BeeDebug.isSupportedExactVersion()` instead for more accurate version checking.