Metadata-Version: 2.4
Name: pencil-puzzles
Version: 0.4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Rust
Classifier: Topic :: Games/Entertainment :: Puzzle Games
License-File: LICENSE
Summary: Generate, solve, rate and check pencil puzzles such as sudoku and nurikabe, with difficulty set by the human techniques they need
Keywords: puzzle,sudoku,nurikabe,kakurasu,fillomino,hashi,hitori,kakuro,generator,solver,difficulty
License-Expression: MIT
Requires-Python: >=3.10
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Homepage, https://pencil-puzzles.org/
Project-URL: Documentation, https://pencil-puzzles.org/docs/
Project-URL: Source, https://github.com/emieks/pencil-puzzles
Project-URL: Issues, https://github.com/emieks/pencil-puzzles/issues

# pencil-puzzles for Python

Generate, solve, rate and check pencil puzzles such as sudoku and nurikabe.
Generated puzzles have exactly one solution and a difficulty from easy to
expert, set by the hardest solving technique they need.

Requires CPython 3.10 or newer on Windows, macOS or Linux:

```sh
pip install pencil-puzzles
```

```python
import pencil_puzzles as pp

g = pp.generate("sudoku", difficulty="hard")
print(g.puzzle)
print(g.rating.level, g.rating.techniques)

assert pp.solve(g.puzzle) == g.solution
print(pp.hint(g.puzzle))  # the first step a solver would take
```

Documentation: [quickstart](https://pencil-puzzles.org/docs/quickstart/),
[user guide](https://pencil-puzzles.org/docs/guide/generating/),
[API reference](https://pencil-puzzles.org/docs/api/) and
[genres](https://pencil-puzzles.org/docs/). Source and issues are on
[GitHub](https://github.com/emieks/pencil-puzzles).

