Commit 70806f6a authored by PizZaKatZe's avatar PizZaKatZe

Add README.md

parent e3d5082e
# Junghackertag flyer generator
A Python module that reads information about self-organized sessions for kids from the congress
wiki and turns it into a PDF using
* Jinja2
* LaTeX
and black magic.
## Requirements
To use this module, you need at least:
* Python 3
* [latex](https://pypi.org/project/latex)
* LaTeX
* [koma-script](https://www.ctan.org/pkg/koma-script)
* [qrcode](https://www.ctan.org/pkg/qrcode)
## CLI
For convenience and testing purposes, a simple CLI is included:
```
usage: jht_flyergen [-h] [-p PRINT] (-u [URL] | -f PATH) [output]
positional arguments:
output path to output file; if omitted raw PDF data is
written to stdout
optional arguments:
-h, --help show this help message and exit
-p PRINT, --print PRINT
print filtered data of session with index PRINT,
starting at 1; 0 prints all sessions
data sources:
-u [URL], --url [URL]
URL to fetch JSON data from; if URL is omitted, a
hard-coded URL returning test data is used
-f PATH, --file PATH path to file containing JSON data
```
## Templates
At the moment the module uses a bundled, "hard-coded" [LaTeX template](jht_flyergen/template.tex).
Maybe support for custom templates will be added once the thing works as expected and was tested
successfully at 36C3.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment