liblaf-tangerine 0.4.3
🍊 Squeeze dynamic content into your files with Tangerine's template magic.
Requires Python: >=3.12

<div align="center" markdown><a name="readme-top"></a>

![tangerine](https://socialify.git.ci/liblaf/tangerine/image?description=1&forks=1&issues=1&language=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2Fmicrosoft%2Ffluentui-emoji%2Frefs%2Fheads%2Fmain%2Fassets%2FTangerine%2F3D%2Ftangerine_3d.png&name=1&owner=1&pattern=Transparent&pulls=1&stargazers=1&theme=Auto)

**[Explore the docs »](https://liblaf.github.io/tangerine/)**

<!-- tangerine-start: badges/python.md -->

[![codecov](https://codecov.io/gh/liblaf/tangerine/graph/badge.svg)](https://codecov.io/gh/liblaf/tangerine)
[![MegaLinter](https://github.com/liblaf/tangerine/actions/workflows/mega-linter.yaml/badge.svg)](https://github.com/liblaf/tangerine/actions/workflows/mega-linter.yaml)
[![Test](https://github.com/liblaf/tangerine/actions/workflows/test.yaml/badge.svg)](https://github.com/liblaf/tangerine/actions/workflows/test.yaml)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/liblaf/tangerine/main.svg)](https://results.pre-commit.ci/latest/github/liblaf/tangerine/main)
[![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/liblaf/tangerine)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/liblaf-tangerine?logo=PyPI&label=Downloads)](https://pypi.org/project/liblaf-tangerine)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/liblaf-tangerine?logo=Python&label=Python)](https://pypi.org/project/liblaf-tangerine)
[![PyPI - Version](https://img.shields.io/pypi/v/liblaf-tangerine?logo=PyPI&label=PyPI)](https://pypi.org/project/liblaf-tangerine)

<!-- tangerine-end -->

[Changelog](https://github.com/liblaf/tangerine/blob/main/CHANGELOG.md) · [Report Bug](https://github.com/liblaf/tangerine/issues) · [Request Feature](https://github.com/liblaf/tangerine/issues)

![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)

</div>

## ✨ Features

- 🍊 **Dynamic Templates:** Embed live content in your files with Jinja2 templates that can pull data from GitHub, environment variables, and project configurations;
- ⚡ **Async Rendering:** Process multiple files concurrently with asynchronous template rendering for improved performance;
- 🔧 **Extensible Filters:** Customize output with built-in filters like emoji stripping and GitHub description fetching, plus support for custom Jinja2 filters;
- 📁 **Flexible Input/Output:** Process files in-place or stream content via stdin/stdout, making it ideal for both manual use and CI/CD pipelines;
- 🧩 **Template Discovery:** Automatically loads templates from both package resources and user-configured directories for easy customization;
- 🔍 **Git Integration:** Seamlessly reads Copier answers from Git repositories to provide context-aware template variables.

## 📦 Installation

To install `liblaf-tangerine`, run the following command:

```bash
uv add liblaf-tangerine
```

## ⌨️ Local Development

You can use Github Codespaces for online development:

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/liblaf/tangerine)

Or clone it for local development:

```bash
gh repo clone liblaf/tangerine
cd tangerine
mise run install
```

## 🤝 Contributing

Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues](https://github.com/liblaf/tangerine/issues) to get stuck in to show us what you're made of.

[![PR Welcome](https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge)](https://github.com/liblaf/tangerine/pulls)

[![Contributors](https://contrib.nn.ci/api?repo=liblaf/tangerine)](https://github.com/liblaf/tangerine/graphs/contributors)

## 🔗 More Fruits

<!-- tangerine-start: projects/fruits.md -->

- **[🍇 Grapes](https://github.com/liblaf/grapes)** - Supercharge your Python with rich logging, precise timing, and seamless serialization.
- **[🍉 Melon](https://github.com/liblaf/melon)** - A comprehensive Python library for 3D mesh processing with advanced I/O capabilities, proximity analysis, and integration with external mesh processing tools.
- **[🍊 Tangerine](https://github.com/liblaf/tangerine)** - Squeeze dynamic content into your files with Tangerine's template magic.
- **[🍋‍🟩 Lime](https://github.com/liblaf/lime)** - AI-powered Git commit assistant and repository documentation generator
- **[🍎 Apple](https://github.com/liblaf/apple)** - A JAX and Warp library for differentiable physics simulation, featuring elastic energy models and finite element methods.
- **[🍒 Cherries](https://github.com/liblaf/cherries)** - Sweet experiment tracking with Comet, DVC, and Git integration.
<!-- tangerine-end -->

---

#### 📝 License

Copyright © 2025 [liblaf](https://github.com/liblaf). <br />
This project is [MIT](https://github.com/liblaf/tangerine/blob/main/LICENSE) licensed.