Skip to content

Document local test setup and pytest commands - #435

Merged
hugovk merged 3 commits into
python-humanize:mainfrom
yuefdev:docs-local-tests
Oct 25, 2026
Merged

hugovk merged 3 commits into
python-humanize:mainfrom
yuefdev:docs-local-tests

Conversation

@yuefdev

@yuefdev yuefdev commented Oct 3, 2026 •

Copy link
Copy Markdown
Contributor

Fixes #430.

Add local test instructions using tox to create the environment and install test dependencies. Show how to pass pytest arguments for a test file, a name filter and skip reasons. Link to the existing CI configuration for supported Python versions rather than duplicating the version list.

Validation on Windows, Python 3.13.15:

  • uvx --with tox-uv --python 3.13 tox -r -e py -- tests/test_number.py -k intcomma: 36 passed, 205 deselected. Used tox-uv after the local virtualenv/pip bootstrap failed with No module named pip.__main__.
  • uvx prek run --files .github/CONTRIBUTING.md: passed.
  • git diff --check: passed.

AI-assisted review follow-up using OpenCode and gpt-6-astra. Only the contributor guide changes.

@hugovk

hugovk commented Oct 3, 2026

Copy link
Copy Markdown
Member

It's better to use tox locally, it handles the venv stuff. Don't repeat supported Python versions.

Co-Authored-By: gpt-6-astra <noreply@openai.com>
Signed-off-by: Yusuf Efe <120668197+yuefdev@users.noreply.github.com>
@yuefdev

yuefdev commented Oct 18, 2026

Copy link
Copy Markdown
Contributor Author

Updated the guide to use tox -e py and pass pytest arguments after --. Removed the repeated Python version requirement and linked to the CI matrix. Verified the focused tox invocation with tox-uv (36 tests passed); the contributor-guide pre-commit checks pass.

@hugovk hugovk added documentation Improvements or additions to documentation changelog: skip Exclude PR from release draft labels Oct 25, 2026
@hugovk
hugovk enabled auto-merge (squash) October 25, 2026 13:15
@codecov

codecov Bot commented Oct 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.69%. Comparing base (1a04966) to head (f2f139c).
⚠️ Report is 10 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #435      +/-   ##
==========================================
- Coverage   99.69%   99.69%   -0.01%     
==========================================
  Files          12       12              
  Lines         996      995       -1     
==========================================
- Hits          993      992       -1     
  Misses          3        3              
Flag Coverage Δ
macos-latest 97.58% <ø> (-0.01%) ⬇️
ubuntu-latest 97.58% <ø> (-0.01%) ⬇️
windows-latest 93.26% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@hugovk
hugovk merged commit c7045b1 into python-humanize:main Oct 25, 2026
43 of 44 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog: skip Exclude PR from release draft documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: document how to run the test suite locally

2 participants