Metadata-Version: 2.4
Name: nbprint-example-plugin
Version: 0.2.0
Summary: Example hydra plugin for nbprint
Project-URL: Repository, https://github.com/nbprint/nbprint-example-plugin
Project-URL: Homepage, https://github.com/nbprint/nbprint-example-plugin
Author-email: the nbprint authors <3105306+timkpaine@users.noreply.github.com>
License: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.9
Requires-Dist: hydra-core
Requires-Dist: lerna>=1.1.0
Requires-Dist: nbprint
Provides-Extra: develop
Requires-Dist: build; extra == 'develop'
Requires-Dist: bump-my-version; extra == 'develop'
Requires-Dist: check-manifest; extra == 'develop'
Requires-Dist: hatchling; extra == 'develop'
Requires-Dist: pytest; extra == 'develop'
Requires-Dist: pytest-cov; extra == 'develop'
Requires-Dist: ruff; extra == 'develop'
Requires-Dist: twine; extra == 'develop'
Requires-Dist: wheel; extra == 'develop'
Description-Content-Type: text/markdown

# nbprint example plugin

Example hydra plugin for nbprint

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

## Overview

This project demonstrates a [Hydra SearchPathPlugin](https://hydra.cc/docs/advanced/plugins/overview/), with a simple example configuration of a `page`.

> [!WARNING]
>
> Plugins should always namespace their configuration to not conflict with other plugins!
> E.g. here we put our page configuration in `page/<plugin name>/default.yaml`
