Skip to content

pronovic/apologies

Repository files navigation

Apologies Python Library

pypi license wheel python Test Suite docs coverage Poetry

This is a Python library that implements a game similar to the Sorry board game. On UNIX-like platforms, it includes a console demo that plays the game with automated players, intended for use by developers and not by end users.

It was written as a learning exercise and technology demonstration effort, and serves as a complete example of how to manage a modern (circa 2020) Python project, including style checks, code formatting, integration with IntelliJ, CI builds at GitHub, and integration with PyPI and Read the Docs.

Developer documentation is found in DEVELOPER.md. See that file for notes about how the code is structured, how to set up a development environment, etc.

If you want to use this as a starting point for your own repository, check out the cookiecutter-pypi template repository.