Metadata-Version: 2.4
Name: chess-puzzler
Version: 0.1.1
Summary: Find and tag chess puzzles from chess games
Maintainer-email: Christopher Akiki <christopher.akiki@gmail.com>
License-Expression: AGPL-3.0-or-later
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: chess
Requires-Dist: click
Requires-Dist: tqdm
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Description-Content-Type: text/markdown

# chess-puzzler

Python package to generate and tag puzzles from chess games. 

## Installation

`pip install git+https://github.com/cakiki/chess-puzzler.git`

You also need stockfish on your path to find puzzles in games.

## Usage
You can use chess-puzzler as a CLI tool or as a python library:

### CLI
TODO
### Library
TODO

## Inspiration

This is a refactor of [ornicar/lichess-puzzler](https://github.com/ornicar/lichess-puzzler), also inspired by [kraktus/lichess-puzzler](https://github.com/kraktus/lichess-puzzler) and [fitztrev/puzzler](https://github.com/fitztrev/puzzler). The goal was to make the lichess-puzzler more pythonic and pip installable.

## License

chess-puzzler is licensed under the GNU Affero General Public License 3 or any later version at your choice.
