ezgg-badge-generator/README.md
2026-04-06 17:29:28 +02:00

22 lines
1008 B
Markdown

### Step 1: Preparing configuration
Use the example configuration at `helpers/config.example.toml` to create a `config.toml` at the base of the repository.
It is important to adjust the database configuration as well as the `browser_path`. The script has only been tested with the Chrome browser.
The system running the script needs access to the database server, or a current local database instance must be running.
### Step 2: Install dependencies
Use `pip install -r requirements.txt` to install the requirements. The use of a venv is recommended.
### Step 3: Execute
Execute `ezgg_badge_generator.py`.
### Further
The `helpers/font_converter.py` can be used to convert a font (.otf) to Base64 in case the font needs to be changed in the future.
Just replace the base64 `src: url(data:font/ttf;base64,INSERT_BASE64_HERE) format('truetype');` string in `template/template_dynamic_name_size.svg`.
The diagram shows the process of the ezgg-badge-generator.
![activity diagram](activity_diagram.svg)