PyTypo

Your Telegram bot that helps find typos in other Github repositories (in ReadMe file) and can create Pull requests with a fix.

How to run

• Create a Telegram Bot
• Generate your Github token
• Clone the repo

git clone https://github.com/erjanmx/pyTypo.git

• Create a virtual environment and install the dependencies

pip install -r requirements.txt

• Copy vars to .env file and update its content accordingly

cp .env.example .env 

• Run the script

python main.py

• Send /start command to your Telegram bot.

Development

Source code formatting

pip install -r requirements-dev.txt

isort --profile black src/ tests/ main.py && black src/ tests/ main.py

Running the tests

python -m unittest discover tests/