Here is a basic outline of the steps to follow to complete this example.

  1. Clone Starter Code from GitHub
git clone <url> python
  1. Run Project
cd python
python3 -m src
  1. Install Tox
pip3 install tox
  1. Check & Test Existing Project
python3 -m tox
  1. Confirm that project runs, all unit tests pass with 100% coverage, no style errors, no type errors, and documentation generates properly.

  2. Create New Packages, Classes, and Enums. Continuously commit to Git as changes are made!

  3. Update to use new classes (optional). This is just for testing purposes.

  4. When complete, use Git to commit and push updated code.

git add .
git commit -m "Example Complete"
git push
  1. On GitHub, create a release tag and submit URL to Canvas for grading.