README.md

blueprint-python

Table of contents

• About
• Development
  • Prerequisites
  • Setup local environment
  • Contribute

About

GitHub template for Python package blueprint.

Usage:

pip install git+https://github.com/cachuperia/blueprint-python.git
blueprint-python --help

Development

Release can be triggered by commit with feat or fix prefix. Check GitHub workflow for details.

Prerequisites

Tools to install: direnv, git, poetry and pre-commit.

You can use this playbook for automated tools installation(Ubuntu only).

Setup local environment

git clone git@github.com:cachuperia/blueprint-python.git
cd blueprint-python
make init
direnv allow

Run make for list all available targets.

Contribute

Use Conventional Commits message style.