https://github.com/sgraaf/cookiecutter-python-package

A cookiecutter template for creating a new Python package
https://github.com/sgraaf/cookiecutter-python-package

Last synced: 15 days ago
JSON representation

A cookiecutter template for creating a new Python package

• Host: GitHub
• URL: https://github.com/sgraaf/cookiecutter-python-package
• Owner: sgraaf
• License: mit
• Created: 2022-11-06T19:32:26.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-24T19:35:31.000Z (5 months ago)
• Last Synced: 2024-06-24T21:27:58.975Z (5 months ago)
• Language: Python
• Size: 99.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cookiecutter-python-package

[![Supported Python Versions](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12-blue)](https://github.com/sgraaf/cookiecutter-python-package)

[![Nox](https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg)](https://github.com/wntrblm/nox)

[![Code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/format.json)](https://github.com/astral-sh/ruff)

[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

A [cookiecutter](https://cookiecutter.readthedocs.io/) template for creating a new Python package.

See https://github.com/sgraaf/cookiecutter-python-package-demo for a demo of this template.

## Usage

```sh

cookiecutter gh:sgraaf/cookiecutter-python-package

```

## Features

-   Linting with autofix (i.e. removing unused imports, formatting and Python syntax upgrades) with [ruff](https://beta.ruff.rs/docs/)

-   Code formatting with [ruff](https://beta.ruff.rs/docs/) and [Prettier](https://prettier.io/)

-   Static type-checking with [mypy](http://www.mypy-lang.org/)

-   Checks and fixes before every commit with [pre-commit](https://pre-commit.com/)

-   Testing with [pytest](https://docs.pytest.org/en/stable/index.html)

-   Project automation with [Nox](https://nox.thea.codes/en/stable/)

-   Continuous Integration with [GitHub Actions](https://github.com/features/actions) and [pre-commit.ci](https://pre-commit.ci/)

-   Automated version updates for GitHub Actions with [Dependabot](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot)

-   Documentation with [Sphinx](https://www.sphinx-doc.org/en/master/), [MyST](https://myst-parser.readthedocs.io/en/latest/), and [Read the Docs](https://readthedocs.org/) using the [Furo](https://pradyunsg.me/furo/) theme

-   Automated release builds and uploads to [PyPI](https://pypi.org/)

This template supports Python 3.8, 3.9, 3.10, 3.11 and 3.12.