MAINTENANCE.md

Maintaining

Build

Build time dependencies

python -m pip install --upgrade build twine

To build

python -m build

To locally install

python -m pip install -e ".[dev,typ]" --config-settings editable_mode=compat

Running the tests

Please make sure that the package is installed with .[dev], then run

pytest tests/

Run the test for various python's versions, run

tox

With test coverage in py313 environment

pytest --cov=cs3560cli tests/

If you want to view the HTML report instead, run

coverage html

then open the HTML file in your browser.

Publishing

For the detail about version specifier, please see version specifier

Publish to the test PyPI

python -m twine upload -r testpypi dist/*

Publish to the real PyPI

python -m twine upload dist/*