Skip to main content

A command line utility to generate SVG diagrams for control register-style data formats.

Project description

regfmt

This project is a work in progress.

regfmt is a command line utility to generate SVG diagrams for control register-style data formats. It is inspired by the dformat command from the troff family of tools, however re-imagined using contemporary (circa 2022) file formats.

Example output SVG:

example svg

Features

  • SVG output
  • Modern configuration input file formats
    • YAML for register configuration
    • CSS for styling SVG output

Usage

usage: regfmt [-h] [-v] [-o OUTPUT] [-s STYLE] [input]

regfmt - generate SVG diagrams of control register-style data formats

positional arguments:
  input                 input register format YAML file (default: input.yaml)

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         print version information and exit
  -o OUTPUT, --output OUTPUT
                        output file (default: '-' for stdout)
  -s STYLE, --style STYLE
                        CSS style file

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

regfmt-0.1.10a1.tar.gz (14.6 kB view hashes)

Uploaded Source

Built Distribution

regfmt-0.1.10a1-py3-none-any.whl (24.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page