/karyar-python-projects-template

Karyar Python Projects Template

Primary LanguagePythonMIT LicenseMIT

karyar-python-projects-template

Hello dear students and welcome. To create your project, just simply use this template.

Installation

To Start developing using this template you need to follow these steps:

1 - Create a virtual environment:

python -m venv env

2 - Activate the virtual environment:

  • Windows:
env/Scripts/activate
  • Mac/Linux:
source env/bin/activate

3 - Install the required packages:

pip install -r requirements.txt

4 - Install pre-commit to your .git/hooks/:

pre-commit install

Also make sure you autoupdate pre-commit if you faced any issues:

pre-commit autoupdate

5 - Start developing your project and we wish you the best ;)

Commiting

You may have noticed we are using pre-commit that checks many things and lowers the risks of implementing disasters. pre-commit checks before you commit your changes and if anything goes wrong, you cannot commit. Fix the errors and try to commit again and you're good to go. If you want to run pre-commit without commiting you can run:

pre-commit run -a