README.md

Welcome to Sudoku game 👋

GUI desktop Sudoku game using pygame. (include Sudoku solver and random Sudoku board generator)

Demo (Full demo) 🧮

automatic solver

win

lose

Usage 🗝

There's two way to use this project:

• Without any prerequisites:

  • download whole executable directory
  • run executable/exe/sudoku.exe

• With prerequisites:

  • clone this repo :

    $ git clone https://github.com/hadialqattan/sudoku.git

  • install prerequisites
  • Run run.sh :

    $ ./run.sh

Prerequisites 🔩

• Python 3.x
• Python libraries from requirements.txt

  $ sudo pip3 install -r requirements.txt

Tests 🧪

Unit tests @ tests directory include tests only for :

• src.solver.sovler.Solver class (not include auto_solver function) @ tests/test_01_solver.py using tests/IO.py data.
• src.generator.generator.Generator class @ tests/test_02_generator.py.

Run instructions:

• All tests :

  $ pytest -v tests/

• Specific tests :

  • only solver tests :

    $ pytest -v tests/test_01_solver.py

  • only generator tests :

    $ pytest -v tests/test_02_generator.py

Copyright ©

👤 Hadi Zaki Alqattan

• Github: @hadialqattan
• Email: alqattanhadizaki@gmail.com

📝 License

Copyright © 2020 Hadi Zaki Alqattan.
This project is MIT licensed.

---

Give a ⭐️ if this project helped you!