Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brooke-ec/poetry-templating
A plugin for poetry which lets you substitute text on build.
https://github.com/brooke-ec/poetry-templating
poetry poetry-plugin python
Last synced: 18 days ago
JSON representation
A plugin for poetry which lets you substitute text on build.
- Host: GitHub
- URL: https://github.com/brooke-ec/poetry-templating
- Owner: brooke-ec
- License: mit
- Created: 2023-10-22T00:55:07.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-10T11:38:50.000Z (6 months ago)
- Last Synced: 2024-10-17T15:34:57.079Z (28 days ago)
- Topics: poetry, poetry-plugin, python
- Language: Python
- Homepage: https://pypi.org/project/poetry-templating/
- Size: 142 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Templating Poetry Plugin
[](https://python-poetry.org/)
[
](https://pypi.org/project/poetry-templating/)
[](https://pypi.org/project/poetry-templating/)
[](https://coveralls.io/github/NimajnebEC/poetry-templating?branch=main)
[
](https://github.com/NimajnebEC/poetry-templating/actions)
A plugin for [Poetry](https://python-poetry.org/) which lets you substitute text on build. This plugin was created to allow you to keep a single source of truth for package wide properties such as version and author.
## Installation
The easiest way to install the plugin is via the [`self add`](https://python-poetry.org/docs/cli/#self-add) command of Poetry.
```
poetry self add poetry-templating
```
If you used `pipx` to install Poetry you can add the plugin via the `pipx inject` command.
```
pipx inject poetry poetry-templating
```
Otherwise, if you used `pip` to install Poetry you can add the plugin packages via the `pip install` command.
```
pip install poetry-templating
```
## Usage
Poetry Templating uses 'template slots' as placeholders and definitions for what they should be replaced with. Consider the following file:
```py
__version__ = "${pyproject.tool.poetry.version}"
```
When evaluated, the slot will be replaced with the `tool.poetry.version` property from `pyproject.toml`, for example:
```py
__version__ = "1.2.3"
```
Slots can also be used in conjunction with comments to add entire lines only present in the built package. This can be used with `# templating: delete` to significantly change functionality in the built package, for example:
```py
production = false # templating: delete
# ${"production = true"}
becomes
production = true
```
## Evaluating Templates
Poetry Templating will automatically evaluate template slots when building the package distributables with the `poetry build` command. You can also evaluate the project in-place by running the `poetry templating evaluate` command.
## Constructs
Poetry Templating features a number of constructs which can be used in template slots.
### Literal Construct
Denoted by quotes or double quotes, literal constructs simply replace the slot with the text within.
```
${"Hello World"}
becomes
Hello World
```
Template slots within literal constructs are also evaluated, allowing for basic string concatenation, for example:
```py
# ${"__version__ = ${pyproject.tool.poetry.version}"}
becomes
__version__ = "1.2.3"
```
### PyProject Construct
Allows you to refernce values from the package's `pyproject.toml` file.
```
${pyproject.tool.poetry.version}
${pyproject.tool.poetry.authors.0}
becomes
1.2.3
John Doe