deciphon-api

deciphon-api

Dependencies

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.

Usage

Generate a configuration file:

pipx run deciphon-api generate-config > .env

Tweak .env as needed, and then run

pipx run deciphon-api start

Development

Make sure you have Poetry.

Enter

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

pytest

while the corresponding Python environment created by Poetry is active.

Settings

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.