gistillery / README.md
Benjamin Bossan
Use transformers agents where applicable
01ae0bb

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

Preparing environemnt

Set an environemnt variable called "HF_HUB_TOKEN" with your Hugging Face token or create a .env file with that env var.

In one terminal, start the background worker:

python src/gistillery/worker.py

In another terminal, start the web server:

uvicorn src.gistillery.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/