Python Dev Boilerplate

This is a template repository to get you started with a Python project.

What this includes:

• src and test directories
• main.py and test_main.py to get you started
• .gitignore file
  • venv
  • pycache
• requirements.txt with basic essential dependencies

Setup:

• Fork and clone this repo to your machine
• Open the repo on VSCode
• Open a new terminal (preferably bash)
• Setup your virtual environment with python -m venv venv
• Activate your venv with source venv/Scripts/activate
• Install the required dependencies with pip install -r requirements.txt
• Set your PYTHONPATH with export PYTHONPATH=$(pwd)
• Run pytest to check if working correctly with pytest

---

**If you are looking for a more in depth and advanced Python repo, see here: python_dev_boilerplate_advanced