Skip to content

docs: add Testing and uv workflow sections#160

Merged
petertzy merged 1 commit into
petertzy:mainfrom
korbonits:docs/testing-and-uv-workflow
Apr 14, 2026
Merged

docs: add Testing and uv workflow sections#160
petertzy merged 1 commit into
petertzy:mainfrom
korbonits:docs/testing-and-uv-workflow

Conversation

@korbonits

Copy link
Copy Markdown
Contributor

Summary

  • Add Running Tests section: how to run the suite, a per-file coverage table, CI integration note, and a macOS callout for the WeasyPrint system-library prerequisite (libgobject-2.0-0 / brew install cairo pango gdk-pixbuf libffi)
  • Add Development Workflow: uv vs. pip / requirements.txt section: explains the migration from requirements.txt, the benefits of pyproject.toml + uv.lock (dependency groups, deterministic lockfile, speed, single config file), and when/how to regenerate uv.lock

Both sections are added to README.MD and docs/index.md.

Test plan

  • Verify the new sections render correctly in the MkDocs documentation site
  • Confirm the macOS WeasyPrint note links correctly to PrepareForMacUser.md
  • Run uv run python -m unittest discover -s tests on a Linux/CI environment to confirm all 15 tests pass

🤖 Generated with Claude Code

- Add "Running Tests" section covering how to run the test suite,
  a per-file coverage table, CI integration note, and a macOS
  callout for the WeasyPrint system-library prerequisite
- Add "Development Workflow: uv vs. pip / requirements.txt" section
  explaining the migration from requirements.txt, the benefits of
  pyproject.toml + uv.lock (dependency groups, deterministic lockfile,
  speed), and when to regenerate uv.lock

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@korbonits korbonits requested a review from petertzy as a code owner April 14, 2026 04:04
@petertzy petertzy merged commit b91d909 into petertzy:main Apr 14, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants