A dynamic image generator.

Last update: Jun 14, 2023

Overview

dynimgen

A dynamic image generator.

How to use

step 1: The designers export the design drawing as an svg file

<svg>
  <rect />
  <image src="img.png" /> 
  <image src="qr.png" />
  <text>66666</text>
</svg>

step 2: The engineers edit the svg file, replace the changed parts with template variables

<svg>
  <rect />
  <img src="{{ img | fetch }}">
  <img src="{{ qr | to_qr }}">
  <text>{{ code }}</text>
</svg>

step 3: Run dynimgen, make sure the svg template is in the dynimgen workdir

$ ls data/
Times New Roman.ttf   poster1.svg

$ dynimgen data/
[2022-06-05T14:51:53Z INFO  dynimgen::generator] Mount `/poster1`
[2022-06-05T14:51:53Z INFO  dynimgen] Listen on 0.0.0.0:8080

step 4: Build image url according to the following rules

<domain> + <template path> + ? + <template variables>

For example:

domain: http://localhost:8080
template path: /poster1
template variables: { img: "https://picsum.photos/250", qr: "dynimgen", code: 12345 }

Build url:

http://localhost:8080/poster1?img=https://picsum.photos/250&qr=dynimgen&code=12345

If you request this url, dynimgen will response a png image.

what dynimgen does:

Extract path and variables from the request
Pass variables to template engine to generate a svg
Render the svg to a png then response

Install

With cargo

cargo install dynimgen

With docker

docker run -v `pwd`/data:/data  -p 8080:8080 --rm -it sigoden/dynimgen /data

Binaries on macOS, Linux, Windows

Download from Github Releases, unzip and add duf to your $PATH.

Template Engine

dynimgen uses Tera as the template engine. It has a syntax based on Jinja2 and Django templates.

See the Tera Documentation for more information about control structures, built-ins filters, etc.

Custom built-in filters that dynimgen uses:

`fetch`

Fetch remote resource and encode as data-url

Example: {{ img | fetch }} {{ img | fetch(timeout=10000) }}

`to_qr`

Convert text to qrcode

Example: {{ qr | to_qr }} {{ qr | to_qr(bg='#fff', fg='#000') }}

License

dynimgen is made available under the terms of either the MIT License or the Apache License 2.0, at your option.

See the LICENSE-APACHE and LICENSE-MIT files for license details.

You might also like...

Universal changelog generator using conventional commit+ with monorepo support. Written in Rust.

chlog Universal changelog generator using conventional commit+ with monorepo support. chlog can generate the changelog from the conventional commits w

3 Nov 27, 2022

A simple, fast, easy README generator

Welcome to Readme Generator A simple, fast, easy README generator. Never worry about READMEs again! What it does: Run the command in your project's di

41 Nov 13, 2022

A simple quote-based code generator for Rust

flexgen A flexible, yet simple quote-based code generator for creating beautiful Rust code Why? Rust has two types of macros, and they are both very p

11 Oct 13, 2022

Flexible snowflake generator, reference snoyflake and leaf.

2 May 6, 2022

Quad-rand implements pseudo-random generator

quad-rand quad-rand implements pseudo-random generator based on rust atomics. Compatible with wasm and any oth

10 Feb 11, 2022

⚙️ A cute .gitignore generator with support for custom templates

Gign A Gitignore Generator Table of Contents Examples Install Custom templates Help Examples # This is how you going to use it probably most of the ti

6 Dec 7, 2022

Nexmark event generator in Rust.

Nexmark-rs The Nexmark benchmark data generator in Rust. Installation cargo install nexmark --features bin Usage Generate nexmark events. Print one pe

11 Nov 27, 2022

A code generator to reduce repetitive tasks and build high-quality Rust libraries. 🦀

LibMake A code generator to reduce repetitive tasks and build high-quality Rust libraries Welcome to libmake 👋 Website • Documentation • Report Bug •

27 Mar 12, 2023

waveplot is a VCD waveform generator for the terminal.

waveplot waveplot is a VCD waveform generator for the terminal. Installation (dev) Install the Rust compiler 'rustc' using rustup. curl --proto '=http