Metadata-Version: 2.4
Name: pyCribbageApp
Version: 0.1.2
Summary: pyCribbageApp is a python package that provides a tkinter based GUI for playing cribbage games using the CribbageSim package.
Keywords: GUI,cribbage,tkinter,desktop
Author-Email: "Kevin R. Geurts" <kevin.r.geurts@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Win32 (MS Windows)
Classifier: Environment :: X11 Applications
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Games/Entertainment :: Turn Based Strategy
Project-URL: Homepage, https://github.com/KevinRGeurts/pyCribbageApp
Project-URL: Issues, https://github.com/KevinRGeurts/pyCribbageApp/issues
Requires-Python: >=3.12
Requires-Dist: tkAppFramework>=0.9.2
Requires-Dist: CribbageSim>=1.0.0
Description-Content-Type: text/markdown

# pyCribbageApp

Source code: [GitHub](https://github.com/KevinRGeurts/pyCribbageApp)
---
pyCribbageApp is a python package that provides a tkinter based GUI for playing cribbage games using the CribbageSim package.

## Requirements

- tkAppFramework>=0.9.2: [GitHub](https://github.com/KevinRGeurts/tkAppFramework), [PyPi](https://pypi.org/project/tkAppFramework/)
- CribbageSim>=1.0.1: [GitHub](https://github.com/KevinRGeurts/CribbageSim), [PyPi](https://pypi.org/project/CribbageSim/)

## Basic usage

The simplest way to run the app is:

```
python -m pyCribbageApp.CribbageApp 
```

This assumes that the required packages are installed. To learn how to use the app, select Help | View Help... from the menu bar.

## Unittests

Unittests for the pyCribbageApp package are in the tests directory, with filenames starting with test_. To run the unittests,
type ```python -m unittest discover -s ..\..\tests -v``` in a terminal window in the src\pyCribbageApp directory.

## License

MIT License. See the LICENSE file for details