nicolafan / pyleague-soccer-simulation

A Python soccer championship simulation
MIT License
5 stars 3 forks source link
football league python random rng simulation soccer soccer-league soccer-matches tkinter

PyLeague Soccer Simulation

PyLeague is a software simulation of a soccer championship developed using Python. The goal of PyLeague is to provide the simulation of the course of one season in a realistical league (such as Lega A). pyleague Screenshot from 2021-12-14 18-11-19

Features

Future developments

PyLeague can be seen as a basis for creating cool projects which need the generation of realistical random soccer results.
Also, it can be improved and enhanced with many other features.
The next developments of PyLeague will be:

Installing PyLeague

To install and run PyLeague just clone the project and create a specific Python environment for running/modifying PyLeague.
The requirements are contained in the requirements.txt file.
PyLeague will start after running main.py.

Contributing

If you want to help me adding new features and improving PyLeague, you're welcome!
Just fork the project, commit your changes and create a PR.
If you want you can create a new issue for the project and ask me anything related to it here on Github!
When starting working to an issue, create a branch called:

issue/{number of the issue}-{title of the issue (lowercase), separe spaces with `-`}


I'm open to new improvements and suggestions.
Class/function/method documentation is written like this.

Testing

To start the automated tests run:

.../pyleague_soccer_simulation$ pytest

Formatting

To format the code run:

.../pyleague_soccer_simulation$ black .

Type-checking

To execute type-checking run:

.../pyleague_soccer_simulation$ mypy pyleague


Thank you and happy coding with PyLeague!