Resources
Tox Changes
In the tox.ini
file, we added the following line under the [testenv]
heading:
ignore_errors = True
This will allow the full Tox script to execute, even if there are errors earlier in the process.
Outline
Here is a basic outline of the steps to follow to complete this example.
- Clone Starter Code from GitHub
git clone <url> python
- Run Project
cd python
python3 -m src
- Install Tox
pip3 install tox
- Check & Test Existing Project
python3 -m tox
-
Confirm that project runs, all unit tests pass, no style errors, no type errors, and documentation generates properly.
-
Create New Unit Tests and Update Code as Needed. Continuously commit to Git as changes are made!
-
Add Documentation Comments. Continuously commit to Git as changes are made!
-
Add
README.md
and discuss unit tests you feel should be added to adequately test theGuessingGame
class. -
Create a UML Class Diagram for the source code and include it in the project.
-
Confirm that project runs, no style errors related to comments, and pydoc3 generates properly.
-
When complete, use Git to commit and push updated code.
git add .
git commit -m "Example Complete"
git push
- On GitHub, create a release tag and submit URL to Canvas for grading.