Skip to content

Commit 0ffb7ae

Browse files
committed
project renamed reverted back to bee-py
1 parent 2e3a1f7 commit 0ffb7ae

File tree

6 files changed

+31
-31
lines changed

6 files changed

+31
-31
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,9 @@ This will allow a chance to talk it over with the owners and validate your appro
9797
<!-- github-only -->
9898

9999
[code of conduct]: CODE_OF_CONDUCT.md
100-
[documentation]: https://beePy.readthedocs.io/
100+
[documentation]: https://bee-py.readthedocs.io/
101101
[gpl 3.0 license]: https://opensource.org/licenses/GPL-3.0
102-
[issue tracker]: https://github.com/alienrobotninja/beePy/issues
103-
[pull request]: https://github.com/alienrobotninja/beePy/pulls
102+
[issue tracker]: https://github.com/alienrobotninja/bee-py/issues
103+
[pull request]: https://github.com/alienrobotninja/bee-py/pulls
104104
[pytest]: https://pytest.readthedocs.io/
105-
[source code]: https://github.com/alienrobotninja/beePy
105+
[source code]: https://github.com/alienrobotninja/bee-py

README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22

33
<div align="center">
44

5-
| Feature | Value |
6-
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
7-
| 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) |
8-
| 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/) |
9-
| 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/) |
10-
| 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) |
11-
| Docs | [![Read the Docs](https://img.shields.io/readthedocs/beePy/latest.svg?label=Read%20the%20Docs)](https://beePy.readthedocs.io/) |
12-
| 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/) |
13-
| 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) |
5+
| Feature | Value |
6+
| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7+
| 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) |
8+
| 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/) |
9+
| 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/) |
10+
| 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) |
11+
| Docs | [![Read the Docs](https://img.shields.io/readthedocs/bee-py/latest.svg?label=Read%20the%20Docs)](https://bee-py.readthedocs.io/) |
12+
| 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/) |
13+
| 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) |
1414

1515
</div>
1616

1717
## 📖 Table of Contents
1818

19-
- [🐝 Bee Py](#-beePy)
19+
- [🐝 Bee Py](#-bee-py)
2020
- [📖 Table of Contents](#-table-of-contents)
2121
- [🌐 Overview](#-overview)
2222
- [✨ Features](#-features)
@@ -53,10 +53,10 @@ This is the library for connecting to Bee decentralised storage using python.
5353

5454
## 🛠️ Installation
5555

56-
You can install `beePy` via \[pip\] from \[PyPI\]:
56+
You can install `bee-py` via \[pip\] from \[PyPI\]:
5757

5858
```sh
59-
pip install beePy
59+
pip install bee-py
6060
```
6161

6262
## 🚀 Usage
@@ -134,8 +134,8 @@ print(batch_id)
134134
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
135135

136136
```sh
137-
git clone https://github.com/alienrobotninja/beePy
138-
cd beePy
137+
git clone https://github.com/alienrobotninja/bee-py
138+
cd bee-py
139139
# To install all the dev & lint dependencies
140140
pdm install -G:all
141141
```
@@ -157,7 +157,7 @@ _Bee Py_ is free and open source software.
157157
There are some know issues like:
158158

159159
- Some tests are perfomed on older versions of bee.
160-
- Some tests are stuck for hours when using the latest Bee API(not `beePy` issue).
160+
- Some tests are stuck for hours when using the latest Bee API(not `bee-py` issue).
161161
- Some tests are skipped because of outdated libraries used by various `ethersphere` projects.
162162

163163
If you encounter any problems,
@@ -173,5 +173,5 @@ Developed by [@Aviksaikat](https://github.com/aviksaikat)
173173

174174
<!-- github-only -->
175175

176-
[contributor guide]: https://github.com/alienrobotninja/beePy/blob/main/CONTRIBUTING.md
177-
[license]: https://github.com/alienrobotninja/beePy/blob/main/LICENSE
176+
[contributor guide]: https://github.com/alienrobotninja/bee-py/blob/main/CONTRIBUTING.md
177+
[license]: https://github.com/alienrobotninja/bee-py/blob/main/LICENSE

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ reference
1515
contributing
1616
Code of Conduct <codeofconduct>
1717
License <license>
18-
Changelog <https://github.com/aviksaikat/beePy/releases>
18+
Changelog <https://github.com/aviksaikat/bee-py/releases>
1919
```

docs/usage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
```{eval-rst}
44
.. click:: bee_py.__main__:main
5-
:prog: beePy
5+
:prog: bee-py
66
:nested: full
77
```

pyproject.toml

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Project specifications
22
[project]
3-
name = "beePy"
3+
name = "bee-py"
44
version = "0.1.0"
55
description = "Python client library for connecting to Bee decentralised storage"
66
authors = [
@@ -31,10 +31,10 @@ classifiers = [
3131
]
3232

3333
[project.urls]
34-
homepage = "https://github.com/alienrobotninja/beePy"
35-
repository = "https://github.com/alienrobotninja/beePy"
36-
Issues = "https://github.com/alienrobotninja/beePy/issues"
37-
Changelog = "https://github.com/alienrobotninja/beePy/releases"
34+
homepage = "https://github.com/alienrobotninja/bee-py"
35+
repository = "https://github.com/alienrobotninja/bee-py"
36+
Issues = "https://github.com/alienrobotninja/bee-py/issues"
37+
Changelog = "https://github.com/alienrobotninja/bee-py/releases"
3838

3939
# build system to use
4040
[build-system]
@@ -178,8 +178,8 @@ parallel = true
178178
omit = ["src/bee_py/__about__.py"]
179179

180180
[tool.coverage.paths]
181-
bee_py = ["src/bee_py", "*/beePy/src/bee_py"]
182-
tests = ["tests", "*/beePy/tests"]
181+
bee_py = ["src/bee_py", "*/bee-py/src/bee_py"]
182+
tests = ["tests", "*/bee-py/tests"]
183183

184184
[tool.coverage.report]
185185
exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"]

src/bee_py/bee_debug.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -637,7 +637,7 @@ def get_node_info(self, options: Optional[Union[BeeRequestOptions, dict]] = None
637637
return status.get_node_info(self.__get_request_options_for_call(options)) # type: ignore
638638

639639
def is_supported_exact_version(self, options: Optional[Union[BeeRequestOptions, dict]] = None) -> bool:
640-
"""**Deprecated:** Checks if the connected Bee node version is supported by beePy.
640+
"""**Deprecated:** Checks if the connected Bee node version is supported by bee-py.
641641
642642
Use `BeeDebug.isSupportedExactVersion()` instead for more accurate version checking.
643643

0 commit comments

Comments
 (0)