Skip to main content

A tool for generating QR codes

Project description

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.

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

nomad_qr_codes-1.2.0.tar.gz (291.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nomad_qr_codes-1.2.0-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

Details for the file nomad_qr_codes-1.2.0.tar.gz.

File metadata

  • Download URL: nomad_qr_codes-1.2.0.tar.gz
  • Upload date:
  • Size: 291.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for nomad_qr_codes-1.2.0.tar.gz
Algorithm Hash digest
SHA256 ac5008ab95b208b9752d55ea1bab23fda70bf6415a648b95a0c2f23b4a13a59c
MD5 f1d02e5dde554d80261b4b423ba2e0a7
BLAKE2b-256 24fb9dcadf35c4a0a127a64e6a72da852469488b756adebeddb2c2ae1e3fc1b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for nomad_qr_codes-1.2.0.tar.gz:

Publisher: python-publish.yml on FAIRmat-NFDI/nomad-qr-codes

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nomad_qr_codes-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: nomad_qr_codes-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 16.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for nomad_qr_codes-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f4c24f5428ce14b5a71ca7fed59f08bd20efcfd7ff84a71c4cd991aebf9d6957
MD5 29948e2b67400c332e7850f646bcd4ca
BLAKE2b-256 5874d5a99e0de84a14e66f2a15ec8aa13305934a9ea3b6e3348b9e08f9ec8304

See more details on using hashes here.

Provenance

The following attestation bundles were made for nomad_qr_codes-1.2.0-py3-none-any.whl:

Publisher: python-publish.yml on FAIRmat-NFDI/nomad-qr-codes

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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