-
Notifications
You must be signed in to change notification settings - Fork 152
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ref nRF24/RF24#1000
- Loading branch information
Showing
3 changed files
with
44 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Individual python wrapper | ||
|
||
> [!warning] | ||
> This python wrapper for the RF24Mesh C++ library was not intended | ||
> for distribution on pypi.org. Any such attempts to publish this package | ||
> is unauthorized and unofficial. | ||
## Use pyRF24 instead | ||
|
||
We recommend using the newer [pyRF24](https://github.com/nRF24/pyRF24) package | ||
[available from pypi](https://pypi.org/project/pyrf24/) because | ||
|
||
1. it is [practically drop-in compatible](https://nrf24.github.io/pyRF24/#migrating-to-pyrf24) | ||
2. easier to install or get updates with popular package managers like pip | ||
3. does not require the C++ libraries to be installed -- it uses its own isolated binaries | ||
4. includes wrappers for RF24, RF24Network, RF24Mesh libraries | ||
5. includes a new [fake BLE implementation](https://nrf24.github.io/pyRF24/ble_api.html) | ||
6. has its own [dedicated documentation](https://nRF24.github.io/pyRF24) | ||
7. is compatible with python's builtin `help()` | ||
8. includes typing stub files for type checking tools like mypy | ||
|
||
The only reason that you should need to keep using these older individual python | ||
wrappers is if you must use python v3.6 or older. | ||
|
||
You **cannot** use these individual wrappers in combination with the pyRF24 package. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
[build-system] | ||
requires = ["setuptools>=61"] | ||
build-backend = "setuptools.build_meta" | ||
|
||
[project] | ||
name = "RF24Mesh" | ||
classifiers = [ | ||
"Programming Language :: Python :: 2", | ||
"Programming Language :: Python :: 3", | ||
"Programming Language :: C++", | ||
"License :: OSI Approved :: GNU General Public License v2 (GPLv2)", | ||
] | ||
license = {text = "GNU General Public License v2 (GPLv2)"} | ||
readme = {file = "README.md", content-type = "text/markdown"} | ||
dynamic = ["version"] # version is set in setup.py |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters