Skip to content
artistic QR Code in Python (Animated GIF qr code)- Python 艺术二维码生成器 (GIF动态二维码、图片二维码)
Branch: master
Clone or download
sylnsfar Merge pull request #10 from northlandsnow/fix/keep-duration
keep duration with origin gif file
Latest commit 0d50b3e Nov 13, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
MyQR keep duration with origin gif file Oct 18, 2016
example update README Sep 5, 2016
.gitignore Recoded to be importable. Sep 11, 2016
LICENSE.md adjusted codes and distributed to PyPI Sep 9, 2016
README-cn.md fixed a problem about characters support Sep 22, 2016
README.md updated details Sep 22, 2016
myqr.py Recoded to be importable. Sep 11, 2016
requirements.txt added requirements.txt Sep 7, 2016

README.md

QR-Code

转到中文版

Overview

Python QR Code Generator

Generate common qr-code, artistic qr-code (black & white or colorized), animated qr-code (black & white or colorized).

Contents

Examples

Install

# via pip
pip(3) install myqr(or MyQR)

Usage

Terminal Way

(TIPS: If you haven't install MyQR, you should python(3) myqr.py instead of myqr blow.)

# summary
myqr 	Words
		[-v {1,2,3,...,40}]
		[-l {L,M,Q,H}]
        [-n output-filename]
		[-d output-directory]
		[-p picture_file]
		[-c]
		[-con contrast]
		[-bri brightness]

Common QR-Code

#1 Words
myqr https://github.com
  • Just input a URL or a sentence, then get your QR-Code named 'qrcode.png' in the current directory.

#2 -v, -l
myqr https://github.com -v 10 -l Q
  • The default size of QR-Code depends both on the numbers of words you input and the level, while the default level (Error Correction Level) is H (the highest).

  • Customize: If you want to control the size and the error-correction-level, use the -v and -l arguments.

    -v representing the length is from a minimum of 1 to a maximum of 40.

    -l representing the error correction level is one of L, M, Q and H, where L is the lowest level and H is the highest.

#3 -n, -d
myqr https://github.com   -n github_qr.jpg   -d .../paths/
  • The default output-filename is 'qrcode.png', while the default output-directory is current directory.

  • Customize: You can name the output-file and decide the output-directory. Notice that if the name is as same as a existing file, the old one will be deleted.

    -n representing the output-filename could be in the format one of .jpg.png.bmp.gif .

    -d means directory.

Artistic QR-Code

#1 -p
myqr https://github.com -p github.jpg
  • The -p is to combine the QR-Code with the following picture which is in the same directory as the program. The resulting picture is black and white by default.
#2 -c
myqr https://github.com -p github.jpg -c
  • The -c is to make the resulting picture colorized.

#3 -con, -bri
myqr https://github.com -p github.jpg [-c] -con 1.5 -bri 1.6
  • The -con flag changes the contrast of the picture - a low number corresponds to low contrast and a high number to high contrast. Default: 1.0.

  • The -bri flag changes the brightness and the parameter values work the same as those for -con. Default: 1.0.

Animated GIF QR-Code

The only difference from Artistic QR-Code mentioned above is that you should input an image file in the .gif format. The you can get your black-and-white or colorful qr-code. Remember that when you use -n to customize the output-filename, then the output-filename must end by .gif.

Import Way

# after installation
from MyQR import myqr
version, level, qr_name = myqr.run(
	words,
    version=1,
    level='H',
    picture=None,
    colorized=False,
    contrast=1.0,
    brightness=1.0,
    save_name=None,
    save_dir=os.getcwd()
	)

details about each parameter are as mentioned above

# help(myqr)
Positional parameter
   words: str

Optional parameters
   version: int, from 1 to 40
   level: str, just one of ('L','M','Q','H')
   picutre: str, a filename of a image
   colorized: bool
   constrast: float
   brightness: float
   save_name: str, the output filename like 'example.png'
   save_dir: str, the output directory

Tips

  • Use a nearly square picture instead of a rectangle one.

  • If the size of the picture is large, you should also choose a rightly large -v instead of using the default one.

  • If part of the picture is transparent, the qr code will look like:

    You can change the transparent layer to white, and then it will look like:

Supported Characters

  • Numbers: 0~9

  • Letters: a~z, A~Z

  • Common punctuations:

    · , . : ; + - * / \ ~ ! @ # $ % ^ & ` ' = < > [ ] ( ) ? _ { } | and  (space)

Dependencies

(TIPS: Without a installed MyQR, you should use pip install -r requirements.txt to ensure you have all dependencies.)

Environment

  • Linux, Python 3
  • Windows, Python 3
  • Mac, Python 3

License

  • GPLv3
You can’t perform that action at this time.