Welcome to pycompile’s docs!#

Contents#

CLI#

  1. compile

  2. benchmark

  3. dry run

compile#

pycompile -i your_python_files --clean-source --engine nuitka

By default, the Cython is being used as the default compiler.

For compiling the examples use the following command:

pycompile -i input_path --engine cython

which by default, deletes any temp build files and keeps the source files.

pycompile -i input_path --engine nuitka

After the compilation the input dir will have the following structure.

examples
    ├── fib.py.py
    ├── fib.cpython-310-darwin.so
    ├── test_fib.py

Benchmark#

For running a benchmark on the input-path use the following command:

pycompile benchmark -i src/examples -vvv

Dry run#

pycompile dry_run -i ./src