Skip to content

Update documentation for new tooling#455

Open
sandhose wants to merge 6 commits intoquenting/modern-tooling/aiohttpfrom
quenting/modern-tooling/docs
Open

Update documentation for new tooling#455
sandhose wants to merge 6 commits intoquenting/modern-tooling/aiohttpfrom
quenting/modern-tooling/docs

Conversation

@sandhose
Copy link
Copy Markdown
Member

@sandhose sandhose commented Apr 2, 2026 •
edited
Loading

Summary

  • Update CONTRIBUTING.md: Poetry/tox/trial → uv/ruff/pytest instructions
  • Update README.md: python -m sygnal.sygnal → uv run sygnal
  • Update docs/applications.md: virtualenv → uv run for VAPID key generation
  • Update Python version references from 3.8 to 3.10 in CONTRIBUTING.md and README.md
  • Replace Buildkite reference with GitHub Actions in CONTRIBUTING.md
  • Clean .gitignore: remove _trial_temp* and .tox entries
  • Use uv run in scripts-dev/lint.sh to match CONTRIBUTING.md instructions
  • Remove stale tox.ini comment in lint.sh

Notes

Test plan

  • Documentation reads correctly and instructions work
  • CI green

Part 4 of 7 in the repository modernisation series. Builds on #454.

@sandhose sandhose mentioned this pull request Apr 2, 2026
Open
4 tasks
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from 7ba52a0 to 8955880 Compare April 2, 2026 12:36
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch 2 times, most recently from 57932bc to b6531ee Compare April 2, 2026 16:53
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch 2 times, most recently from e5cab6f to c89a35e Compare April 2, 2026 17:29
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch 2 times, most recently from 0ecac1d to 9c5740a Compare April 2, 2026 17:39
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch 2 times, most recently from fcf8ce2 to 5403098 Compare April 2, 2026 17:58
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch from 9c5740a to 5d646f7 Compare April 2, 2026 17:58
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from 5403098 to d0cea1d Compare April 2, 2026 22:18
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch from 5d646f7 to 66d915b Compare April 2, 2026 22:18
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from d0cea1d to e0a99f3 Compare April 2, 2026 22:38
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch from 66d915b to dc43142 Compare April 2, 2026 22:38
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from e0a99f3 to 55b4713 Compare April 2, 2026 22:48
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch 2 times, most recently from 14afac6 to 933dc50 Compare April 2, 2026 22:52
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from 55b4713 to 8592607 Compare April 2, 2026 22:52
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch from 933dc50 to d423d69 Compare April 2, 2026 23:02
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from 4297e82 to d7e0207 Compare April 2, 2026 23:05
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch from d423d69 to c8c4724 Compare April 2, 2026 23:05
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from d7e0207 to 5a1ae0f Compare April 3, 2026 10:21
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch from c8c4724 to 475876b Compare April 3, 2026 10:21
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from 5a1ae0f to da1e07e Compare April 3, 2026 10:22
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch 2 times, most recently from 2d01ba7 to a46865b Compare April 3, 2026 11:38
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from da1e07e to 1f402da Compare April 3, 2026 11:38
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch from a46865b to 343056e Compare April 3, 2026 11:42
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from 1f402da to f5c3e91 Compare April 3, 2026 12:06
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch from 343056e to d0b7d3f Compare April 3, 2026 12:06
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from f5c3e91 to 2d16192 Compare April 3, 2026 12:11
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch from d0b7d3f to 0bf98da Compare April 3, 2026 12:11
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from 2d16192 to 2f2a872 Compare April 3, 2026 13:24
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch from 0bf98da to 5dbec70 Compare April 3, 2026 13:24
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from 2f2a872 to be6956e Compare April 3, 2026 13:28
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch 2 times, most recently from 6cf0d3a to a0f315d Compare April 3, 2026 13:33
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from be6956e to e6b6eb8 Compare April 3, 2026 13:33
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch from a0f315d to fbd5b3a Compare April 3, 2026 13:40
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from e6b6eb8 to a01ee4d Compare April 3, 2026 13:40
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch from fbd5b3a to 8f85065 Compare April 3, 2026 13:49
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch 2 times, most recently from 44fd78f to 571943d Compare April 3, 2026 14:00
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch 2 times, most recently from 30260f7 to 8b0e3d4 Compare April 3, 2026 14:10
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from 571943d to 38323bd Compare April 3, 2026 14:10
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch from 8b0e3d4 to b2c71c6 Compare April 3, 2026 14:15
sandhose and others added 6 commits April 3, 2026 16:30
@sandhose
Update CONTRIBUTING.md for uv, ruff, and pytest
1cfe41a 
Replace all references to poetry, tox, and trial with their
uv/ruff/pytest equivalents.
@sandhose
Update documentation for uv
7b922bc 
Update running instructions in README.md to use `uv run sygnal`
instead of `python -m sygnal.sygnal`. Update WebPush VAPID key
generation command in docs/applications.md.
@sandhose
Update CONTRIBUTING.md and clean .gitignore
cd36b04 
Replace Buildkite reference with GitHub Actions. Remove stale
_trial_temp* and .tox entries from .gitignore.
@sandhose
Newsfile for documentation updates.
4281252
@sandhose
Use uv run in lint.sh to match CONTRIBUTING.md instructions
59ba420
@sandhose @claude
Fix stale tox.ini comment and update Python version in docs to 3.10
d00ad3b 
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@sandhose sandhose force-pushed the quenting/modern-tooling/docs branch from b2c71c6 to d00ad3b Compare April 3, 2026 14:30
@sandhose sandhose force-pushed the quenting/modern-tooling/aiohttp branch from fb6c10c to 475082f Compare April 3, 2026 14:30
@sandhose sandhose marked this pull request as ready for review April 3, 2026 14:47
@sandhose sandhose requested a review from a team as a code owner April 3, 2026 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@sandhose