- Python >= 3.12
- PostgreSQL. Docker Compose runs one for you. On Heroku, the Deploy button adds the paid Heroku Postgres add-on, which sets
DATABASE_URL.
$ git clone https://github.com/TheHamkerCat/SpamProtectionRobot
$ cd SpamProtectionRobot
$ cp .env.example .env
Edit .env with your own values:
$ docker compose up -d --build
Needs uv.
$ uv sync
$ uv run python -m spr
After changing dependencies in pyproject.toml, update uv.lock (in Docker):
$ docker run --rm -v "$PWD:/app" -w /app python:3.12.16-slim-trixie sh -c "pip install -q uv==0.13.7 && uv lock"
Heroku has no .env file: fill in the same names as Config Vars.
The Deploy button also adds the Heroku Postgres add-on (a paid plan), which sets DATABASE_URL. If you create the app without the button, add the database yourself:
$ heroku addons:create heroku-postgresql:essential-0
The bot applies database migrations (Alembic) by itself at startup. After changing spr/models.py, create a migration and commit the new file from spr/migrations/versions:
$ docker compose -f compose.test.yml run --rm --build alembic revision --autogenerate -m "what changed"
This runs in Docker against a throwaway database, never the real one. Any other alembic command works the same way, e.g. ... run --rm alembic check.
To see which migration the real database is on:
$ docker compose run --rm bot alembic current
$ docker compose -f compose.test.yml run --rm --build tests
$ docker compose -f compose.test.yml --env-file .env run --rm --build live
$ docker compose -f compose.test.yml run --rm --build benchmark
$ docker compose -f compose.test.yml down
- NOT RELATED TO INTELLIVOID IN ANY WAY.
- Start image: Andrey Matveev on Unsplash.
