Skip to main content

Package to easily generate and/or solve any 9x9 sudoku grid

Project description

Sudoku Manager

Description

This package is made for easy sudoku generation and solving. Using the main Sudoku class, you'll easily be able to generate random sudokus (with a difficulty setting), load existing sudokus from different formats, and solve those sudokus. The Sudoku class has attributes dedicated to performance and backtracing, allowing you to study its behavior.

What it contains

The module contains 3 classes:

  • Sudoku: this is the main class you'll be using. It represents a sudoku grid.
  • Area: An area represents either a row, a column, or a square in a sudoku grid. It contains Cell instances, and is used to easily check "which values can be written"
  • Cell: A single cell in a sudoku grid. There are 81 in a 9x9 sudoku, and each Cell is associated with 3 Area instances (1 row, 1 column, 1 square)

Note that :

  • A Sudoku instance is made of 27 Area instances: 9 rows, 9 columns, and 9 squares
  • A Sudoku instance is made of 81 Cell instances
  • An Area instance is made of 9 Cell instances
  • Each Cell instance is stored into 3 areas (1 row, 1 column, and 1 square)

How it works

  • To install the module, use pip install sudoku-manager
  • To import the module, use import sudoku_manager
  • It is likely you will only use the Sudoku class. You can import it using from sudoku_manager.sudoku import Sudoku
  • To generate a sudoku: simply call the Sudoku.generate_grid() method with the correct settings. It will either output a JSON or return a grid.
  • To solve a sudoku: create a Sudoku instance (either from the normal constructor or a classmethod) and use the .solve() method to solve it.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sudoku_manager-1.0.6.tar.gz (9.6 kB view hashes)

Uploaded source

Built Distribution

sudoku_manager-1.0.6-py3-none-any.whl (11.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page