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:
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nomad_qr_codes-1.0.0.tar.gz.
File metadata
- Download URL: nomad_qr_codes-1.0.0.tar.gz
- Upload date:
- Size: 120.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
95fceac720afd29a9782a888262b8a409b7a8e78013069123ccab80a7ada0dd7
|
|
| MD5 |
b02e87edd5ded245797238adb035fede
|
|
| BLAKE2b-256 |
d370e619feedf4faedfcb15b81975fd2e275a9c4e3483ef7c40c240f57de346a
|
Provenance
The following attestation bundles were made for nomad_qr_codes-1.0.0.tar.gz:
Publisher:
python-publish.yml on FAIRmat-NFDI/nomad-qr-codes
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
nomad_qr_codes-1.0.0.tar.gz -
Subject digest:
95fceac720afd29a9782a888262b8a409b7a8e78013069123ccab80a7ada0dd7 - Sigstore transparency entry: 1824403071
- Sigstore integration time:
-
Permalink:
FAIRmat-NFDI/nomad-qr-codes@84bb4eb93ad29845ca504be2a4af5920adfec35d -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/FAIRmat-NFDI
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@84bb4eb93ad29845ca504be2a4af5920adfec35d -
Trigger Event:
release
-
Statement type:
File details
Details for the file nomad_qr_codes-1.0.0-py3-none-any.whl.
File metadata
- Download URL: nomad_qr_codes-1.0.0-py3-none-any.whl
- Upload date:
- Size: 15.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f3fdf9b1c957862aea23fe456a6438173a193587e7c209dbd8373847ffaa86d1
|
|
| MD5 |
46f91a741669a17bdd875c2fb6d8dc0d
|
|
| BLAKE2b-256 |
5f653eaa59fa43931b11e6b6bd68a320f854c94c6cd9b9dc9c2870d20712fffc
|
Provenance
The following attestation bundles were made for nomad_qr_codes-1.0.0-py3-none-any.whl:
Publisher:
python-publish.yml on FAIRmat-NFDI/nomad-qr-codes
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
nomad_qr_codes-1.0.0-py3-none-any.whl -
Subject digest:
f3fdf9b1c957862aea23fe456a6438173a193587e7c209dbd8373847ffaa86d1 - Sigstore transparency entry: 1824403232
- Sigstore integration time:
-
Permalink:
FAIRmat-NFDI/nomad-qr-codes@84bb4eb93ad29845ca504be2a4af5920adfec35d -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/FAIRmat-NFDI
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@84bb4eb93ad29845ca504be2a4af5920adfec35d -
Trigger Event:
release
-
Statement type: