sudoku-tools 0.0.1

No project description provided

sudoku-tools

Description

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

This package is very incomplete and should not be expected to solve or rate complicated sudoku puzzles. Only a few simple strategies are currently implemented. That said, transformations (rotate, reflect, shuffle) and conversions (to/from string, 1D array, 2D array) should be fully functional.

Please feel free to contribute and implement more strategies or add to the documentation if you would like to see this package progress more quickly.

Installation

With Python installed, simply run the following command to add the package to your project.

pip install sudoku-tools

Usage

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

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

... or with a 2-dimensional board:

arr_2d = [[1, 0, 3, 4],
	[0, 4, 1, 0],
	[0, 3, 0, 1],
	[4, 0, 2, 3]]
puzzle = Puzzle(arr_2d, 0)

Feel free to check out the docs for more information.

License

This software is released under the terms of MIT license.