nRF24 / RF24

OSI Layer 2 driver for nRF24L01 on Arduino & Raspberry Pi/Linux Devices
https://nrf24.github.io/RF24
GNU General Public License v2.0
2.21k stars 1.02k forks source link

[Question] What's with the duplicate py wrappers for network/mesh libs? #779

Closed 2bndy5 closed 2 years ago

2bndy5 commented 3 years ago

I've been trying to keep the python wrappers' copies of RF24Network and RF24Mesh located in this repo up-to-date with their respective source repos. However, the improved setup.py files for Network & Mesh now use the version number from their respective library.properties files while the copies on this repo default to using "1.0" for their version.

I'm wondering if it is ok to remove the copies on this repo since

  1. it would be easier to maintain 1 copy on the repo containing the actual C++ source code
  2. the auto-install script on https://github.com/TMRh20/tmrh20.github.io/blob/master/RF24Installer/RPi/install.sh doesn't install the python wrappers (so no harm would be done)
  3. version numbers will be more accurate (with patch numbers) in pip list output when the py wrappers are installed from the cloned repo that contains the C++ source code
    (env) pi@rpi4:~/github/RF24Network/RPi/pyRF24Network $ pip list
    Package       Version
    ------------- -------
    pip           21.1.3
    pkg-resources 0.0.0
    RF24          1.4.2
    RF24Mesh      1.1.6
    RF24Network   1.0.16
    setuptools    57.4.0
    wheel         0.36.2

ps - A copy of the LICENSE file will be included in the py wrappers' package metadata upon next release. Additionally, there is a hidden warning in the packages' long_description that warns about how the wrappers aren't meant to be uploaded to pypi; this warning would only be seen on pipy.org when a package is uploaded to pypi by someone that doesn't know what they're actually doing.

TMRh20 commented 3 years ago

I think it should be ok to remove them as long as associated documentation is up to date with that.

2bndy5 commented 2 years ago

The python wrapper docs only existed in RF24 repo, and they seemed a little more implicit than they should've been. So, I made them a bit more explicit concerning the separate python wrappers from different RF24* source repos.

Now I'm ready to remove the duplicates from this RF24 repo...