Metadata-Version: 2.4
Name: pyrig-containers
Version: 3.2.0
Summary: A pyrig plugin to integrate containers.
Keywords: pyrig
Author: Winipedia
License-Expression: MIT
License-File: LICENSE
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
Classifier: Typing :: Typed
Requires-Dist: pyrig>=18.3.4
Requires-Dist: pyrig-runtime>=3.5.2
Maintainer: Winipedia
Requires-Python: >=3.12
Project-URL: Homepage, https://github.com/Winipedia/pyrig-containers
Project-URL: Documentation, https://Winipedia.github.io/pyrig-containers
Project-URL: Source, https://github.com/Winipedia/pyrig-containers
Project-URL: Issues, https://github.com/Winipedia/pyrig-containers/issues
Project-URL: Changelog, https://github.com/Winipedia/pyrig-containers/releases
Description-Content-Type: text/markdown

## Overview

pyrig-containers is a [pyrig](https://github.com/Winipedia/pyrig) plugin that
packages your project as a container image and publishes it on every release.

## What it adds

- **Containerfile** — a ready-to-use `Containerfile` generated at the project
  root.
- **Container tooling** — wrappers for the container engine (Podman) and the
  GitHub Container Registry, each contributing a badge.
- **Automatic publishing** — a deploy step that builds the image and pushes it
  to the registry after a successful release.

## Usage

```bash
uv add pyrig-containers --dev
uv run pyrig sync
```

Building images locally requires Podman to be installed.

## Documentation

Full documentation, including the auto-generated API reference, is available on
the [documentation site](https://Winipedia.github.io/pyrig-containers).
