ranker 0.0.1

Generates rankings

Ranker

Ranker is a CLI tool that processes results from games and generates a ranking table into stdout.

1. Tarantulas, 6 pts
2. Lions, 5 pts
3. FC Awesome, 1 pt
4. Snakes, 1 pt
5. Grouches, 0 pts

The rules A draw (tie) is worth 1 point and a win is worth 3 points. A loss is worth 0 points. If two or more teams have the same number of points, they should have the same rank and be printed in alphabetical order (as in the tie for 3rd place in the sample data).

Installation & Requirements

Ranker has been tested in Python versions 3.7 - 3.9. It is recomended to have at least Python 3.7 with PIP installed.

Run the following command:

# Install package from PyPI
$ pip install ranker

Usage

Format The input must contain results of games one per line and must have this format:

Lions 3, Snakes 3
Tarantulas 1, FC Awesome 0
Lions 1, FC Awesome 1
Tarantulas 3, Snakes 1
Lions 4, Grouches 0

File

$ ranker path/to/file

Ranker accepts a file path as an optional argument to process the information inside the file and returns the ranking table.

Stdin

$ ranker

If no argument is provided to Ranker, it will read the input from stdin and stop when it finds an empty line then returns the result.

Tests

The tests can be run from the project root directory using the following command:

$ python -m unittest

References

This CLI uses the argparse library for command-line parsing, and the unittest framework for testing, both of which come by default in the Python standard library being this the main reason I decided to use them in the project.

The project was built using setuptools, and distributed to the Python Package Index (PyPI) using twine.

For a detailed Python Packaging Guide visit: https://packaging.python.org/en/latest/