boost::python examples
These are a few examples on how to use the boost::python library to extend Python with C++ libraries. Some of the are based on the existing tutorial for boost::python from Joel de Guzman. Others are independent.
Prerequisites
general
- CMake (>= 2.8.3)
- Boost (tested with 1.67, but should work with >= 1.3.2)
- Python (tested with 2.7 and 3.6, but should work with >= 2.2)
- a C++ compiler for your platform, e.g. GCC or MinGW
The examples should work on Linux, Windows and OSX, but currently have not been tested much under Windows.
Mac OS X with homebrew
There is a special package needed called boost-python. The standard boost package will not be recognized by cmake.
brew install cmake boost-python
Furthermore, for the homebrew python lib to be used, its path must be provided to cmake. This is handled in the build.sh script, but for reference, or if any issues arise, that can be done manually as follows (substitute the path as appropriate for your Python version):
cmake -DPYTHON_LIBRARY=/usr/local/Cellar/python/2.7.9/Frameworks/Python.framework/Versions/2.7/lib/libpython2.7.dylib ..
Building
- Set the
BOOST_ROOTenvironment variable if Boost is installed in a non-standard directory - create a build directory, e.g. directly in the project directory and cd to it:
mkdir build ; cd build - run
cmake ..and afterwardsmake
Alternatively, run the provided build.sh script.
Tests
All examples contain tests, but these only try to run the examples without checking the output. Their purpose is mainly to make sure that compilation works and produces valid Python modules.
Python 3
The code works with Python 3 both on Linux and on OS X. However, there are several caveats.
Linux
- Build Boost::Python against Python 3 (needs at least version 1.56.0)
- make sure
pythonresolves to python3 (e.g., by using a python3 VE) - run
./build.sh
OS X (again with homebrew)
Some effort has been made to make Python 3 compilation automatic, by making modifications to build.sh and CMakeLists.txt that account for quirks on the Apple platform regarding cmake, paths, and naming conventions for python/python3. Having said that, if you use build.sh, then you will still need to do the following:
- Build Boost::Python against Python 3 (needs at least version 1.56.0) or
brew install boost-python3 - make sure
pythonresolves to python3 (e.g., by using virtualenv) - check that
cmakeuses matching python interpreter and libraries (down to the last digit). Otherwise you run into #17.
If you are building without build.sh, then you will additionally need to:
- run
cmake -DBOOST_LIBRARYDIR=xxx -DPYTHON_LIBRARY=xxx -DPYTHON_INCLUDE_DIR=xxx ..
Contributing
Contributions are very welcome. The following will provide some helpful guidelines.
How to contribute
If you want to submit a contribution, please follow the following workflow:
- Fork the project
- Create a feature branch
- Add your contribution
- When you're completely done, build the project and run all tests
- Create a Pull Request
Commits
Commit messages should be clear and fully elaborate the context and the reason of a change. If your commit refers to an issue, please post-fix it with the issue number, e.g.
Issue: #123
Furthermore, commits should be signed (git commit -s) according to the DCO.
Pull Requests
If your Pull Request resolves an issue, please add a respective line to the end, like
Resolves #123
