Skip to content

SolardiaX/CyInstaller

Repository files navigation

CyInstaller

CyInstaller is a lightweight CLI tools to compile and package your application to a single executable file with related distribution files.

CyInstaller use Cython to compile application's source codes, then package files with PyInstaller.

Installing

Install and update using pip:

pip install -U CyInstaller

Quickstart

Add a setup.yml in your project, then execute the CyInstaller cli command:

CyInstaller --file setup.yml

CyInstaller default use setup.yml as the config file. If use another file, just execute the CyInstaller command with it as a parameter.

CyInstaller --file 'path/to/the/file'

Configuration

A yaml configuration may looks like:

setup:
  app: CyInstallerApp
  root: .
  modules:
    - base: Common
      package: common
      package_from_base: false
      compiles:
        - ...
      packages:
        - ...
      binaries:
        - ...
      datas:
        - ...
      relates:
    - base: Backend
      ...
  compiles:
      - ...
  packages:
      - ...
  datas:
    - ...
  relates:
    - ...
  cython_binaries: true/false
  hiddenimports:
    - ...
  auto_hiddenimports: true/false
  entrypoint: app.py

  stage:
    path: _build
    debug: true/false
    cython:
      path: cython
      path_tmp: compile
      options:
        ...
    pyinstaller:
      path: package
      template: setup.spec

  dist: target

Detail for each options see the configuration guidelines.

Links

About

Package application with Cython & PyInstaller

Resources

License

Stars

Watchers

Forks

Packages

No packages published