Metadata-Version: 2.1
Name: sudoku-tools
Version: 0.1.0
Summary: A collection of useful tools for generating, grading, solving, and transforming sudoku puzzles
Home-page: https://github.com/dawsonbooth/sudoku-tools
License: MIT
Author: Dawson Booth
Author-email: pypi@dawsonbooth.com
Requires-Python: >=3.7,<4.0
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: numpy (>=1.20.2,<2.0.0)
Project-URL: Documentation, https://dawsonbooth.github.io/sudoku-tools
Project-URL: Repository, https://github.com/dawsonbooth/sudoku-tools
Description-Content-Type: text/markdown

# `sudoku-tools`

[![pypi version](https://img.shields.io/pypi/v/sudoku-tools.svg?style=flat)](https://pypi.org/pypi/sudoku-tools/)
[![downloads](https://pepy.tech/badge/sudoku-tools)](https://pepy.tech/project/sudoku-tools)
[![build status](https://github.com/dawsonbooth/sudoku-tools/workflows/build/badge.svg)](https://github.com/dawsonbooth/sudoku-tools/actions?workflow=build)
[![python versions](https://img.shields.io/pypi/pyversions/sudoku-tools.svg?style=flat)](https://pypi.org/pypi/sudoku-tools/)
[![format](https://img.shields.io/pypi/format/sudoku-tools.svg?style=flat)](https://pypi.org/pypi/sudoku-tools/)
[![license](https://img.shields.io/pypi/l/sudoku-tools.svg?style=flat)](https://github.com/dawsonbooth/sudoku-tools/blob/master/LICENSE)

## Description

This Python package is a collection of useful tools for generating, grading, solving, and transforming sudoku puzzles.

## Installation

With [Python](https://www.python.org/downloads/) installed, simply run the following command to add the package to your project.

```bash
python -m pip install sudoku-tools
```

## Usage

The object can be constructed with a 1-dimensional board:

```python
arr_1d = [1, 0, 3, 4, 0, 4, 1, 0, 0, 3, 0, 1, 4, 0, 2, 3]
puzzle = Puzzle(arr_1d, 0)
```

Feel free to [check out the docs](https://dawsonbooth.github.io/sudoku-tools/) for more information.

## License

This software is released under the terms of [MIT license](LICENSE).

