/1ads-mp2

SUPINFO's 1ADS 2nd mini-project

Primary LanguagePythonThe UnlicenseUnlicense

1ADS-MP2 - "Just Get 10"

Synopsis

All the code present in this repository was written in the context of a project evaluation that was submitted to SUPINFO students asking them to write a clone of Veewo's "Just Get 10" in Python, with the main goal to get used to create GUI with Pygame.
Being a group project, it involved three persons:

Code Guidelines

PEP-8

The de facto coding conventions to follow in Python are the ones defined in the PEP-8. To ensure this guideline is followed, we used the pylint linting tool.

Function Annotations

We agreed to use the so-called function annotations. They help sketch the flow of the code when implementing a new feature and detecting bugs ahead of run time.

Project Hierarchy

All games source files can be found in the src directory.
Tests are under the test directory.

Installation

Requires Python 3.5+ and Pygame.

Clone the repository:

git clone https://github.com/pldiiw/1ads-mp2.git

Then run the GUI:

python3 src/gui.py

Tests

There's a test suite inside the test directory.

To run them, just execute the test script:

./run_tests.bash

It requires mypy. If don't have it, just run:

sudo pip3 install mypy-lang

LICENSE

This project is under the Unlicense. See LICENSE file for more information.
EXCEPTING the version tagged as v1.0.0, which is licensed to SUPINFO International University under the terms of the FreeBSD License.