Release 1.1.0

heuer · Aug 5, 2020 · 74f804f · 74f804f
2 parents 1539343 + 6bd3a89
commit 74f804f
Show file tree

Hide file tree

Showing 50 changed files with 732 additions and 341 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,2 @@
+*.py text eol=lf
+*.rst text eol=lf
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -3,24 +3,34 @@ Changes
 
 Versions follow `Semantic Versioning <https://semver.org/>`_.
 
+1.1.0 -- 2020-08-05
+-------------------
+* Support for `Hanzi <https://en.wikipedia.org/wiki/Chinese_characters>`_ mode,
+  implemented by `Shi Yan <https://github.com/neycyanshi>`_
+* Fixed `#81 <https://github.com/heuer/segno/issues/81>`_:
+  Wrong character count in Kanji mode if the user provided the QR code data
+  as bytes.
+* Improved documentation <https://segno.readthedocs.org/>
+* Improved API docs
+
 
 1.0.2 -- 2020-07-30
 -------------------
 * Fixed error in Kanji encoding: Data was incomplete.
-  Again, discovered by `neycyanshi <https://github.com/neycyanshi>`_)
+  Again, discovered by `Shi Yan <https://github.com/neycyanshi>`_)
 * Better test coverage for Kanji encoding
 
 
 1.0.1 -- 2020-07-28
 -------------------
 * Fixed wrong information about character count in Kanji mode
-  (discovered and fixed by `neycyanshi <https://github.com/neycyanshi>`_)
+  (discovered and fixed by `Shi Yan <https://github.com/neycyanshi>`_)
 * Fixed `#72 <https://github.com/heuer/segno/issues/72>`_:
   Encodings for ``helpers.make_epc_qr`` may be specified by name or
   by a numeric constant.
 * Added support for `Netpbm PPM <http://netpbm.sourceforge.net/doc/ppm.html>`_ images.
-* Documentation improvements (also thanks to James Addison for pr
-  `#73 <https://github.com/heuer/segno/pull/73>`_)
+* Documentation improvements (also thanks to `James Addison <https://github.com/jayaddison>`_
+  for pr`#73 <https://github.com/heuer/segno/pull/73>`_)
 * Removed "version" parameter from ``encoder.prepare_data`` (does not belong to
   the public API anyway)
 
@@ -55,7 +65,7 @@ Versions follow `Semantic Versioning <https://semver.org/>`_.
 
 0.3.9 -- 2020-01-19
 -------------------
-* Fixed `#71 <https://github.com/heuer/segno/issues/79>`_: Dark / light
+* Fixed `#71 <https://github.com/heuer/segno/issues/71>`_: Dark / light
   modules of the finder pattern may be interpreted wrong if set to ``None``
 * Removed segno.encoder, segno.writers and segno.utils from public API (fixes
   `#69 <https://github.com/heuer/segno/issues/69>`_)
@@ -65,7 +75,8 @@ Versions follow `Semantic Versioning <https://semver.org/>`_.
 
 0.3.8 -- 2020-01-15
 -------------------
