irohanrajput/lipilok

LipilLok: A tool that offers mastery over the world of writing.

Spellcheck

A tool that offers mastery over the world of writing ✍🏻

---

🤔 Pre-requisites

• python3
• pdm

🐍 Python Version Support

This project is designed to be compatible with specific versions of Python for optimal performance and stability.

Supported Python Version

• Python>=3.10

❗️ For the best experience and performance, it is recommended to use the version mentioned above.

Before diving into the project, ensure that you have the correct Python version installed. To check the version of Python you currently have, execute the following command in your terminal:

python --version

🐍 Installing Python 3.10 with pyenv

Protip: Managing multiple Python versions is a breeze with pyenv. It allows you to seamlessly switch between different Python versions without the need to reinstall them.

If you haven't installed pyenv yet, follow their official guide to set it up.

Once you have pyenv ready, install the recommended Python version by running:

pyenv install 3.10

When you navigate to this project's directory in the future, pyenv will automatically select the recommended Python version, thanks to the .python-version file in the project root.

📦 Setup

Note: We use .env to define the download model, So create .env with respective model name from the table of models or Defaulf model will be selected as MODEL="en"

MODEL="MODEL NAME"

We currently support these models

Model	Size
en	84M
en_large	284M
hi	75M
hi_large	374M

Local setup 🛠️ with Docker 🐳

• Using docker-compose: You can also use docker-compose to run the project locally by running the following command:
  

  • Clone the repository: Get the project source code from GitHub:

  git clone https://github.com/BharatSahAIyak/spellcheck

  • Navigate to the Project Directory:

  cd spellcheck

  • Run the project using docker-compose:

  docker-compose up

Local setup 🛠️ without Docker 🐳

Setting Up the Project with PDM

PDM (Python Development Master) is utilized for dependency management in this project. To set up and run the project:

• Installing PDM: Before you begin, ensure you have PDM installed. If not, refer to the official documentation to install PDM.

• Clone the Repository: Get the project source code from GitHub:

  git clone https://github.com/BharatSahAIyak/spellcheck

• Navigate to the Project Directory:

  cd spellcheck

• Install Dependencies: Use PDM to install the project's dependencies:

  pdm install

• Download models for spello: Use PDM to run the project:

  pdm run download_model

• Start the Project: Use PDM to run the project:

  pdm run start