Skip to main content

A tool for generating QR codes

Project description

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

With uv (recommended)

uv sync

With pip

pip install .

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-0.1.1.tar.gz (120.5 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-0.1.1-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nomad_qr_codes-0.1.1.tar.gz
  • Upload date:
  • Size: 120.5 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-0.1.1.tar.gz
Algorithm Hash digest
SHA256 4c92dc70fbd51f2b88c6f8d602e90fb224aab369da30ce70a24d0148528d4927
MD5 a802d65da8d181ab04e73dfcff430c57
BLAKE2b-256 c7148ad9a94d1bf0eba45e9709148b8168d33e4c96ee23f236b0825994e2bb4b

See more details on using hashes here.

Provenance

The following attestation bundles were made for nomad_qr_codes-0.1.1.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-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: nomad_qr_codes-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 15.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-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a0167ed67d90622ee8eadd8c4fe2c9bdad8781d15ebedac8a39f465f34743d70
MD5 cfabc30562c372e27c14d1e8f5208295
BLAKE2b-256 dab5f1efcf3ed6ec1fdc10593d6ef02c74bfdc74c1be95b7039b19d33d8ede05

See more details on using hashes here.

Provenance

The following attestation bundles were made for nomad_qr_codes-0.1.1-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