Files
Evection/README.md
T
ksmithandClaude Sonnet 5.5 73dbee9400 Document running the test suite against PostgreSQL
The Postgres search backend's tests are skipped on SQLite, so they only
run when pointed at a real Postgres. Documents the throwaway-container
recipe used to verify the stored/GIN-indexed search vector migration.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-01 09:23:02 -07:00

73 lines
2.4 KiB
Markdown

# Evection
A self-hosted RSS/Atom feed reader, in the spirit of FreshRSS, built in Python
(Django) instead of PHP. Installable as a PWA on your phone, with offline
reading for anything you've already loaded.
## Features
- Multi-user, with per-user folders, read/starred/saved-for-later state, and tags
- Background feed polling via Celery, with conditional GET and backoff on errors
- Full-text search over your articles (SQLite FTS5 or PostgreSQL, your choice)
- A filter/rules engine to auto-tag, star, hide, or mark feeds' articles read
- OPML import/export
- Installable as a PWA (Add to Home Screen) with an offline fallback page
- An admin dashboard surfacing feeds that are failing to fetch
## Deploying your own instance
See [docs/install.md](docs/install.md) for a production install: pip + gunicorn
+ systemd + nginx, with both SQLite and PostgreSQL covered.
## Development setup
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
cp .env.example .env
python manage.py migrate
python manage.py runserver
```
Visit `http://localhost:8000/` — you'll land on the first-run setup wizard to
create the instance's admin account.
### Updating pinned dependencies
`requirements.txt`/`requirements-dev.txt` are hash-pinned lock files generated
from `pyproject.toml` — production installs (`scripts/install.sh`,
`scripts/upgrade.sh`) install from `requirements.txt` with `--require-hashes`
rather than re-resolving version ranges at install time. After changing a
dependency in `pyproject.toml`, regenerate both and commit them alongside:
```bash
pip-compile --generate-hashes --allow-unsafe --output-file=requirements.txt pyproject.toml
pip-compile --generate-hashes --allow-unsafe --extra=dev --output-file=requirements-dev.txt pyproject.toml
```
## Tests
```bash
pytest
ruff check .
black --check .
```
### Testing against PostgreSQL
The suite runs on SQLite by default; the Postgres-only tests (search backend)
are skipped there. To run everything against a real Postgres:
```bash
docker run -d --name evection-pg-test -e POSTGRES_PASSWORD=testpw -e POSTGRES_DB=evection \
-p 127.0.0.1:55432:5432 postgres:16
DATABASE_URL=postgres://postgres:testpw@127.0.0.1:55432/evection pytest
docker rm -f evection-pg-test
```
## License
[GNU AGPL-3.0-or-later](LICENSE) — if you run a modified version of Evection as
a network service, you must make your modified source available to its users.