Metadata-Version: 2.4
Name: kriegspiel
Version: 1.1.2
Summary: Python Kriegspiel Game
Author-email: Fil <alexander@kriegspiel.org>
Project-URL: Homepage, https://github.com/Kriegspiel/ks-game/
Project-URL: Bug Tracker, https://github.com/Kriegspiel/ks-game/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Games/Entertainment
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Python Kriegspiel Game

[![PyPI version](https://badge.fury.io/py/kriegspiel.svg)](https://badge.fury.io/py/kriegspiel)
[![codecov](https://codecov.io/gh/Kriegspiel/ks-game/branch/master/graph/badge.svg)](https://codecov.io/gh/Kriegspiel/ks-game)

---

## Kriegspiel Game Engine

Supported Kriegspiel rules:

1. [Berkeley](https://github.com/Kriegspiel/content/blob/master/rules/berkeley.md)
2. Berkeley + Any

In plan:

1. Crazykrieg
2. Crazykrieg + Any


## How-to

### Install

```bash
pip install kriegspiel
```

### Run tests

```bash
# clone this repo
git clone git@github.com:Kriegspiel/ks-game.git
# activate virtual env (optional)
cd ks-game
python3 -m venv ks-game-env
source ks-game-env/bin/activate
# install dependencies
pip install -r requirements.txt
pip install -r requirements-dev.txt
# run all tests
python run_tests.py
# see all test options
python run_tests.py --help
```

### Lint

```bash
black -l 128 %FILE%
```
