Release 0.3.8

heuer · Jan 15, 2020 · 562f021 · 562f021
2 parents a864c78 + e196886
commit 562f021
Show file tree

Hide file tree

Showing 37 changed files with 1,028 additions and 697 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,6 +1,14 @@
 Changes
 =======
 
+0.3.8 -- 2020-01-15
+-------------------
+* Added support for multiple (more than two) colors to SVG (fixes #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)
+* Documentation improvements
+
 
 0.3.7 -- 2020-01-09
 -------------------

diff --git a/README.rst b/README.rst
@@ -135,7 +135,7 @@ Micro QR Codes (or raises an error if the content is too large for a Micro QR Co
     >>> mqr = segno.make_micro('Nick Cave and the Bad Seeds')
     Traceback (most recent call last):
         ...
-    DataOverflowError: Data too large. No Micro QR Code can handle the provided data
+    ValueError: Data too large. No Micro QR Code can handle the provided data
 
 
 All factory functions use the same parameters to specify the desired error

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/svg/penny-lane-optimized.svg b/docs/_static/svg/penny-lane-optimized.svg
diff --git a/docs/_static/svg/penny-lane.svg b/docs/_static/svg/penny-lane.svg
diff --git a/docs/colorful-qrcodes.rst b/docs/colorful-qrcodes.rst
@@ -22,8 +22,8 @@ default value (dark modules are rendered in black, light modules in white).
 .. note:: Providing an alpha channel to a serializer which does not accept an
     alpha channel results usually into an error.
 
-The PNG serializer supports more than two colors, every module type may have
-its own color.
+The SVG and PNG serializers support more than two colors, every module type may
+have its own color.
 
 .. code-block:: python
 
@@ -54,12 +54,13 @@ The following examples show the results of all supported module types.
 The unaffected modules are rendered as grey or white modules, the red modules
 show the usage of the keyword.
 
-The keywords "dark" and "light" are supported by almost all serialization
+The keywords "dark" and "light" (at the command line  :option:`--dark <segno --dark>`
+and :option:`--light <segno --light>`) are supported by almost all serialization
 formats.
 
 
-dark
-~~~~
+dark / :option:`--dark <segno --dark>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the (default) color of dark modules.
 
@@ -70,8 +71,8 @@ Sets the (default) color of dark modules.
     :alt: Picture showing the dark modules of a Micro QR Code
 
 
-light
-~~~~~
+light / :option:`--light <segno --light>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the (default) color of light modules.
 
@@ -82,8 +83,8 @@ Sets the (default) color of light modules.
     :alt: Picture showing the light modules of a Micro QR Code
 
 
-alignment_dark
-~~~~~~~~~~~~~~
+alignment_dark / :option:`--align-dark <segno --align-dark>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the color of the dark alignment pattern modules.
 
@@ -96,8 +97,8 @@ Micro QR Codes don't have alignment patterns.
     :alt: Picture showing the dark alignment modules of a Micro QR Code (None)
 
 
-alignment_light
-~~~~~~~~~~~~~~~
+alignment_light / :option:`--align-light <segno --align-light>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the color of the light alignment pattern modules.
 
@@ -110,8 +111,8 @@ Micro QR Codes don't have alignment patterns.
     :alt: Picture showing the light alignment modules of a Micro QR Code (None)
 
 
-dark_module
-~~~~~~~~~~~
+dark_module / :option:`--dark-module <segno --dark-module>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the color of the dark module.
 
@@ -124,8 +125,8 @@ Micro QR Codes don't have a dark module.
     :alt: Picture showing the dark modules of a Micro QR Code (None)
 
 
-data_dark
-~~~~~~~~~
+data_dark / :option:`--data-dark <segno --data-dark>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the color of the dark data modules.
 
@@ -136,8 +137,8 @@ Sets the color of the dark data modules.
     :alt: Picture showing the dark data modules of a Micro QR Code
 
 
-data_light
-~~~~~~~~~~
+data_light / :option:`--data-light <segno --data-light>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the color of the light data modules.
 
@@ -148,8 +149,8 @@ Sets the color of the light data modules.
     :alt: Picture showing the light modules of a Micro QR Code
 
 
-finder_dark
-~~~~~~~~~~~
+finder_dark / :option:`--finder-dark <segno --finder-dark>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the color of the dark modules of the finder pattern.
 
@@ -160,8 +161,8 @@ Sets the color of the dark modules of the finder pattern.
     :alt: Picture showing the dark finder modules of a Micro QR Code
 
 
-finder_light
-~~~~~~~~~~~~
+finder_light / :option:`--finder-light <segno --finder-light>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the color of the light modules of the finder pattern.
 
@@ -172,8 +173,8 @@ Sets the color of the light modules of the finder pattern.
     :alt: Picture showing the light finder modules of a Micro QR Code
 
 
-format_dark
-~~~~~~~~~~~
+format_dark / :option:`--format-dark <segno --format-dark>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the color of the dark modules of the format information.
 
@@ -184,8 +185,8 @@ Sets the color of the dark modules of the format information.
     :alt: Picture showing the dark format information modules of a Micro QR Code (None)
 
 
-format_light
-~~~~~~~~~~~~
+format_light / :option:`--format-light <segno --format-light>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the color of the light modules of the format information.
 
@@ -196,8 +197,8 @@ Sets the color of the light modules of the format information.
     :alt: Picture showing the light format information modules of a Micro QR Code (None)
 
 
-quiet_zone
-~~~~~~~~~~
+quiet_zone / :option:`--quiet-zone <segno --quiet-zone>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the color of the quiet zone.
 
@@ -208,8 +209,8 @@ Sets the color of the quiet zone.
     :alt: Picture showing the quiet zone of a Micro QR Code
 
 
-separator
-~~~~~~~~~
+separator / :option:`--separator <segno --separator>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the color of the separator.
 
@@ -220,8 +221,8 @@ Sets the color of the separator.
     :alt: Picture showing the separator of a Micro QR Code
 
 
-timing_dark
-~~~~~~~~~~~
+timing_dark / :option:`--timing-dark <segno --timing-dark>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the color of the dark modules of the timing pattern.
 
@@ -232,8 +233,8 @@ Sets the color of the dark modules of the timing pattern.
     :alt: Picture showing the dark timing pattern modules of a Micro QR Code
 
 
-timing_light
-~~~~~~~~~~~~
+timing_light / :option:`--timing-light <segno --timing-light>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the color of the light modules of the timing pattern.
 
@@ -244,8 +245,8 @@ Sets the color of the light modules of the timing pattern.
     :alt: Picture showing the light timing pattern modules of a Micro QR Code
 
 
-version_dark
-~~~~~~~~~~~~
+version_dark / :option:`--version-dark <segno --version-dark>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the color of the dark modules of the version information.
 
@@ -258,8 +259,8 @@ Micro QR Codes and QR Codes lesser than version 7 don't carry any version inform
     :alt: Picture showing the dark version modules of a Micro QR Code (None)
 
 
-version_light
-~~~~~~~~~~~~~
+version_light / :option:`--version-light <segno --version-light>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Sets the color of the light modules of the version information.
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -18,6 +18,7 @@ Contents:
     boost-error-correction-level
     serializers
     colorful-qrcodes
+    svg-options
     special-qrcode-factories
     contact-information
     epc-qrcodes

diff --git a/docs/make.rst b/docs/make.rst
@@ -69,7 +69,7 @@ of QR Codes or Micro QR Codes: :py:func:`segno.make_qr` for QR Codes and
     '1-Q'
 
 
-If the provided content is too large, a :py:class:`segno.DataOverflowError` is thrown:
+If the provided content is too large, a :py:exc:`ValueError` is thrown:
 
 
 .. code-block:: python
@@ -78,7 +78,7 @@ If the provided content is too large, a :py:class:`segno.DataOverflowError` is t
     >>> qr = segno.make_micro('The Curse of Millhaven')
     Traceback (most recent call last):
         ...
-    DataOverflowError: Data too large. No Micro QR Code can handle the provided data
+    ValueError: Data too large. No Micro QR Code can handle the provided data