https://github.com/ofek/hatch-showcase

A project showcasing features and plugins for Hatch
https://github.com/ofek/hatch-showcase

example hatch plugin python

Last synced: 5 months ago
JSON representation

A project showcasing features and plugins for Hatch

• Host: GitHub
• URL: https://github.com/ofek/hatch-showcase
• Owner: ofek
• License: mit
• Created: 2021-12-30T05:57:04.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-05-12T14:31:20.000Z (over 2 years ago)
• Last Synced: 2025-07-14T15:08:40.327Z (6 months ago)
• Topics: example, hatch, plugin, python
• Language: Python
• Homepage:
• Size: 37.1 KB
• Stars: 28
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# hatch-showcase

| | |

| --- | --- |

| CI/CD | [![CI - Test](https://github.com/ofek/hatch-showcase/actions/workflows/test.yml/badge.svg)](https://github.com/ofek/hatch-showcase/actions/workflows/test.yml) [![CD - Build](https://github.com/ofek/hatch-showcase/actions/workflows/build.yml/badge.svg)](https://github.com/ofek/hatch-showcase/actions/workflows/build.yml) |

| Package | [![PyPI - Version](https://img.shields.io/pypi/v/hatch-showcase.svg?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.org/project/hatch-showcase/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hatch-showcase.svg?logo=python&label=Python&logoColor=gold)](https://pypi.org/project/hatch-showcase/) |

| Meta | [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![code style - black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/ambv/black) [![License - MIT](https://img.shields.io/badge/license-MIT-9400d3.svg)](https://spdx.org/licenses/) [![GitHub Sponsors](https://img.shields.io/github/sponsors/ofek?logo=GitHub%20Sponsors&style=social)](https://github.com/sponsors/ofek) |

-----

This project is meant to showcase various features and plugins for [Hatch](https://github.com/pypa/hatch) as well as providing a place to test experimental functionality.

**Table of Contents**

- [Installation](#installation)

- [Version source](#version-source)

- [Environments](#environments)

- [Build](#build)

- [License](#license)

## Installation

```console

pip install hatch-showcase

```

## Version source

- The [hatch-vcs](https://github.com/ofek/hatch-vcs) version source plugin determines the project version using Git tags

## Environments

- Defined neatly in a standalone [`hatch.toml`](https://hatch.pypa.io/latest/intro/#configuration)

- The `test` matrix uses the [hatch-containers](https://github.com/ofek/hatch-containers) plugin to run each environment inside Docker containers; usage can be seen in the [test](.github/workflows/test.yml) GitHub workflow

## Build

- All build targets use the [hatch-vcs](https://github.com/ofek/hatch-vcs) build hook plugin to ship a `_version.py` file so the version can be used at runtime

- Wheels use the [hatch-mypyc](https://github.com/ofek/hatch-mypyc) build hook plugin to first compile all code with [Mypyc](https://github.com/mypyc/mypyc)

- The [build](.github/workflows/build.yml) GitHub workflow shows how to:

  - use [cibuildwheel](https://github.com/pypa/cibuildwheel) to distribute binary wheels for every platform

  - use the [app](https://hatch.pypa.io/latest/plugins/builder/app/) build target to build standalone distributions for every platform

## License

`hatch-showcase` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.