Skip to content

Files

Latest commit

6ece212 · Mar 1, 2025

History

History
40 lines (25 loc) · 1002 Bytes

Hacking.md

File metadata and controls

40 lines (25 loc) · 1002 Bytes

How to work on fluenpty

Execute the unit tests

uv run pytest fluent_test.py

or use tox to test all supported python versions

nix-shell
uv tool install tox --with tox-uv
tox

Generate the documentation

cd docs; make clean html

or

sphinx-autobuild doc doc/_build/html

to work on it while it live updates

Send patches

Pull requests with unit tests please. Bonus points if you add release notes.

Please note that this project practices Semantic Versioning and Dependable API Evolution

Release checklist

  • Tests run at least in all supported versions of python. Use tox
  • Increment version
  • Update Changelog
  • build with $ ./setup.py sdist bdist_wheel
  • upload to testpypi as required $ twine upload --repository testpypi dist/fluentpy-*
  • Test install and check the new version from pypi
  • Tag release
  • Push git tags
  • upload to pypi as required $ twine upload dist/fluentpy-*