Skip to content
This repository has been archived by the owner on Mar 15, 2022. It is now read-only.

killian-mahe/sudoku-reader

Repository files navigation


Sudoku Reader

An application that is able to read and solve a Sudoku thantks to machine learning.
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

The goal of this project is to build an application to read a sudoku puzzle from a picture and solve it using CSP (Constraint Satisfaction Problems).

Built With

Getting Started

This project is based on Python. No framework is needed, but you must install the PySide6 package. We strongly suggest your to create a virtual environment to create the app environment. You can also use the Dockerfile to use with Docker.

Installation

Before clonning the repository, you should create a new virtual environment (using venv for exemple).

  1. Clone the project (or use the src folder)
    git clone https://github.com/killian-mahe/sudoku-reader.git
  2. Install the virtual environment
    cd sudoku-reader && python3 -m venv env
  3. Activate the new environment (on Linux)
    source env/bin/activate
  4. Activate the new environment (on Windows with powershell)
    env\Scripts\Activate
  5. Activate the new environment (on Windows with CMD)
    env\Scripts\activate.bat
  6. Install required packages
    pip3 install -r requirements.txt

Use

Desktop application

  1. Start the project
    python sudoku_reader

Mobile application

  1. Add flask to env path (on powershell)
    $env:FLASK_APP = "server"
  2. Add flask to env path (on CMD)
    set FLASK_APP=server
  3. Start the server
    cd sudoku_reader
    flask run --host=0.0.0.0

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Killian Mahé - @killian-mahe - killianmahe.pro@gmail.com

Project Link: https://github.com/killian-mahe/sudoku-reader

Acknowledgements

About

A session project in ML at UQAC

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published