cookiecutter-poetry-py3-10

This is a cookiecutter template used to generate Python 3.10+ poetry projects.

Features

Poetry

local directory installation for vscode interpreter magic.

Docker

Dockerfile with python 3.10 base image and package installation

Pre-commit

Python's Isort for import formatting Python's Black for strict formatting

vscode settings (optional)

VSCode settings that use black and the local poetry python package for auto-completes and module discovery

dotenv loading (optional)

For application type packages that have .env provided runtime configurations

Installation

pip3 install cookiecutter

Usage

cookiecutter gh:IndicoDataSolutions/cookiecutter-poetry-py3-10

The cookiecutter generation hooks will automatically setup all features and dependency necessary for this project.

Pre-commit Hooks

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v2.3.0
    hooks:
      - id: check-yaml
      - id: end-of-file-fixer
      - id: trailing-whitespace
  - repo: https://github.com/pycqa/isort
    rev: 5.10.1
    hooks:
      - id: isort
        name: isort (python)
        args: ["--profile", "black"]
  - repo: https://github.com/psf/black
    rev: 22.3.0
    hooks:
      - id: black

Private Repos

There is an option to enable ssh mounting to the docker build process that allows poetry to install private github repositories added to the pyproject.toml like so:

lib_name = {git = "ssh://[email protected]/user_or_org/lib_name.git", branch = "main", tag="0.1.0", version=0.1.0}

It requires SSH_AUTH_SOCK environment variable to be set, which can be done with the following command:

eval $(ssh-agent)

It also requires the keys you want to use for SSH access to be tracked in the ssh agent. If you don't have these setup, you can add them like so:

ssh-add -L # lists keys currently added
ssh-add [optional key]

In order to have ssh-agent & keys automatically added, you can follow the instructions here