Skip to main content

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

Project description

[![PyPI version](https://badge.fury.io/py/Flask-QRcode.svg)](https://badge.fury.io/py/Flask-QRcode)

> A concise Flask extension to easily render QR codes on Jinja2 templates using [python-qrcode](https://github.com/lincolnloop/python-qrcode)

You can read the [full documentation here](https://marcoagner.github.io/Flask-QRcode/).

![](QRcode.png)

## 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](https://github.com/marcoagner/Flask-QRcode/tree/master/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 ` 2. 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.

Filename, size & hash SHA256 hash help File type Python version Upload date
Flask-QRcode-2.0.2.tar.gz (4.7 kB) Copy SHA256 hash SHA256 Source None Mar 28, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page