/cythonbuilder

Automatically builds and packages your Cython code

Primary LanguageHTMLMIT LicenseMIT

CythonBuilder

CythonBuilder; automated compiling and packaging of Cython code

Version version
Package PythonVersion Platform License implementation
Status status DependencyStatus
Stats DownloadsCount
Social tweet twitterfollow

Installation

pip install cythonbuilder

How to use

CythonBuilder makes it easy to use Cython in your Python project by automating the compilation, building and packaging process. You can use CythonBuilder from the commandline or import it as a package in Python.

Commandline Demonstration:

  1. Initialize
    In your project directory, call cybuilder init. This creates the /ext folder.

  2. Organize
    Place all of your Cython files in /ext/pyxfiles

  3. Compile and package
    Simply call cybuilder build to build all Cythonfiles in /ext/pyxfiles. Alternatively call cybuilder build filename to package specific files (no .pyx needed)

  4. Import All packages en up in /ext so you can simply from ext import yourfilename.

Python demonstration

import cythonbuilder as cybuilder

cybuilder.init()
cybuilder.just_build(targetfilenames=["my_cy_package"])

from ext import my_cy_package

my_cy_package.some_function()

In-depth, step by step Explanation

I've written a few articles that explain why Python is slow, why we need Cython and how CythonBuilder helps us develop fast code easily: