https://github.com/alvarobartt/python-package-template

🎈 A Python package template using pyproject.toml, hatch, pre-commit, black, ruff, and mkdocs.
https://github.com/alvarobartt/python-package-template

black hatch mkdocs mkdocs-material pyproject-toml python-package ruff template

Last synced: 3 months ago
JSON representation

🎈 A Python package template using pyproject.toml, hatch, pre-commit, black, ruff, and mkdocs.

• Host: GitHub
• URL: https://github.com/alvarobartt/python-package-template
• Owner: alvarobartt
• License: mit
• Created: 2022-06-21T05:20:18.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-07T09:42:26.000Z (over 1 year ago)
• Last Synced: 2024-10-01T10:01:52.256Z (4 months ago)
• Topics: black, hatch, mkdocs, mkdocs-material, pyproject-toml, python-package, ruff, template
• Language: Python
• Homepage:
• Size: 568 KB
• Stars: 51
• Watchers: 2
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🎈 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.