whiteprints-template-context 0.6.0
Interpolate variables and set Copier Jinja context
Requires Python: <4.0,>=3.9
Keywords: Python

<!--
SPDX-FileCopyrightText: © 2024 The "Whiteprints template context" contributors <whiteprints@pm.me>

SPDX-License-Identifier: CC-BY-NC-SA-4.0
-->

# Whiteprints template context

![Whiteprints template context banner](https://raw.githubusercontent.com/whiteprints/whiteprints-template-context/refs/heads/main/docs/_static/banner.svg)
<div align="center">
    <p>
        <em>
            Interpolate variables and set Copier Jinja context
        </em>
    </p>
    <p>
        <a href="https://www.python.org"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/whiteprints-template-context.svg?logo=Python&logoColor=ffd43b"/></a>
        <a href="https://pypi.org/project/whiteprints-template-context"><img alt="PyPI - Project Version" src="https://img.shields.io/pypi/v/whiteprints-template-context.svg?logo=PyPI&logoColor=ffd43b"/></a>
        <a href="https://spdx.org/licenses/MIT"><img alt="license badge" src="https://img.shields.io/badge/📝_License-MIT-4CAF50.svg"/></a>
        <a href="https://github.com/whiteprints/whiteprints-template-context/discussions"><img alt="GitHub Discussions" src="https://img.shields.io/github/discussions/whiteprints/whiteprints-template-context.svg?logo=GitHub"></a>
        <a href="https://spdx.dev/learn/areas-of-interest/licensing/"><img alt="SPDX Licensing" src="https://img.shields.io/badge/SPDX-licensing-0080FF.svg?logo=SPDX"/></a>
        <a href="https://www.contributor-covenant.org/version/2/1/code_of_conduct/"><img alt="contributor covenant badge" src="https://img.shields.io/badge/Contributor_Covenant-2.1-4BAAAA.svg?logo=contributorcovenant"/></a>
        <a href="https://codecov.io/gh/whiteprints/whiteprints-template-context" ><img alt="codecov badge" src="https://codecov.io/gh/whiteprints/whiteprints-template-context/graph/badge.svg?token="/></a>
    </p>
</div>

## Table of contents

- [Background](#background)
- [Usage](#usage)
- [Install](#install)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [Licensing](#licensing)

## Background

This package is an internal dependencies of Whiteprints template. It uses
Jinja2 extentions to prepare [Copier](https://github.com/copier-org/copier).
It also defines useful Jinja filters.

## Usage

To activate the template just add the following to copier.yml:

```yaml
_jinja_extensions:
  - whiteprints_template_context.context.ContextUpdater
  - whiteprints_template_context.filters.WhiteprintsFilters
```

This will enhance copier's context with additional variables and filters that
are required by Whiteprints templates.

## Install

See [INSTALL.md](https://github.com/whiteprints/whiteprints-template-context/blob/main/INSTALL.md).

## Maintainers

See [MAINTAINERS.md](https://github.com/whiteprints/whiteprints-template-context/blob/main/MAINTAINERS.md).

## Contributing

See [CONTRIBUTING.md](https://github.com/whiteprints/whiteprints-template-context/blob/main/CONTRIBUTING.md).

## Licensing

The _[Python]_ **code** of this project is distributed under license [MIT](https://spdx.org/licenses/MIT).

In case of doubt, please check the [SPDX] header of each individual source code file.

[Python]: https://www.python.org/
[SPDX]: https://spdx.dev/
[REUSE]: https://reuse.software/