PaulTreanor / simple-python-starter

A simple starter template for Python projects.

Python Starter Project

A simple starter project for Python projects:

• Simple Package/Module structure
• Testing with pytest
• Linting with autopep8
• CI with Github Actions

Installation

1. Clone the repository
2. Create a virtual environment [optional]
3. Install the requirements

   pip install -r requirements.txt

4. Run the project

   python main.py

Setting up a virtual environment with mini conda

1. Install mini conda
2. Create a virtual environment

   conda create -n <env_name> python=3.8

3. Activate the virtual environment

   conda activate <env_name>

Run tests

In root of project run:

pytest

Run linting

autopep8 --in-place --recursive .