Mau Mau

Play is the highest form of research

-- Probably not Albert Einstein

This project aims to be a learning tool, but this is a real application - not a toy example. The important difference to a "real" program is that the nasty details that usually screw with the nice and simple design and make the code grow tentacles and other cruft are kept at a minimum to enable you to explore the code as a nice little completely non-linear story. It came to life in a non-linear fashion and should also be read that way.

Emphasis is put on pythonic ways to code and on using the power of the Open Source ecosystem.

Features

The game

• Complete rules of Mau Mau
• Two different strategies:
  • Simple random strategy for a computer player
  • Strategy that adds interactivity so a human can play against the computer

Implementation and tools

• installable as command line tool
• runnable from the command line (created with fire)
• simulation helpers to run multiple games and collect stats
• use of magic methods to create custom classes which behave like inbuilt data types
• logging with stdlib logging module
• developer task automation with tox orchestrating:
  • automatic code formatting with black
  • Static code analysis with flake8
  • running tests with pytest
  • generation and deployment of documentation with MkDocs
  • unifying running these locally and on CI with Travis and Appveyor
• version handling from source control with setuptools scm
• included Linux and Windows development environments via vagrant.