-* Added support for multiple (more than two) colors to SVG (fixes #64)
+* Added support for multiple (more than two) colors to SVG
+  (fixes `#64 <https://github.com/heuer/segno/issues/64>`_)
 * Fixed several test cases
 * Removed ``QRCodeError`` and all derived exceptions from public API (still
   available but not thrown and they will be removed in 0.4.0)
@@ -75,7 +86,8 @@ Versions follow `Semantic Versioning <https://semver.org/>`_.
 0.3.7 -- 2020-01-09
 -------------------
 * Documentation improvements: Added several examples, fixed docs
-* Fixed #62: PNG serializer adds only those colors to the PLTE which are
+* Fixed `#62 <https://github.com/heuer/segno/issues/62>`_:
+  PNG serializer adds only those colors to the PLTE which are
   actually needed for the given (Micro) QR Code.
 * Minor performance improvements
 
@@ -173,7 +185,7 @@ Versions follow `Semantic Versioning <https://semver.org/>`_.
 0.3.2 -- 2019-07-15
 -------------------
 * Performance improvements
-* Added man page for the CLI (fixes #41)
+* Added man page for the CLI (fixes `#41 <https://github.com/heuer/segno/issues/41>`_)
 * Added more documentation and examples
 * Fixed missing charts of <https://segno.readthedocs.io/en/stable/comparison-qrcode-libs.html>
 * Added PyQRCodeNG <https://pypi.org/project/PyQRCodeNG/> to comparison table
@@ -299,7 +311,8 @@ Versions follow `Semantic Versioning <https://semver.org/>`_.
 * Command line script reports Segno's version (``--ver``) and the version
   is also mentioned in the help message (``-h``) (#24)
 * Support for creating email addresses or complete messages (``segno.helpers``)
-* Internal optimizations and more correct minimal version finding (#26)
+* Internal optimizations and more correct minimal version finding
+  (`#26 <https://github.com/heuer/segno/issues/26>`_)
 
 
 0.2.1 -- 2016-09-15
@@ -334,11 +347,12 @@ Versions follow `Semantic Versioning <https://semver.org/>`_.
 0.1.7 -- 2016-09-04
 -------------------
 * Changed API: Added a feature to increase the error correction level
-  if it fits. Disable this feature via ``boost_error=False`` (#16)
+  if it fits. Disable this feature via ``boost_error=False``
+  (`#16 <https://github.com/heuer/segno/issues/16>`_)
 * Added ``--no-error-boost`` to the command line script to disable error
   correction level incrementation (`#17 <https://github.com/heuer/segno/issues/17>`_)
 * Command line script: Internal changes and better test coverage
-* Added tests for issue #18
+* Added tests for issue `#18 <https://github.com/heuer/segno/issues/18>`_
 * Added PBM (P1 and P4) serialization.
 * Deprecated ``utils.matrix_with_border_iter``, use ``utils.matrix_iter``
 * ``utils.matrix_with_border_iter`` will be removed in the next release
@@ -360,11 +374,12 @@ Versions follow `Semantic Versioning <https://semver.org/>`_.
   generated (issue #14).
 * Better command line support:
 
-  - The command line script recognizes all SVG options (#9)
+  - The command line script recognizes all SVG options (`#9 <https://github.com/heuer/segno/issues/9>`_)
   - Added ``--mode``/``-m``, renamed ``--mask``/``-m`` to ``--pattern``/``-p``
     (issue #10)
   - The script used an empty string as default value for the data to encode.
-    The data to encode has no default value anymore (issue #11)
+    The data to encode has no default value anymore
+    (issue `#11 <https://github.com/heuer/segno/issues/11>`_)
   - Added ``--no-ad`` to omit the comment ``Software`` in PNG images
     (issue #12)
 

diff --git a/docs/_static/64-micro.png b/docs/_static/64-micro.png
diff --git a/docs/_static/64.png b/docs/_static/64.png
diff --git a/docs/_static/RAIN.png b/docs/_static/RAIN.png
diff --git a/docs/_static/REVOLUTION9-micro.png b/docs/_static/REVOLUTION9-micro.png
diff --git a/docs/_static/REVOLUTION9.png b/docs/_static/REVOLUTION9.png
diff --git a/docs/_static/chart_create_1m.svg b/docs/_static/chart_create_1m.svg
diff --git a/docs/_static/chart_create_30h.svg b/docs/_static/chart_create_30h.svg
diff --git a/docs/_static/chart_create_7q.svg b/docs/_static/chart_create_7q.svg
diff --git a/docs/_static/chart_png.svg b/docs/_static/chart_png.svg
diff --git a/docs/_static/chart_svg.svg b/docs/_static/chart_svg.svg
diff --git a/docs/_static/hanzi-byte.png b/docs/_static/hanzi-byte.png
diff --git a/docs/_static/hanzi-hanzi.png b/docs/_static/hanzi-hanzi.png
diff --git a/docs/_static/kanji-micro.png b/docs/_static/kanji-micro.png
diff --git a/docs/_static/kanji-qr.png b/docs/_static/kanji-qr.png
diff --git a/docs/_static/let-it-be.png b/docs/_static/let-it-be.png
diff --git a/docs/_static/revolution9-byte.png b/docs/_static/revolution9-byte.png
diff --git a/docs/_static/tomorrow-never-knows.png b/docs/_static/tomorrow-never-knows.png
diff --git a/docs/boost-error-correction-level.rst b/docs/boost-error-correction-level.rst
@@ -31,14 +31,14 @@ Keeping the default (boost error level on)::
     >>> qr.designator
     '2-M'
 
-Segno returns a 2-M QR Code (version 2, error correction level "M").
+Segno returns a 2-M QR code (version 2, error correction level "M").
 
 .. image:: _static/boost_example1.svg
-    :alt: 2-M QR Code encoding 'The Long and Winding Road'
+    :alt: 2-M QR code encoding 'The Long and Winding Road'
 
 
 If the user does not allow any enhancement of the error correction level, Segno
-returns a 2-L QR Code (version 2, error correction level "L") which does not
+returns a 2-L QR code (version 2, error correction level "L") which does not
 optimally exploit the possible error corrections::
 
     >>> import segno

diff --git a/docs/colorful-qrcodes.rst b/docs/colorful-qrcodes.rst
@@ -2,7 +2,7 @@ Colorful QR Codes
 =================
 
 Almost all serializers support custom settings for the color of the dark and
-light modules of a (Micro) QR Code.
+light modules of a (Micro) QR code.
 
 The color values can be provided as tuple ``(R, G, B)``, as web color name
 (like 'red') or as hexadecimal ``#RRGGBB`` value (i.e. '#085A75'). If alpha
@@ -34,7 +34,7 @@ type may have its own color.
                 data_light='yellow')
 
 .. image:: _static/colorful/yellow-submarine.png
-    :alt: Colorful 7-H QR Code encoding "Yellow Submarine"
+    :alt: Colorful 7-H QR code encoding "Yellow Submarine"
 
 
 .. code-block:: python
@@ -44,7 +44,7 @@ type may have its own color.
     >>> mqr.save('rain.png', scale=4, dark='darkblue', data_dark='steelblue')
 
 .. image:: _static/colorful/rain.png
-    :alt: Colorful M4-Q QR Code encoding "RAIN"
+    :alt: Colorful M4-Q QR code encoding "RAIN"
 
 
 Module names
@@ -68,7 +68,7 @@ Sets the (default) color of dark modules.
     :alt: Picture showing the dark modules
 
 .. image:: _static/colorful/mqr_dark.png
-    :alt: Picture showing the dark modules of a Micro QR Code
+    :alt: Picture showing the dark modules of a Micro QR code
 
 
 light / :option:`--light <segno --light>`
@@ -80,7 +80,7 @@ Sets the (default) color of light modules.
     :alt: Picture showing the light modules
 
 .. image:: _static/colorful/mqr_light.png
-    :alt: Picture showing the light modules of a Micro QR Code
+    :alt: Picture showing the light modules of a Micro QR code
 
 
 alignment_dark / :option:`--align-dark <segno --align-dark>`
@@ -94,7 +94,7 @@ Micro QR Codes don't have alignment patterns.
     :alt: Picture showing the dark alignment modules
 
 .. image:: _static/colorful/mqr_alignment_dark.png
-    :alt: Picture showing the dark alignment modules of a Micro QR Code (None)
+    :alt: Picture showing the dark alignment modules of a Micro QR code (none)
 
 
 alignment_light / :option:`--align-light <segno --align-light>`
@@ -108,7 +108,7 @@ Micro QR Codes don't have alignment patterns.
     :alt: Picture showing the light alignment modules
 
 .. image:: _static/colorful/mqr_alignment_light.png
-    :alt: Picture showing the light alignment modules of a Micro QR Code (None)
+    :alt: Picture showing the light alignment modules of a Micro QR code (none)
 
 
 dark_module / :option:`--dark-module <segno --dark-module>`
@@ -122,7 +122,7 @@ Micro QR Codes don't have a dark module.
     :alt: Picture showing the dark modules
 
 .. image:: _static/colorful/mqr_dark_module.png
-    :alt: Picture showing the dark modules of a Micro QR Code (None)
+    :alt: Picture showing the dark modules of a Micro QR code (none)
 
 
 data_dark / :option:`--data-dark <segno --data-dark>`
@@ -134,7 +134,7 @@ Sets the color of the dark data modules.
     :alt: Picture showing the dark data modules
 
 .. image:: _static/colorful/mqr_data_dark.png
-    :alt: Picture showing the dark data modules of a Micro QR Code
+    :alt: Picture showing the dark data modules of a Micro QR code
 
 
 data_light / :option:`--data-light <segno --data-light>`
@@ -146,7 +146,7 @@ Sets the color of the light data modules.
     :alt: Picture showing the light modules
 
 .. image:: _static/colorful/mqr_data_light.png
-    :alt: Picture showing the light modules of a Micro QR Code
+    :alt: Picture showing the light modules of a Micro QR code
 
 
 finder_dark / :option:`--finder-dark <segno --finder-dark>`
@@ -158,7 +158,7 @@ Sets the color of the dark modules of the finder pattern.
     :alt: Picture showing the dark finder modules
 
 .. image:: _static/colorful/mqr_finder_dark.png
-    :alt: Picture showing the dark finder modules of a Micro QR Code
+    :alt: Picture showing the dark finder modules of a Micro QR code
 
 
 finder_light / :option:`--finder-light <segno --finder-light>`
@@ -170,7 +170,7 @@ Sets the color of the light modules of the finder pattern.
     :alt: Picture showing the light finder modules
 
 .. image:: _static/colorful/mqr_finder_light.png
-    :alt: Picture showing the light finder modules of a Micro QR Code
+    :alt: Picture showing the light finder modules of a Micro QR code
 
 
 format_dark / :option:`--format-dark <segno --format-dark>`
@@ -182,7 +182,7 @@ Sets the color of the dark modules of the format information.
     :alt: Picture showing the dark format information modules
 
 .. image:: _static/colorful/mqr_format_dark.png
-    :alt: Picture showing the dark format information modules of a Micro QR Code (None)
+    :alt: Picture showing the dark format information modules of a Micro QR code (none)
 
 
 format_light / :option:`--format-light <segno --format-light>`
@@ -194,7 +194,7 @@ Sets the color of the light modules of the format information.
     :alt: Picture showing the light format information modules
 
 .. image:: _static/colorful/mqr_format_light.png
-    :alt: Picture showing the light format information modules of a Micro QR Code (None)
+    :alt: Picture showing the light format information modules of a Micro QR code (none)
 
 
 quiet_zone / :option:`--quiet-zone <segno --quiet-zone>`
@@ -206,7 +206,7 @@ Sets the color of the quiet zone.
     :alt: Picture showing the quiet zone
 
 .. image:: _static/colorful/mqr_quiet_zone.png
-    :alt: Picture showing the quiet zone of a Micro QR Code
+    :alt: Picture showing the quiet zone of a Micro QR code
 
 
 separator / :option:`--separator <segno --separator>`
@@ -218,7 +218,7 @@ Sets the color of the separator.
     :alt: Picture showing the separator
 
 .. image:: _static/colorful/mqr_separator.png
-    :alt: Picture showing the separator of a Micro QR Code
+    :alt: Picture showing the separator of a Micro QR code
 
 
 timing_dark / :option:`--timing-dark <segno --timing-dark>`
@@ -230,7 +230,7 @@ Sets the color of the dark modules of the timing pattern.
     :alt: Picture showing the dark timing pattern modules
 
 .. image:: _static/colorful/mqr_timing_dark.png
-    :alt: Picture showing the dark timing pattern modules of a Micro QR Code
+    :alt: Picture showing the dark timing pattern modules of a Micro QR code
 
 
 timing_light / :option:`--timing-light <segno --timing-light>`
@@ -242,7 +242,7 @@ Sets the color of the light modules of the timing pattern.
     :alt: Picture showing the light timing pattern modules
 
 .. image:: _static/colorful/mqr_timing_light.png
-    :alt: Picture showing the light timing pattern modules of a Micro QR Code
+    :alt: Picture showing the light timing pattern modules of a Micro QR code
 
 
 version_dark / :option:`--version-dark <segno --version-dark>`
@@ -256,7 +256,7 @@ Micro QR Codes and QR Codes lesser than version 7 don't carry any version inform
     :alt: Picture showing the dark version modules
 
 .. image:: _static/colorful/mqr_version_dark.png
-    :alt: Picture showing the dark version modules of a Micro QR Code (None)
+    :alt: Picture showing the dark version modules of a Micro QR code (none)
 
 
 version_light / :option:`--version-light <segno --version-light>`
@@ -270,4 +270,4 @@ Micro QR Codes and QR Codes lesser than version 7 don't carry any version inform
     :alt: Picture showing the light version modules
 
 .. image:: _static/colorful/mqr_version_light.png
-    :alt: Picture showing the light version modules of a Micro QR Code (None)
+    :alt: Picture showing the light version modules of a Micro QR code (none)