README.md

# Dump your knowledge, let AI refine it

## Installation

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

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

For development, instead do:

``` sh
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:

```sh
cd src
python worker.py
```

In another terminal, start the web server:

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

For example requests, check `requests.org`.

## Checks

### Running tests

```sh
python -m pytest tests/
```

### Other

```sh
mypy src/
black src/ && black tests/
ruff src/ && ruff tests/
```