https://github.com/imseanconroy/sudoku-cracker
Sit back, relax, and let your Sudoku puzzles be solved using brute-force.
https://github.com/imseanconroy/sudoku-cracker
algorithms computer-vision python recursion
Last synced: about 1 year ago
JSON representation
Sit back, relax, and let your Sudoku puzzles be solved using brute-force.
- Host: GitHub
- URL: https://github.com/imseanconroy/sudoku-cracker
- Owner: ImSeanConroy
- License: mit
- Created: 2024-10-13T19:52:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-09T19:45:14.000Z (over 1 year ago)
- Last Synced: 2025-02-05T17:12:43.519Z (over 1 year ago)
- Topics: algorithms, computer-vision, python, recursion
- Language: Python
- Homepage:
- Size: 746 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sudoku Cracker
Sit back, relax, and let your Sudoku puzzles be solved using brute-force. This simple Python CLI tool allows you to input puzzles directly or provide a file path for automatic solving.
## Table of Contents
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Development and Testing](#development-and-testing)
- [License](#license)
- [Support](#support)
## Getting Started
### Prerequisites
Before getting started, ensure you have the following installed:
- [Python](https://www.python.org/)
### Installation
The following contains instruction for getting this application running locally:
1. Clone the repository.
```bash
git clone https://github.com/ImSeanConroy/sudoku-cracker.git
cd sudoku-cracker
```
2. Create and start virtual environment
```bash
python3 -m venv env
source env/bin/activate
```
3. Install dependencies
```bash
pip3 install -r requirements.txt
```
4. Run script
```bash
python main.py --cubes cube1 cube2 cube3 cube4 cube5 cube6 cube7 cube8 cube9
```
## Usage
The Sudoku Cracker allows you to input your Sudoku puzzle as 9 groups of 3x3 numbers. Each group represents a 3x3 cube, and the numbers are separated by commas. Use `0` for empty cells.
### Example Input
Solve puzzle from a set of cubes (input directly):
```bash
python main.py --cubes 003500160 029700005 100000009 049000050 000006010 000250006 000008000 050037000 080002001
```
### Additional Options
Solve puzzle from a text file where each line represents a row of the puzzle and each number is seperated by a space:
```bash
python main.py --file "examples/example.txt"
```
Example file format (example.txt):
```bash
0 0 3 0 2 9 1 0 0
5 0 0 7 0 0 0 0 0
1 6 0 0 0 5 0 0 9
0 4 9 0 0 0 0 0 0
0 0 0 0 0 6 2 5 0
0 5 0 0 1 0 0 0 6
0 0 0 0 5 0 0 8 0
0 0 8 0 3 7 0 0 2
0 0 0 0 0 0 0 0 1
```
Solve puzzle from a image. Ensure that the image contains only the Sudoku puzzle and is centered and extends as close to the image’s edges as possible for optimal recognition (example.png):
```bash
python main.py --image "examples/example.png"
```
Solve puzzle from a set of rows (input directly):
```bash
python main.py --rows "..."
```
Disable Color Output:
```bash
python main.py --cubes "..." --no-color
```
Disable Runtime Display:
```bash
python main.py --cubes "..." --no-runtime
```
Disable Column and Row Seperators:
```bash
python main.py --cubes "..." --no-seperators
```
## Development and Testing
1. Run the following command to run the full test suit:
```bash
pytest tests/
```
## License
This project is Distributed under the MIT License - see the [LICENSE](LICENSE) file for information.
## Support
If you are having problems, please let me know by [raising a new issue](https://github.com/ImSeanConroy/sudoku-cracker/issues/new/choose).