obestwalter / mau-mau Goto Github PK

View Code? Open in Web Editor NEW

12.0 3.0 3.0 1.98 MB

Learn about Python by exploring a simple card game simulation.

Home Page: http://oliver.bestwalter.de/mau-mau/

License: MIT License

Python 100.00%

learning-python exploration object-oriented structure good-practices

mau-mau's Introduction

Mau Mau

Command line implementation of a german card game called Mau Mau.

Why?

This project is intended to be a learning tool with comprehensive documentation. It is not only for learning about Python as a programming language it is meant to demonstrate how the language is part of a vast Open Source ecosystem. This simple application uses all my (current) favorite bells and whistles of this ecosystem.

Read the documentation.

Try it

installation from this github repo:

$ pip install "git+https://github.com/obestwalter/mau-mau.git#egg=mau-mau"

Examples for command line use

play a game against the computer:

$ mau-mau play  # Control+C to stop

let the computer simulate a game:

$ mau-mau sim

list the different functions to run statistics:

$ mau-mau-stats

play many games and calculate the average turns needed to finish the game:

$ mau-mau-stats turns

Licenses and Acknowledgements

Licenses

Code is under MIT license and content is CC BY-NC-SA 4.0

mau-mau's People

Contributors

Stargazers

Watchers

Forkers

gregcodes tws0002 lazuraslong

mau-mau's Issues

Add coverage with coveralls

https://coveralls.io/

Explain log format

Add an explanation of the logging format in http://127.0.0.1:8000/guide/usage/#command-line-access to make the output digestible for people who have no experience in parsing log outputs.

mau-mau human crashes immediately on Windows 10

Traceback (most recent call last):
      File "C:\Users\Grigori\mau-mau-venv\Scripts\mau-mau-script.py", line 9, in <module>
        load_entry_point('mau-mau==4.0.0', 'console_scripts', 'mau-mau')()
      File "c:\users\grigori\mau-mau-venv\lib\site-packages\mau_mau\cli.py", line 54, in main
        functionObject(*args)
      File "c:\users\grigori\mau-mau-venv\lib\site-packages\mau_mau\cli.py", line 26, in play_interactive_game
        playedGame = play.play_game(_rulesOfTheGame, ['Eric', 'John', 'human'])
      File "c:\users\grigori\mau-mau-venv\lib\site-packages\mau_mau\play.py", line 12, in play_game
        player.play(game.table)
      File "c:\users\grigori\mau-mau-venv\lib\site-packages\mau_mau\subjects.py", line 91, in play
        self.strategy.play(table)
      File "c:\users\grigori\mau-mau-venv\lib\site-packages\mau_mau\strategy.py", line 25, in play
        self._play(table, card)
      File "c:\users\grigori\mau-mau-venv\lib\site-packages\mau_mau\strategy.py", line 57, in _play
        card = self.choose_best_candidate(candidates)
      File "c:\users\grigori\mau-mau-venv\lib\site-packages\mau_mau\strategy.py", line 94, in choose_best_candidate
        return cls.get_valid_choice(cards, "choose card to play")
      File "c:\users\grigori\mau-mau-venv\lib\site-packages\mau_mau\strategy.py", line 109, in get_valid_choice
        idx = input("%s.\n%s | " % (msg, visu(choices)))
      File "C:\Program Files (x86)\Python 3.5\lib\encodings\cp850.py", line 12, in encode
        return codecs.charmap_encode(input,errors,encoding_map)
    UnicodeEncodeError: 'charmap' codec can't encode character '\u2663' in position 37: character maps to <undefined>

Check results of QuantifiedCode analysis

https://www.quantifiedcode.com/app/project/663c550f107844aa842b4ce5e02883c4

Wanted suit is not logged

When a Jack is up, the strategy or the user is asked for the wanted suit, the answer should be logged to the output.

Add "graphics"

How about using unicode card characters?

https://en.wikipedia.org/wiki/Playing_cards_in_Unicode

sourcecode links broken in migrated docs

links to source files

mau-mau time_durations crashes on Windows 10 (i should switch my OS :-D)

Traceback (most recent call last):
      File "C:\Users\Grigori\mau-mau-venv\Scripts\mau-mau-script.py", line 9, in <module>
        load_entry_point('mau-mau==4.0.0', 'console_scripts', 'mau-mau')()
      File "c:\users\grigori\mau-mau-venv\lib\site-packages\mau_mau\cli.py", line 54, in main
        functionObject(*args)
      File "c:\users\grigori\mau-mau-venv\lib\site-packages\mau_mau\stats.py", line 30, in time_durations
        number=number)
      File "C:\Program Files (x86)\Python 3.5\lib\timeit.py", line 213, in timeit
        return Timer(stmt, setup, timer, globals).timeit(number)
      File "C:\Program Files (x86)\Python 3.5\lib\timeit.py", line 178, in timeit
        timing = self.inner(it, self.timer)
      File "<timeit-src>", line 3, in inner
    ImportError: No module named 'mau_mau.main'

Reorganize documentation

Completely chaotic after migration

Test this on windows

Try out if everything works, including building the docs, testing, etc.

Add material theme as subtree?

https://github.com/obestwalter/mkdocs-material

https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt

How to make strategies configurable/choosable?

When more strategies are added, there has to be a way to assign them to the different players. Configuration file? Interactively? Use mau-mau as a library and code it?

update project

http://oliver.bestwalter.de/mau-mau/ pythonic link is stale
http://oliver.bestwalter.de/mau-mau/ QuantifiedCode is discontinued
add black formatter