Skip to content

threeal/python-starter

Repository files navigation

Python Starter

The Python Starter is a GitHub repository template that provides a minimalistic boilerplate to kickstart your Python project. This template offers a streamlined foundation, complete with predefined file structures, essential tools, and recommended settings, ensuring a swift and efficient start to your Python development journey.

Key Features

  • Organized file structure for Python projects, featuring a sample pyproject.toml, a sample module, and associated testing files.
  • Project and dependency management with Poetry, supplemented by Poe the Poet for task management.
  • Code formatting and linting with Ruff, leveraging all recommended rules for enhanced code quality.
  • Testing framework powered by Pytest, complete with support for test coverage checks.
  • API documentation generation with pydoctor and automated deployment to GitHub Pages.
  • GitHub Actions support with multiple workflows for continuous integration (CI) and continuous delivery (CD).
  • Automated dependency update checks with Dependabot.

Usage

Refer to this wiki for information on how to use this template.