Skip to content

Refresh README facts #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MaciejZiel merged 3 commits into from
Oct 13, 2026
Merged

Refresh README facts #9

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3bf030c
Reword the mobile screenshot alt text
MaciejZiel Oct 13, 2026
9765cfe
Update the test count and run time in the development section
MaciejZiel Oct 13, 2026
675fd4e
State that pgqueue is installed from Git, not PyPI
MaciejZiel Oct 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,9 @@ $ export PGQUEUE_DSN=postgresql://user:pass@localhost/app
$ pgqueue migrate
```

pgqueue is not published on PyPI: the `pgqueue` name there belongs to an unrelated
project, so install from this repository as shown above.

Define tasks in a module, e.g. `app/jobs.py`:

```python
Expand Down Expand Up @@ -197,7 +200,7 @@ Updates arrive over server-sent events (`/api/stream`) with a polling fallback
load does not depend on how many people are watching (100 concurrent streams cost the demo
process about 90 MB and under 3 % CPU on a laptop).

<img src="docs/dashboard-mobile.png" alt="The dashboard on a phone" width="260">
<img src="docs/dashboard-mobile.png" alt="The dashboard on a narrow mobile screen" width="260">

The workload ([`demo/`](demo), separate from the library) is deliberately lively:

Expand Down Expand Up @@ -515,7 +518,7 @@ typed payloads and the failure semantics above are explicit and covered by tests
```console
$ docker compose up -d postgres # Postgres 17 on localhost:55432
$ uv sync --all-extras
$ uv run pytest # 160+ tests against the real database, ~45 s
$ uv run pytest # 173 tests against the real database, ~80 s
$ uv run ruff check . && uv run ruff format --check . && uv run mypy
```

Expand Down
Loading