Metadata-Version: 2.5
Name: supervisor-pydantic
Version: 1.4.2
Summary: Pydantic models for supervisor
Project-URL: Repository, https://github.com/airflow-laminar/supervisor-pydantic
Project-URL: Homepage, https://github.com/airflow-laminar/supervisor-pydantic
Author-email: the supervisor-pydantic authors <t.paine154@gmail.com>
License: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.11
Requires-Dist: colorlog
Requires-Dist: hydra-core
Requires-Dist: jinja2
Requires-Dist: omegaconf
Requires-Dist: pydantic>=2
Requires-Dist: rich
Requires-Dist: typer
Provides-Extra: develop
Requires-Dist: build; extra == 'develop'
Requires-Dist: bump-my-version; extra == 'develop'
Requires-Dist: check-dist; extra == 'develop'
Requires-Dist: codespell; extra == 'develop'
Requires-Dist: hatchling; extra == 'develop'
Requires-Dist: mdformat; extra == 'develop'
Requires-Dist: mdformat-tables>=1; extra == 'develop'
Requires-Dist: pytest; extra == 'develop'
Requires-Dist: pytest-cov; extra == 'develop'
Requires-Dist: ruff; extra == 'develop'
Requires-Dist: supervisor; extra == 'develop'
Requires-Dist: twine; extra == 'develop'
Requires-Dist: ty; extra == 'develop'
Requires-Dist: uv; extra == 'develop'
Requires-Dist: wheel; extra == 'develop'
Description-Content-Type: text/markdown

# supervisor-pydantic

Typed, YAML-friendly models and lifecycle tools for supervisord.

[![Build Status](https://github.com/airflow-laminar/supervisor-pydantic/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/airflow-laminar/supervisor-pydantic/actions/workflows/build.yaml)
[![codecov](https://codecov.io/gh/airflow-laminar/supervisor-pydantic/branch/main/graph/badge.svg)](https://codecov.io/gh/airflow-laminar/supervisor-pydantic)
[![License](https://img.shields.io/github/license/airflow-laminar/supervisor-pydantic)](https://github.com/airflow-laminar/supervisor-pydantic)
[![PyPI](https://img.shields.io/pypi/v/supervisor-pydantic.svg)](https://pypi.python.org/pypi/supervisor-pydantic)

```python
from supervisor_pydantic import ProgramConfiguration, SupervisorConvenienceConfiguration

config = SupervisorConvenienceConfiguration(
    working_dir="/tmp/example-supervisor",
    program={
        "worker": ProgramConfiguration(command="python worker.py"),
    },
)

print(config.to_cfg())
```

The package models supervisord configuration sections, renders
`supervisord.conf`, loads Hydra/YAML configuration, exposes an XML-RPC client,
and provides the `_supervisor_convenience` lifecycle CLI.

## Documentation

- [Tutorial: render a supervisord configuration](docs/src/tutorial.md)
- [How-to guides](docs/src/how-to.md)
- [Why the convenience layer exists](docs/src/explanation.md)
- [API reference](docs/src/api.md)

Published documentation is available at
[airflow-laminar.github.io/supervisor-pydantic](https://airflow-laminar.github.io/supervisor-pydantic/).

## Ecosystem

- [systemd-pydantic](https://github.com/airflow-laminar/systemd-pydantic) provides aligned models for systemd services and timers.
- [cron-pydantic](https://github.com/airflow-laminar/cron-pydantic) models traditional crontabs.
- [airflow-supervisor](https://github.com/airflow-laminar/airflow-supervisor) orchestrates these configurations from Airflow.
- [airflow-systemd](https://github.com/airflow-laminar/airflow-systemd) and [airflow-cron](https://github.com/airflow-laminar/airflow-cron) provide alternative Airflow integrations.
- [airflow-pydantic](https://github.com/airflow-laminar/airflow-pydantic) supplies declarative Airflow models.
- [airflow-config](https://github.com/airflow-laminar/airflow-config) loads YAML-based Airflow configurations.

> [!NOTE]
> This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).
