Skip to content

๐ŸŽˆ A Python package template using pyproject.toml, hatch, pre-commit, black, ruff, and mkdocs.

License

Notifications You must be signed in to change notification settings

alvarobartt/python-package-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

98 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŽˆ Python Package Template

โœจ Features

  • Package configuration with pyproject.toml built with hatch
  • Code formatting and linting with ruff, and black
  • Dockerfile with package installation
  • pre-commit configuration file
  • GitHub Codespaces can be created from .devcontainer
  • CI-CD Pipelines with GitHub Actions
  • Basic pytest set-up for unit tests
  • Auto-generated docs with mkdocs and mkdocs-material

๐Ÿšš Replacements

  • REPLACE_PACKAGE_NAME: name of the package (usually the same name as the repository in which it's hosted).
  • REPLACE_PACKAGE_DESCRIPTION: description of the package.
  • REPLACE_FULL_NAME: user's full name.
  • REPLACE_EMAIL: user's email.
  • REPLACE_GITHUB_USERNAME: GitHub username of the package owner.

About

๐ŸŽˆ A Python package template using pyproject.toml, hatch, pre-commit, black, ruff, and mkdocs.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published