Python Project Template

This repository has been created to be used as a starting point (template) for new Python projects. As with most other projects, this is a work in progress. If you feel that this template in its current form is not usable for your new project, please create an issue to start a discussion, or create a PR to suggest a change or a useful addition.

Using this template

• Create a new GitHub project and select this repository as a template.
• Update the project name and description in pyproject.toml.
• Rename the python_project_template module folder to match the name of your project.
• The template comes with a set of predefined (dev-)dependencies to get you up and running quickly. Add additional dependencies that you need for your project

Getting Started

Prerequisites

• Install pyenv: https://github.com/pyenv/pyenv
• Install poetry: https://python-poetry.org/docs/

Installation

1. Clone the repo

git clone https://github.com/Harborn-digital/Project-Name.git

2. Install dependencies

poetry install --no-root

3. Install pre-commit hook

poetry run pre-commit install

Usage

Available (console) commands

• Run all fixes

poetry run poe fix

• Run all tests

poetry run poe test

Troubleshooting