1#
2# QR Code generator Distutils script (Python 2, 3)
3#
4# Copyright (c) Project Nayuki. (MIT License)
5# https://www.nayuki.io/page/qr-code-generator-library
6#
7# Permission is hereby granted, free of charge, to any person obtaining a copy of
8# this software and associated documentation files (the "Software"), to deal in
9# the Software without restriction, including without limitation the rights to
10# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11# the Software, and to permit persons to whom the Software is furnished to do so,
12# subject to the following conditions:
13# - The above copyright notice and this permission notice shall be included in
14#   all copies or substantial portions of the Software.
15# - The Software is provided "as is", without warranty of any kind, express or
16#   implied, including but not limited to the warranties of merchantability,
17#   fitness for a particular purpose and noninfringement. In no event shall the
18#   authors or copyright holders be liable for any claim, damages or other
19#   liability, whether in an action of contract, tort or otherwise, arising from,
20#   out of or in connection with the Software or the use or other dealings in the
21#   Software.
22#
23
24import setuptools
25
26
27setuptools.setup(
28	name = "qrcodegen",
29	description = "High quality QR Code generator library for Python 2 and 3",
30	version = "1.5.0",
31	platforms = "OS Independent",
32	license = "MIT License",
33
34	author = "Project Nayuki",
35	author_email = "me@nayuki.io",
36	url = "https://www.nayuki.io/page/qr-code-generator-library",
37
38	classifiers = [
39		"Development Status :: 5 - Production/Stable",
40		"Intended Audience :: Developers",
41		"Intended Audience :: Information Technology",
42		"License :: OSI Approved :: MIT License",
43		"Operating System :: OS Independent",
44		"Programming Language :: Python",
45		"Programming Language :: Python :: 2",
46		"Programming Language :: Python :: 3",
47		"Topic :: Multimedia :: Graphics",
48		"Topic :: Software Development :: Libraries :: Python Modules",
49	],
50
51	long_description = """=========================
52QR Code generator library
53=========================
54
55
56Introduction
57------------
58
59This project aims to be the best, clearest QR Code generator library. The primary goals are flexible options and absolute correctness. Secondary goals are compact implementation size and good documentation comments.
60
61Home page with live JavaScript demo, extensive descriptions, and competitor comparisons: https://www.nayuki.io/page/qr-code-generator-library
62
63
64Features
65--------
66
67Core features:
68
69* Available in 6 programming languages, all with nearly equal functionality: Java, TypeScript/JavaScript, Python, Rust, C++, C
70* Significantly shorter code but more documentation comments compared to competing libraries
71* Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard
72* Output formats: Raw modules/pixels of the QR symbol, SVG XML string
73* Encodes numeric and special-alphanumeric text in less space than general text
74* Open source code under the permissive MIT License
75
76Manual parameters:
77
78* User can specify minimum and maximum version numbers allowed, then library will automatically choose smallest version in the range that fits the data
79* User can specify mask pattern manually, otherwise library will automatically evaluate all 8 masks and select the optimal one
80* User can specify absolute error correction level, or allow the library to boost it if it doesn't increase the version number
81* User can create a list of data segments manually and add ECI segments
82
83
84Usage
85-----
86
87Install this package by downloading the source code ZIP file from PyPI_, or by running ``pip install qrcodegen``.
88
89Examples:
90
91::
92
93    from qrcodegen import *
94
95    # Simple operation
96    qr0 = QrCode.encode_text("Hello, world!", QrCode.Ecc.MEDIUM)
97    svg = qr0.to_svg_str(4)
98
99    # Manual operation
100    segs = QrSegment.make_segments("3141592653589793238462643383")
101    qr1 = QrCode.encode_segments(segs, QrCode.Ecc.HIGH, 5, 5, 2, False)
102    for y in range(qr1.get_size()):
103        for x in range(qr1.get_size()):
104            (... paint qr1.get_module(x, y) ...)
105
106More complete set of examples: https://github.com/nayuki/QR-Code-generator/blob/master/python/qrcodegen-demo.py .
107
108API documentation is in the source file itself, with a summary comment at the top: https://github.com/nayuki/QR-Code-generator/blob/master/python/qrcodegen.py .
109
110.. _PyPI: https://pypi.python.org/pypi/qrcodegen""",
111
112	py_modules = ["qrcodegen"],
113)
114