Welcome to the exciting new Python-flavored future of Magnum! Have fun, but please note this functionality is heavily experimental at the moment. Most APIs are missing, documentation is very sparse and everything is still evolving. Use at your own risk. Search and name cross-linking is not working yet, sorry about that.
Downloading and building
Installation guide for the Python bindings.
Building of Python bindings is a similar process to building Magnum itself with an additional step involving Python setuptools. Minimal set of tools and libraries required for building is:
- C++ compiler with good C++11 support. Compilers which are tested to have everything needed are GCC >= 4.8.1, Clang >= 3.3 and MSVC >= 2015. On Windows you can also use MinGW-w64.
- CMake >= 3.1
- Corrade and Magnum installed as described in their docs
- Python >= 3.5 and pybind11
package/archlinux there is a development package, similar to the ones
in Magnum itself. They allow you to build and install the package directly from
the source tree.
git clone git://github.com/mosra/magnum-bindings && cd magnum-bindings cd package/archlinux makepkg -fp PKGBUILD
The PKGBUILD also contains a
check() function which will run all unit
tests before packaging. That might sometimes fail or take too long, pass
makepkg to skip that.
Once built, install the package using
sudo pacman -U magnum-bindings-*.pkg.tar.xz
The source is available on GitHub at https://github.com/mosra/magnum-bindings. Clone the repository with your favorite IDE or Git GUI, download currrent snapshot as a compressed archive or use the command line:
git clone git://github.com/mosra/magnum-bindings.git
Assuming a Unix-based OS, the first step is to build the native libraries. The
bindings will be generated for all Corrade and Magnum libraries that are found,
ignoring the ones which aren’t. If Corrade, Magnum and pybind11 are not in a
default location known to CMake, add their path to
mkdir build && cd build cmake .. \ -DWITH_PYTHON=ON make
Note that pybind11 compilation is quite time- and memory-hungry, so you might
not want to run the build on all cores on memory-constrained systems. In the
build directory, CMake will create the desired Python package layout, meaning
the bindings can be used directly if you
For installing into a system-wide location, CMake generates a
containing location of all built libraries for use with Python setuptools:
cd build/src/python/magnum python setup.py install # or python3, sudo might be needed
Essential functionality of the bindings is tested using Python’s builtin
unittest module. The tests currently assume a CMake build directory with
all binaries already built located in a
build/ directory in project root,
running them is then a matter of:
cd src/python/magnum python -m unittest
For code coverage, coverage.py is used.
Get it via
pip or as a system package.
pip install coverage # sudo might be needed
Running the unit tests with coverage enabled is then a matter of executing the
following commands, the resulting HTML overview is located in
cd src/python/magnum coverage run -m unittest coverage html
package/ci/ there is a
travis.yml file that compiles and tests the
bindings on Linux GCC 4.8 + CMake 3.1 and on macOS. Online at
https://travis-ci.org/mosra/magnum-bindings, code coverage is reported to