Metadata-Version: 2.1
Name: mastermind
Version: 0.7
Summary: Play mastermind with python !
Home-page: https://github.com/nicohlr/mastermind.git
Author: Nicolas Houlier
Author-email: nicolas.houlier@gmail.com
License: MIT
Keywords: mastermind notebook ipywidgets game
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown; charset=UTF-8
Requires-Dist: ipywidgets (>=7.4)
Requires-Dist: notebook-toggle-code

# mastermind

This package allows you to play Mastermind directly into a jupyter notebook/lab IDE. It has been made using the great [ipywidgets](https://ipywidgets.readthedocs.io/en/stable/) python library.

## Install

    pip install mastermind

## How to use in a jupyter notebook

Copy and paste the following lines into a cell of a notebook and run it:

    from mastermind import MastermindNotebook
    game = MastermindNotebook()

The game should display, you can start playing by choosing one color for each position and click on "Confirm combination" button !

![GitHub Logo](mastermind/img/game_capture.png)

## How to use in jupyter lab

To use in jupyter lab, don't forget to install the jupyter widget extension:

    jupyter labextension install @jupyter-widgets/jupyterlab-manager

Once this is done, you can proceed in the same way as for the jupyter notebook use.

## State of development

* A Tkinter interface must be developed to play outside a notebook, feel free to contribute !

* Add a DB to record all the games for one user

