Skip to content

A quick-start Poetry Python project template with helpful functionality and common libraries.

Notifications You must be signed in to change notification settings

dylanhogg/poetry-python-project-template

Repository files navigation

Poetry Python Project Template

Static Badge

Latest Tag Build PyPI

Top language Last commit License: MIT

Colab

A quick-start Poetry Python project template with helpful functionality and common libraries.

Usage

  • Ensure you rename all instances of your_project_name including the top level folder name.
  • See the Poetry docs for more information on using Poetry.

Template Features

  1. Poetry for dependency management
  2. Useful functionality wrapped in a Makefile
  3. Helpful default packages (details below)
  4. A GitHub CI build action using poetry that runs linting, type checking and unit tests
  5. Example app showing logging and CLI arg parsing

Application libraries included in template

  1. Python-dotenv for environment variable management
  2. Typer for building CLI applications
  3. tqdm for smart progress bar support
  4. Loguru for pleasant and powerful logging
  5. Rich for beautiful terminal output

Development libraries included in template

  1. pytest for writing your tests
  2. Black for code formatting
  3. Ruff for fast linting and formatting
  4. pyright for static type checking
  5. coverage for code coverage
  6. pre-commit for pre-commit hooks (black, ruff and pyright)
  7. pip-audit for checking for security vulnerabilities

Happy templating!

About

A quick-start Poetry Python project template with helpful functionality and common libraries.

Topics

Resources

Stars

Watchers

Forks