Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

boost.python is not required to build pyrf24 from source #8

Closed
2bndy5 opened this issue Jun 17, 2024 · 1 comment
Closed

boost.python is not required to build pyrf24 from source #8

2bndy5 opened this issue Jun 17, 2024 · 1 comment

Comments

@2bndy5
Copy link

2bndy5 commented Jun 17, 2024

I just noticed some inaccurate (or outdated) advice in the README:

## Dependencies
- `pyrf24` [RF24 python library](https://nrf24.github.io/RF24)
- `crc` [CRC python library](https://github.com/Nicoretti/crc)
Notice that `pyrf24` may need to build some dynamic libraries. So, you will need some additional
packages:
- Debian based OS (e.g. Raspberry Pi OS)
```sh
sudo apt-get install python3-dev libboost-python-dev
python -m pip install pyrf24
```

The README should be updated like so:

 ## Dependencies 
 
-- `pyrf24` [RF24 python library](https://nrf24.github.io/RF24)
+- `pyrf24` [pyRF24 python library](https://nrf24.github.io/pyRF24)
 - `crc` [CRC python library](https://github.com/Nicoretti/crc) 
  
-Notice that `pyrf24` may need to build some dynamic libraries. So, you will need some additional 
-packages:
+Notice that `pyrf24` may need to build from source on some systems.
+In such case, you will need cmake and python headers (python3-dev) installed.
  
 - Debian based OS (e.g. Raspberry Pi OS) 
 ```sh 
-  sudo apt-get install python3-dev libboost-python-dev 
+  sudo apt-get install python3-dev cmake
   python -m pip install pyrf24 
-
 ```

If installing on a 64-bit Linux, then building from source is only necessary if using PyPy or when using musl instead of GNU C. Installing on a 32-bit system will likely need to build from source, especially if not using the RPi OS 32-bit. The piwheels project does provide 32-bit builds, but they explicitly only support RPi OS 32-bit.

Some history

The boost.python library was only used in the older individual python wrappers (still) provided with each RF24* repository. The pyrf24 project changed that by replacing boost.python with pybind11. Users do not need to install pybind11 as it is included in the pyrf24 source distribution.

All binaries built for the pyrf24 package are isolated to the python env used, so the RF24 C++ libs and boost.python are not required to be installed separately. Those are only prerequisites for the older individual python wrappers.

lamperez added a commit that referenced this issue Jul 27, 2024
Thanks to @2bndy5, see <#8 (comment)> for details.
@lamperez
Copy link
Owner

lamperez commented Jul 27, 2024

Thank you, I have updated the README.

@2bndy5 2bndy5 closed this as completed Jul 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants