Skip to main content

An concise flask extension to render QR codes

Project description

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

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

![](QRcode.png)

## Installation

` pip install Flask-QRcode `

## Usage:

### Extend the app:

` from flask.ext.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. 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.

Source Distribution

Flask-QRcode-1.0.1.tar.gz (4.5 kB view details)

Uploaded Source

File details

Details for the file Flask-QRcode-1.0.1.tar.gz.

File metadata

  • Download URL: Flask-QRcode-1.0.1.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Flask-QRcode-1.0.1.tar.gz
Algorithm Hash digest
SHA256 88061af18ddb1ce565eed7dbededa46d1e4e46f3dd88f75b3a84288278ae9c1a
MD5 ecb2b321070ed7b6654d51df9952bf67
BLAKE2b-256 f582372bd751a07e7ddb26163a0d720d078a51f6be2c66b57872b26c38d21bf3

See more details on using hashes here.

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