Skip to content

MAINTENANCE.md

Latest commit

 

History

History
105 lines (68 loc) · 1.78 KB

MAINTENANCE.md

File metadata and controls

105 lines (68 loc) · 1.78 KB

Maintaining

Note

Why are we supporting Python 3.10 to 3.13?

Our lab machines still using Python 3.10.x. GitHub Codespace should still be using Python 3.12.x. Student who want to run the grading script locally may download 3.13 from python.org website.

First time setup

TBD

Building the package

Install the build-time dependencies.

python -m pip install --upgrade build twine

To build, run

python -m build

Installing the editable version

To locally install, run

python -m pip install -e ".[dev,doc]" --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

pytest --cov=grading_lib tests/

If you want to view the HTML report instead, run

coverage html

then open the HTML file in your browser.

Building the docs

cd docs
make html

Deployment flow

  • Check that unit testing on Windows and MacOs do not fail.

  • Run tox.

  • Update grading_lib/VERSION file.

  • Update CHANGELOG.md file.

  • Make a commit.

  • Tag the commit.

  • Push to GitHub.

  • Approve the deployment flow on GitHub Actions.

Manually publish to PyPI

There should be no need of running these commands manually now that the workflow is setup to auto publish to both PyPI and GitHub's Releases.

Howver, if the workflow is breaking, for example, you can run these commands to manually publish.

Publish to the real PyPI

Make sure you build the package.

python -m twine upload dist/*

Publish to the test PyPI

If you want to test something out.

python -m twine upload -r testpypi dist/*