README.md

ot-harjoitustyo

This repository hosts my project for the software technology course - a simple platformer game written in python with pygame.

Releases

• Week 5
• Week 6
• Week 7 (final deadline)

Documentation

• User manual
• Requirements specification
• Architecture description
• Test documentation
• Timesheet
• Changelog

Setup

This project uses poetry for managing dependencies. Install dependencies:

poetry install 

Available CLI commands

Running the program

Run the program with:

poetry run invoke start

Testing

Tests can be run with:

poetry run invoke test

A report of test coverage can be generated with:

poetry run invoke coverage-report

The report can be found in the htmlcov directory.

Linting

Code linting with pylint can be done with:

poetry run invoke lint

Formatting

You can format the code using autopep8 with:

poetry run invoke format