Skip to main content

A concise Flask extension to render QR codes on Jinja2 templates using python-qrcode

Project description

Flask-QRcode

PyPI version

A concise Flask extension to easily render QR codes on Jinja2 templates using python-qrcode

You can read the full documentation here.

Installation

pip install Flask-QRcode

Usage:

Extend the app:

from flask_qrcode import QRcode
# [...]
QRcode(app)
# [...]

Then use it within your templates:

Basic usage:

<img src="{{ qrcode(STRING_TO_ENCODE) }}">

More examples:

For more examples, just run the sample application in this repository.

Sample Application

Contributing:

Thank you for considering contributing to this package.

As this is a simple package, the process is pretty straightforward...

  1. Fork this repository
  2. Checkout from master with to a feature branch with a name related to what is being contributed (e.g. "colored-qrcodes")

*It's highly recommended that your contribution either creates a new feature, fixes something OR refactors the code and does not mix these (e.g. one PR fixing some existent feature and refactoring non-related code).

  1. Install dependencies and flask_qrcode on editable mode
    pip install -e .  # for installing flask_qrcode on editable mode
    
  2. Do your magic
  3. Provide new tests for your work and check that both this and the old ones are passing
  4. Pull Request!

Testing:

  1. Install dependencies and flask_qrcode on editable mode
pip install -e .  # for installing flask_qrcode on editable mode
  1. Run pytest
python setup.py test  # on package's root dir

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

Flask-QRcode-3.1.0.tar.gz (39.8 kB view hashes)

Uploaded Source

Built Distribution

Flask_QRcode-3.1.0-py3-none-any.whl (40.7 kB view hashes)

Uploaded Python 3

Supported by

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