Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mr-sunglasses/lipilok
LipilLok: A tool that offers mastery over the world of writing.
https://github.com/mr-sunglasses/lipilok
Last synced: 6 days ago
JSON representation
LipilLok: A tool that offers mastery over the world of writing.
- Host: GitHub
- URL: https://github.com/mr-sunglasses/lipilok
- Owner: Mr-Sunglasses
- License: mit
- Created: 2024-02-26T18:12:37.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-03-13T02:31:36.000Z (11 months ago)
- Last Synced: 2024-11-18T07:47:01.985Z (2 months ago)
- Language: Python
- Size: 293 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spellcheck
[](https://github.com/ellerbrock/open-source-badges/) [](http://makeapullrequest.com)
### 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:
```bash
python --version
```
### 🐍 Installing Python 3.10 with `pyenv`
**Protip:** Managing multiple Python versions is a breeze with [pyenv](https://github.com/pyenv/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](https://github.com/pyenv/pyenv) to set it up.
Once you have `pyenv` ready, install the recommended Python version by running:
```bash
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"`
```env
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:
```bash
git clone https://github.com/BharatSahAIyak/spellcheck
```
- **Navigate to the Project Directory**:
```bash
cd spellcheck
```
- **Run the project using docker-compose**:
```bash
docker-compose up
```
## Local setup 🛠️ without Docker 🐳
### Setting Up the Project with PDM
[PDM (Python Development Master)](https://pdm.fming.dev/latest/) 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](https://pdm.fming.dev/latest/) to install PDM.
- **Clone the Repository**:
Get the project source code from GitHub:
```bash
git clone https://github.com/BharatSahAIyak/spellcheck
```
- **Navigate to the Project Directory**:
```bash
cd spellcheck
```
- **Install Dependencies**:
Use PDM to install the project's dependencies:
```bash
pdm install
```
* **Download models for spello**:
Use PDM to run the project:
```bash
pdm run download_model
```
* **Start the Project**:
Use PDM to run the project:
```bash
pdm run start
```