gistillery / README.md
Benjamin Bossan
Apply mypy, black, ruff
c19ef6e

Dump your knowledge, let AI refine it

Installation

Create a Python environment with Python 3.10+. Install the requirements and the package:

python -m pip install -r requirements.txt
python -m pip install .

For development, instead do:

python -m pip install -r requirements.txt
python -m pip install -r requirements-dev.txt
python -m pip install -e .

Starting

In one terminal, start the background worker:

cd src
python worker.py

In another terminal, start the web server:

cd src
uvicorn webservice:app --reload --port 8080

For example requests, check requests.org.

Checks

Running tests

python -m pytest tests/

Other

mypy src/
black src/ && black tests/
ruff src/ && ruff tests/