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

A Python package template based on Hatch, pre-commit, Ruff, and mkdocs
https://github.com/aazuspan/python-package-template

Last synced: 10 months ago
JSON representation

A Python package template based on Hatch, pre-commit, Ruff, and mkdocs

• Host: GitHub
• URL: https://github.com/aazuspan/python-package-template
• Owner: aazuspan
• License: mit
• Created: 2024-03-18T19:03:33.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-22T01:05:59.000Z (over 1 year ago)
• Last Synced: 2025-01-21T03:41:21.170Z (12 months ago)
• Language: Python
• Homepage:
• Size: 7.81 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![PyPI version](https://badge.fury.io/py/PACKAGE_NAME.svg)](https://badge.fury.io/py/PACKAGE_NAME)

[![Conda-Forge version](https://img.shields.io/conda/vn/conda-forge/PACKAGE_NAME)](https://anaconda.org/conda-forge/PACKAGE_NAME)

[![Build status](https://github.com/GITHUB_USERNAME/PACKAGE_NAME/actions/workflows/ci.yaml/badge.svg)](https://github.com/GITHUB_USERNAME/PACKAGE_NAME/actions/workflows/ci.yaml)

[![Documentation Status](https://readthedocs.org/projects/PACKAGE_NAME/badge/?version=latest)](https://PACKAGE_NAME.readthedocs.io/en/latest/?badge=latest)

A Python package template.

- Building, publishing, and development environment managed by [Hatch](https://hatch.pypa.io/latest/)

- Linting and formatting by [Ruff](https://docs.astral.sh/ruff/) (via [pre-commit](https://pre-commit.com/))

- Type checking by [mypy](https://mypy-lang.org/)

- CI by [Github Actions](https://github.com/features/actions)

- Docs by [mkdocs](https://www.mkdocs.org/), hosted on [ReadTheDocs](https://about.readthedocs.com/)

- MIT licensed

## Setup

1. Run `rm -rf .git && git init` to replace the template Git history with a new Git project.

2. Run `python -m init` to set package metadata. Afterwards, the script can be deleted.

3. Modify package dependencies and other settings in `pyproject.toml`.

4. Replace `src/.../main.py`, `tests/test_template.py`, and `docs/pages/api/main.md` with your package.

## Developing

See CONTRIBUTING.md for development instructions.