Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/albertomosconi/texrocket
a minimal LaTeX template engine. load data from JSON files and dynamically compile your documents
https://github.com/albertomosconi/texrocket
json latex latex-template python template template-engine
Last synced: 7 days ago
JSON representation
a minimal LaTeX template engine. load data from JSON files and dynamically compile your documents
- Host: GitHub
- URL: https://github.com/albertomosconi/texrocket
- Owner: albertomosconi
- License: gpl-3.0
- Archived: true
- Created: 2022-01-25T20:25:30.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-27T02:27:55.000Z (about 3 years ago)
- Last Synced: 2025-01-17T09:43:51.707Z (12 days ago)
- Topics: json, latex, latex-template, python, template, template-engine
- Language: Python
- Homepage: https://pypi.org/project/texrocket/
- Size: 195 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TexRocket
A basic template engine for LaTeX. Create dynamic documents by parsing JSON data and populating a custom template.
The script parses a template and fills it with data read from json files. Provide different json files to have multiple files with the same structure but varying content. **Especially useful for translations**.
## Requirements
Make sure you have the following programs installed on your system before moving forward.
- [python](https://www.python.org/ "python.org")
- LaTeX
## Installation
Easily install TexRocket by using `pip`
```shell
pip install texrocket
```
## Usage
At any time you can run the `texrocket` script with the `-h` or `--help` flag to display usage information
```
usage: texrocket [-h] [-i INPUT_JSON] [-o OUTPUT_DIR] [-v] input_tex
Dynamic LaTeX generation from JSON, developed by Alberto Mosconi
positional arguments:
input_tex the LaTeX template file
options:
-h, --help show this help message and exit
-i INPUT_JSON, --input-json INPUT_JSON
the JSON file or directory of files
-o OUTPUT_DIR, --output-dir OUTPUT_DIR
the directory for the output files
-v, --verbose print verbose output and save LaTeX logs
```
An example using all possible arguments is
```bash
texrocket TEMPLATE.tex -i input.json -o out/ -v
```
This will create an `out/` folder, with the documents generated using the `TEMPLATE.tex` template and the values inside `input.json`
```
out/
├── source/
│ └── TEMPLATE_input.tex
├── logs/
│ └── TEMPLATE_input.log
└── TEMPLATE_input.pdf
```
**! All the JSON files MUST have the same structure**, the engine will create multiple documents (one for each `.json` file) starting from `TEMPLATE.tex`.
The generated files have the following naming scheme
```
_.pdf
```
If the input JSON file is named `main.json` then this will not show up
```
.pdf
```
## Syntax
### Values
To display a certain JSON value reference it with the following syntax
```
```
```json
{
"section": {
"title": "The section title",
"text": "some text"
}
}
```
The example above will be rendered as `"The section title"`.
### Loops
You can avoid repetition of LaTeX code by using loops, which can be nested
```tex
\begin{itemize}
%startloop: first
\item
\begin{itemize}
%startloop: second
\item
%endloop
\end{itemize}
%endloop
\end{itemize}
```
```json
{
"first": [
{
"name": "first main list item",
"second": [
{ "name": "secondary list item" }
]
},
{
"name": "second main list item",
"second": [
{ "name": "secondary list item" }
]
}
]
}
```