Skip to main content

RESTful API for Deciphon scheduler

Project description



If you happen to be using a supported Linux environment (which is likely the case), you would need:

  • Python >=3.8
  • Pipx for easy installation and environment isolation. Feel free to use Pip instead though.


Generate a configuration file:

pipx run deciphon-api generate-config > .env

Tweak .env as needed, and then run

pipx run deciphon-api start


Make sure you have Poetry.


poetry install
poetry shell

to setup and activate a Python environment associated with the project. Then enter

uvicorn deciphon_api.main:app.api --reload

to start the API.

Tests can be performed by entering


while the corresponding Python environment created by Poetry is active.


Copy the file .env.example to your working directory and rename it to .env. Edit it accordingly. The rest of the configuration can be tuned by uvicorn options.

Project details

Download files

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

Source Distribution

deciphon_api-0.6.1.tar.gz (19.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page