Skip to main content

Cython setuptools integration

Project description

cython-setuptools

Build Status

Easier distribution and development of Cython modules.

Features:

  • Two distribution models: with C/C++ files included in the package, and without
  • Cython modules are defined in setup.cfg
  • Install directly from Cython sources, without installing Cython in the target environment (Cython is only included in install_requires)

Installation

$ pip install cython-setuptools

Usage

Here is an example Python package using the default distribution model (only Cython files are included in the source package).

First install the cython-setuptools vendor module in the package, next to setup.py.

$ cd your-python-project/
$ cython-setuptools install

Then use cython-setuptools' setup() in your setup.py:

from cysetuptools import setup

setup()

Note that we keep the default cythonize=True argument of setup() here, meaning that C files are compiled from Cython files automatically. setup(cythonize=False) would mean we would need to distribute the C/C++ files compiled from Cython in the source package.

Define your Cython modules in setup.cfg.

[metadata]
name = your-python-project
version = 1.0

[options]
packages = find:
install_requires = cython

[options.extras_require]
dev = cython

[cython-defaults]
include_dirs = include/

[cython-module: foo.bar]
sources = foo.pyx
          bar.cpp
include_dirs = eval(__import__('numpy').get_include())
language = c++
pkg_config_packages = opencv

Then your Cython modules can be compiled and tested in-place with:

$ python setup.py build_ext --inplace

This automatically compile outdated Cython files. If setup(cythonize=False) is used, you have to specifically tell the setup to recompile outdated Cython files:

$ CYTHONIZE=1 python setup.py build_ext --inplace

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for cython-setuptools, version 0.2.3
Filename, size File type Python version Upload date Hashes
Filename, size cython-setuptools-0.2.3.tar.gz (6.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page