Skip to content

Flag Game built with Python as a university assignment work.

License

Notifications You must be signed in to change notification settings

joonarafael/flaggame

Repository files navigation

This repository is a new cleaned clone of the original course repository. Only the final project (e.g. the flag game) is left. All course exercises and other unnecessary stuff is removed.

FLAG QUIZ GAME

main workflow codecov

current ver 0.2.8 (14.4.2024), latest release of the software source code can be found here.

This is a Flag Quiz Game including all 195 fully recognized independent states listed at state.gov, and Taiwan, Kosovo & Western Sahara. The game has 5 different game modes; Classic, Advanced, Time Trial, One Life, and Free Mode. See the Rule Book for details. The software also records all user activity and played games! Player may look previous games and study their own lifelong statistics, such as total playtime or average streak length!

DOCUMENTATION

VERSIONS & TECHNICAL DETAILS

Software has not been tested in a MacOS or Windows environment. Flag Quiz Game has been built with Python 3.10. Software might not run on other versions. You can find the installation manual here.

The software launching and testing etc. are automated with bash scripts. For non-Linux OS users, more technical know-how is required to get the game going.

SOFTWARE TESTING WITH PYTEST

Run the tests configured with pytest.ini (ignoring all graphical user interface modules) by executing:

./test.sh

Navigate to this folder to find all the automated test source files. The tests will take approximately 38 seconds. They are testing e.g. how the points awarding algorithms and statistics calculations work with different round times and scores. See Software Testing for a more complete document detailing the software testing process.

SOFTWARE TEST COVERAGE REPORT

To generate the Coverage report (web browser version) for your local machine, execute:

./coverage.sh

The generated report can be found at ./htmlcov/index.html.

PYLINT AUTOMATED CODE REVIEW

To run the automated code review algorithm with parameters defined in pylintrc, execute:

./pylint.sh

To read my personal notes about pylint results and other comments regarding software source code quality, check this document.