This package is and exercise in object oriented design, unittest, and documentation inspired heavily by Steven F. Lott's Building Skills in Object-Oriented Design. I also intend to use it as template to use as an example of setting up a package. This README should be considered a stub for now.
These instructions will show you how to setup and use Casino.
You will need python version 3. No other modules are required to run the game but Sphinx is required for generating docs and Coverage is useful for testing.
Just use pip:
pip install git+https://github.com/vguarnaccia/Casino/
Tests are written using the unittest, or doctests modules. Unittests should enfoce 100% test coverage on all functions and classes. They can be executed as a script:
python -m casino.test
Or, better yet:
coverage run -m casino.test # you can now review coverage reports
- Code inspired by Steven F. Lott's Building Skills in Object-Oriented Design.
- Coding style from Google Style Guide.
- Docstring Style.