This project is part of Helsinki University's Data Structures Project course.
The test branch coverage report can be seen in the testing document: Testing Document
- Project specification document
- Testing document
- Implementation document
- Instructions
- Weekly reports:
Note: The project uses Poetry, and the poetry commands may not work correctly on Windows operating systems. In case the poetry invoke commands don't work, use the corresponding commands written in the tasks.py file. E.g. instead of 'poetry run invoke test', type 'pytest src' in the console.
- Clone the repository to your computer.
- Navigate to the repository's root directory, then install dependencies for poetry with ´poetry install´
- Run the game with ´poetry run invoke start´
You can run the unit tests with ´poetry run invoke test´
A coverage report can be generated in html form with ´poetry run invoke coverage-report´
You can run performance tests with ´poetry run invoke test-performance´
You can run the pylint style checker with ´poetry run invoke lint´