Skip to main content

regfmt

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] [-t {yaml,css,yamlcss}] [input]

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

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

options:
  -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
  -t {yaml,css,yamlcss}, --template {yaml,css,yamlcss}
                        Generate template YAML and/or CSS files

Metadata

Release files for regfmt 0.9.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for regfmt 0.9.1
File Size Uploaded Provenance Actions
regfmt-0.9.1.tar.gz 14.3 kB Without provenance Details for regfmt-0.9.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for regfmt 0.9.1
File Interpreter ABI Platform Actions
regfmt-0.9.1-py3-none-any.whl Python 3 none any Details for regfmt-0.9.1-py3-none-any.whl

Total release size: 38.2 kB

Release files / regfmt-0.9.1.tar.gz

Download URL regfmt-0.9.1.tar.gz
Size 14.3 kB
Tags Source
SHA-256 checksum
How to use checksums
3ff99eef442c1c9789aedd007813c97ebcdfdf2855b296904a73861ae7ba5287
BLAKE2b-256 checksum
How to use checksums
3fa79831439a2cc613d759dbc02034010098ebc52cd92274f85e876825315825
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.8

Release files / regfmt-0.9.1-py3-none-any.whl

Download URL regfmt-0.9.1-py3-none-any.whl
Size 23.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e4c155a3c9eb63b1e70b756302642be174d28ff4463625d5f745bc9e21dd2b26
BLAKE2b-256 checksum
How to use checksums
17e602d9007946e8e8e5624a140f86729aad1f1e087d9dde5e1ecdd9d2d18439
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.8

Security for regfmt 0.9.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page