A reusable Django app for QR Code generation
Project description
Django QRCode Generator
Welcome to Django QRCode Generator : A sleek, reusable Django app that creates stunning, customizable QR codes on the fly. With advanced styling options like rounded modules and radial gradients, you can generate QR codes that are not only functional but also visually appealing.
✨ Features
- Dynamic Generation: Instantly generate QR codes for any text or URL.
- Advanced Styling: Beautiful QR codes with rounded modules and gradient colors.
- Plug-and-Play: Seamlessly integrate with any Django project.
- Custom Template Tag: Easily embed QR codes in your templates using
{% qrcode_url %}. - Responsive UI: A simple frontend interface for quick testing and demos.
🚀 Installation
Install the package directly from PyPI:
pip install django-qrcode
⚡ Quick Start
1. Add to Installed Apps
In your Django project's settings.py, add QrCode to your INSTALLED_APPS:
INSTALLED_APPS = [
# ... your other apps
"QrCode",
]
2. Include URL Configuration
Update your main urls.py file to include the QRCode app URLs:
from django.urls import include, path
urlpatterns = [
# ... your other URL patterns
path("qrcode/", include("QrCode.urls", namespace="qrcode")),
]
3. Embed QR Code in Templates
Use the custom template tag to render a QR code in your template:
{% load qrcode_tags %}
<img src="{% qrcode_url 'https://example.com' %}" alt="QR Code">
4. Try the Demo Frontend
Navigate to the QRCode app’s homepage to see a live demo:
http://<your-domain>/qrcode/
🛠 Development & Testing
Clone the repository and set up your development environment:
git clone https://github.com/yourusername/TagGenerator.git
cd TagGenerator
pip install -r requirements.txt
pip install -e .
Run tests with:
python manage.py test
And enjoy continuous integration with our GitHub Actions workflow!
🚢 Publishing to PyPI
To release a new version:
-
Tag the Release:
git tag v1.0.0 git push --tags
-
Build the Distribution:
python setup.py sdist bdist_wheel
-
Upload with Twine:
twine upload dist/*
📄 License
This project is licensed under the MIT License. See the LICENSE file for details.
🤝 Contributing
Contributions are welcome! If you'd like to enhance this project, please check the issues and submit a pull request.
🙏 Acknowledgements
- Built with Django and qrcode.
- Inspired by the need for beautiful and integrated QR code solutions in Django.
Happy Coding! 🎉
Project details
Release history Release notifications | RSS feed
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 taggenerator-1.0.0.tar.gz.
File metadata
- Download URL: taggenerator-1.0.0.tar.gz
- Upload date:
- Size: 4.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
19f45c1f3dc8a3c922f3df6acb27bececd577e6192e1117883741eb21538d79a
|
|
| MD5 |
21ee6f5a1b32ea910806e62d4a9cdab9
|
|
| BLAKE2b-256 |
64bf38a4f980e8d646cd6bcf2f4060e42624993622724ecd5066237e92b9a51b
|
Provenance
The following attestation bundles were made for taggenerator-1.0.0.tar.gz:
Publisher:
python-publish.yml on DadaNanjesha/TagGenerator
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
taggenerator-1.0.0.tar.gz -
Subject digest:
19f45c1f3dc8a3c922f3df6acb27bececd577e6192e1117883741eb21538d79a - Sigstore transparency entry: 179106242
- Sigstore integration time:
-
Permalink:
DadaNanjesha/TagGenerator@bcef84cf9850b3d532ca56cf2d241b95309608a9 -
Branch / Tag:
refs/tags/1.0.2 - Owner: https://github.com/DadaNanjesha
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@bcef84cf9850b3d532ca56cf2d241b95309608a9 -
Trigger Event:
release
-
Statement type:
File details
Details for the file taggenerator-1.0.0-py3-none-any.whl.
File metadata
- Download URL: taggenerator-1.0.0-py3-none-any.whl
- Upload date:
- Size: 5.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1449ed8581c3c0bf8d31bf4bc52530190897eeccbffc4c426a4f7c3c367d4e8b
|
|
| MD5 |
37b7d4f2a949b96da553dfc924baa180
|
|
| BLAKE2b-256 |
dc800e3a18b8a1dd287c17efb6445b24f4b30419b81dd512fe272ee67e1f0f56
|
Provenance
The following attestation bundles were made for taggenerator-1.0.0-py3-none-any.whl:
Publisher:
python-publish.yml on DadaNanjesha/TagGenerator
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
taggenerator-1.0.0-py3-none-any.whl -
Subject digest:
1449ed8581c3c0bf8d31bf4bc52530190897eeccbffc4c426a4f7c3c367d4e8b - Sigstore transparency entry: 179106243
- Sigstore integration time:
-
Permalink:
DadaNanjesha/TagGenerator@bcef84cf9850b3d532ca56cf2d241b95309608a9 -
Branch / Tag:
refs/tags/1.0.2 - Owner: https://github.com/DadaNanjesha
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@bcef84cf9850b3d532ca56cf2d241b95309608a9 -
Trigger Event:
release
-
Statement type: