README.md

python-boilerplate

Boilerplates are like toothbrushes. Everyone has one and no one wants to use anyone else's.

This one is mine.

Prerequisites

• Python
• pyenv
• Poetry

Dependencies

• Black
• Flake8
• mypy
• pytest

Usage

Run the script

1. Open a terminal window at the root of this project

2. Run the following commands:

## Install dependencies
poetry install

## Run main script
poetry run ./src/myproject/main.py

Additional commands

## Lint with flake8
poetry run flake8 .

## Lint with black
poetry run black .

## Check static typing with mypy
poetry run mypy .

## Test with pytest
poetry run pytest

## Update dependencies
poetry update

License

The MIT License (MIT)

Copyright (c) 2022 Dane Petersen