Skip to main content

Publish to PyPI PyPI version License

NOMAD QR Codes

Generate branded QR codes (PNG or SVG) with rounded dots, styled finder eyelets, and an embedded center logo:

NOMAD QR code NOMAD QR code

The package installs a CLI command:

  • nomad-qr-codes

Installation

Install from PyPI:

pip install nomad-qr-codes

If you prefer uv:

uv pip install nomad-qr-codes

For editable local development:

pip install -e .

Quick Start

Generate a QR code using the default preset and transparent background:

uv run nomad-qr-codes "https://nomad-lab.eu"

This creates:

  • generated-nomad-qr.png

CLI Usage

nomad-qr-codes DATA [OPTIONS]

Required argument

  • DATA: URL or text to encode.

Example:

nomad-qr-codes "https://nomad-lab.eu"

Options

  • --preset {default,dark,oasis,dtu}
    • Selects preset colors and bundled logo.
    • Default: default
  • --output PATH
    • Output file path.
    • Default: generated-nomad-qr.png
  • --logo PATH
    • Use a custom center logo SVG instead of bundled logos.
  • --color HEX
    • Override QR foreground color (example: #192E87).
  • --eyelet-color HEX
    • Override finder eyelet color.
  • --format {png,svg}
    • Output format.
    • If omitted, inferred from output file extension.
  • --white-background
    • Enables white page background and white logo backing.
    • Without this flag, background is transparent.

Examples

Generate transparent PNG with default preset:

uv run nomad-qr-codes "https://nomad-lab.eu"

Generate white-background PNG:

uv run nomad-qr-codes "https://nomad-lab.eu" --white-background

Generate SVG output:

uv run nomad-qr-codes "https://nomad-lab.eu" --format svg --output nomad-qr.svg

Use oasis preset:

uv run nomad-qr-codes "https://nomad-lab.eu" --preset oasis

Use custom colors:

uv run nomad-qr-codes "https://nomad-lab.eu" --color "#0B1E4D" --eyelet-color "#22A06B"

Use a custom logo:

uv run nomad-qr-codes "https://nomad-lab.eu" --logo ./my-logo.svg

Presets

  • default: NOMAD default palette
  • dark: NOMAD dark palette
  • oasis: Oasis palette
  • dtu: DTU red palette

Bundled logos are packaged with the Python package under src/nomad_qr_codes/assets/logos.

Notes

  • For best scanning reliability, keep high contrast between foreground and background.
  • Very large center logos can hurt scan performance.
  • SVG output is ideal when you need scalable print assets.

Metadata

Release files for nomad-qr-codes 1.2.0

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

Source distribution (sdist)

Source distribution for nomad-qr-codes 1.2.0
File Size Uploaded
nomad_qr_codes-1.2.0.tar.gz 291.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nomad-qr-codes 1.2.0
File Interpreter ABI Platform
nomad_qr_codes-1.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 307.9 kB

Release files / nomad_qr_codes-1.2.0.tar.gz

Download URL nomad_qr_codes-1.2.0.tar.gz
Size 291.9 kB
Tags Source
SHA-256 checksum
How to use checksums
ac5008ab95b208b9752d55ea1bab23fda70bf6415a648b95a0c2f23b4a13a59c
BLAKE2b-256 checksum
How to use checksums
24fb9dcadf35c4a0a127a64e6a72da852469488b756adebeddb2c2ae1e3fc1b1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 16, 2026.

Transparency log

Release files / nomad_qr_codes-1.2.0-py3-none-any.whl

Download URL nomad_qr_codes-1.2.0-py3-none-any.whl
Size 16.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f4c24f5428ce14b5a71ca7fed59f08bd20efcfd7ff84a71c4cd991aebf9d6957
BLAKE2b-256 checksum
How to use checksums
5874d5a99e0de84a14e66f2a15ec8aa13305934a9ea3b6e3348b9e08f9ec8304
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 16, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

1.2.0 This release

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.1.1

2 release files

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