Skip to main content

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.

Metadata

Release files for deciphon-api 0.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for deciphon-api 0.6.1
File Size Uploaded Provenance Actions
deciphon_api-0.6.1.tar.gz 19.9 kB Without provenance Details for deciphon_api-0.6.1.tar.gz

Release files / deciphon_api-0.6.1.tar.gz

Download URL deciphon_api-0.6.1.tar.gz
Size 19.9 kB
Tags Source
SHA-256 checksum
How to use checksums
c6b0698c0d2bbc24fb8efd192fa50cf3572ad05af9f47aacf30270b5630d31d2
BLAKE2b-256 checksum
How to use checksums
8f03430a15ef277d12c5ae71fc3e98495777fe296f96cf017ef52753c4de34eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.15

Security for deciphon-api 0.6.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page