Release 0.3.5

heuer · Jan 3, 2020 · b9adeb5 · b9adeb5
2 parents 8f28476 + f1a81bf
commit b9adeb5
Show file tree

Hide file tree

Showing 27 changed files with 475 additions and 113 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,6 +1,15 @@
 Changes
 =======
 
+0.3.5 -- 2020-01-03
+-------------------
+* Added support for colorful (more than two colors) QR Codes to the CLI script
+  (fixes #58).
+* Fixed Read the Docs build
+* Improved documentation
+* Minor perfomance and code improvements.
+
+
 0.3.4 -- 2020-01-02
 -------------------
 * Fixed issue #54: After last change (see 0.3.3), white background with transparent

diff --git a/README.rst b/README.rst
@@ -17,7 +17,7 @@ formats via a plugin architecture.
 Further, it provides several high level functions to create QR Codes which encode
 contact data (MeCard, vCard) or WIFI configurations.
 
-The project provides more than 1300 test cases (coverage >= 98%) to verify a
+The project provides more than 1400 test cases (coverage >= 98%) to verify a
 standard conform QR Code and Micro QR Code generation acc. to ISO/IEC 18004:2015(E).
 
 

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/cli_yellow-submarine.png b/docs/_static/cli_yellow-submarine.png
diff --git a/docs/_static/julia-02-01.png b/docs/_static/julia-02-01.png
diff --git a/docs/_static/julia-02-02.png b/docs/_static/julia-02-02.png
diff --git a/docs/_static/polythene-pam-03-01.png b/docs/_static/polythene-pam-03-01.png
diff --git a/docs/_static/polythene-pam-03-02.png b/docs/_static/polythene-pam-03-02.png
diff --git a/docs/_static/polythene-pam-03-03.png b/docs/_static/polythene-pam-03-03.png
diff --git a/docs/_static/sa_yellow-submarine-02-01.png b/docs/_static/sa_yellow-submarine-02-01.png
diff --git a/docs/_static/sa_yellow-submarine-02-02.png b/docs/_static/sa_yellow-submarine-02-02.png
diff --git a/docs/command-line.rst b/docs/command-line.rst
@@ -203,6 +203,14 @@ Change the foreground color to darkblue and background to yellow::
 If the serializer does not support :option:`--color <segno --color>` or
 :option:`--background <segno --background>`, these arguments are ignored.
 
+The PNG serializer supports more than two colors, each module type (finder pattern
+(dark / light), alignment pattern (dark / light) etc.) may have its own color::
+
+    $ segno --finder-dark darkred --format-dark darkred --version-dark darkred --data-dark darkorange --data-light yellow --timing-dark darkred --dark-module darkred --scale 5 -o yellow-submarine.png Yellow Submarine
+
+.. image:: _static/cli_yellow-submarine.png
+    :alt: QR Code "Yellow Submarine" colorful
+
 
 Structured Append
 -----------------
@@ -215,6 +223,35 @@ be provided. Additonally, either the QR Code :option:`--version <segno --version
 or the desired number of symbols (:option:`--symbol-count <segno --symbol-count>`) must be provided::
 
 
-    $ segno --seq -v 1 "Well you should see Polythene Pam"
-    $ segno --seq --symbol-count=2 "We all live in a yellow submarine"
-    $ segno --seq -sc 2 "Half of what I say is meaningless"
+    $ segno --seq -v 1 --scale 3 -o polythene-pam.png "Well you should see Polythene Pam"
+
+.. image:: _static/polythene-pam-03-01.png
+    :alt: 1st part of Structured Append code
+
+.. image:: _static/polythene-pam-03-02.png
+    :alt: 2nd part of Structured Append code
+
+.. image:: _static/polythene-pam-03-03.png
+    :alt: 3nd part of Structured Append code
+
+
+Specify the max. number of symbols::
+
+    $ segno --seq --symbol-count=2 -s 3 -o sa_yellow-submarine.png "We all live in a yellow submarine"
+
+.. image:: _static/sa_yellow-submarine-02-01.png
+    :alt: 1st part of Structured Append code
+
+.. image:: _static/sa_yellow-submarine-02-02.png
+    :alt: 2nd part of Structured Append code
+
+
+Shortcut to specify the number of symbols::
+
+    $ segno --seq -sc 2 -s 3 -o julia.png "Half of what I say is meaningless"
+
+.. image:: _static/julia-02-01.png
+    :alt: 1st part of Structured Append code
+
+.. image:: _static/julia-02-02.png
+    :alt: 2nd part of Structured Append code
diff --git a/docs/man/segno.rst b/docs/man/segno.rst
@@ -101,7 +101,7 @@ Command Line Options
 .. option:: --background BACKGROUND, -bg BACKGROUND
 
     Color of the light modules.
-    See :option:`--color` for a description of possible values.
+    See :option:`--color` for a description of allowed values.
     The standard background color is white.
 
 .. option:: --output OUTPUT, -o OUTPUT
@@ -171,6 +171,82 @@ Command Line Options
 
     Sets the DPI value of the PNG file
 
+.. option:: --finder-dark COLOR
+
+    Sets the color of the dark modules of the finder pattern.
+    See :option:`--color` for a description of allowed values.
+
+.. option:: --finder-light COLOR
+
+    Sets the color of the light modules of the finder pattern.
+    See :option:`--color` for a description of allowed values.
+
+.. option:: --separator COLOR
+
+    Sets the color of the separator.
+    See :option:`--color` for a description of allowed values.
+
+.. option:: --data-dark COLOR
+
+    Sets the color of the dark data modules.
+    See :option:`--color` for a description of allowed values.
+
+.. option:: --data-light COLOR
+
+    Sets the color of the light data modules.
+    See :option:`--color` for a description of allowed values.
+
+.. option:: --quiet-zone COLOR
+
+    Sets the color of the quiet zone (border).
+    See :option:`--color` for a description of allowed values.
+
+.. option:: --align-dark COLOR
+
+    Sets the color of the dark modules of the alignment patterns.
+    See :option:`--color` for a description of allowed values.
+
+.. option:: --align-light COLOR
+
+    Sets the color of the light modules of the alignment patterns.
+    See :option:`--color` for a description of allowed values.
+
+.. option:: --timing-dark COLOR
+
+    Sets the color of the dark modules of the timing pattern.
+    See :option:`--color` for a description of allowed values.
+
+.. option:: --timing-light COLOR
+
+    Sets the color of the light modules of the timing pattern.
+    See :option:`--color` for a description of allowed values.
+
+.. option:: --format-dark COLOR
+
+    Sets the color of the dark modules of the format information.
+    See :option:`--color` for a description of allowed values.
+
+.. option:: --format-light COLOR
+
+    Sets the color of the light modules of the format information.
+    See :option:`--color` for a description of allowed values.
+
+.. option:: --version-dark COLOR
+
+    Sets the color of the dark modules of the version information.
+    See :option:`--color` for a description of allowed values.
+
+.. option:: --version-light COLOR
+
+    Sets the color of the light modules of the version information.
+    See :option:`--color` for a description of allowed values.
+
+.. option:: --dark-module COLOR
+
+    Sets the color of the dark module.
+    See :option:`--color` for a description of allowed values.
+
+
 
 Exit Status
 -----------

diff --git a/man/segno.1 b/man/segno.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SEGNO" "1" "Dec 29, 2019" "" "Segno"
+.TH "SEGNO" "1" "Jan 03, 2020" "" "Segno"
 .SH NAME
 segno \- Segno QR Code encoder
 .
@@ -128,7 +128,7 @@ some support “transparent” as color value. The standard color is black.
 .TP
 .B \-\-background BACKGROUND, \-bg BACKGROUND
 Color of the light modules.
-See \fI\%\-\-color\fP for a description of possible values.
+See \fI\%\-\-color\fP for a description of allowed values.
 The standard background color is white.
 .UNINDENT
 .INDENT 0.0
@@ -207,6 +207,96 @@ PNG Options.INDENT 0.0
 .B \-\-dpi DPI
 Sets the DPI value of the PNG file
 .UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-finder\-dark COLOR
+Sets the color of the dark modules of the finder pattern.
+See \fI\%\-\-color\fP for a description of allowed values.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-finder\-light COLOR
+Sets the color of the light modules of the finder pattern.
+See \fI\%\-\-color\fP for a description of allowed values.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-separator COLOR
+Sets the color of the separator.
+See \fI\%\-\-color\fP for a description of allowed values.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-data\-dark COLOR
+Sets the color of the dark data modules.
+See \fI\%\-\-color\fP for a description of allowed values.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-data\-light COLOR
+Sets the color of the light data modules.
+See \fI\%\-\-color\fP for a description of allowed values.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-quiet\-zone COLOR
+Sets the color of the quiet zone (border).
+See \fI\%\-\-color\fP for a description of allowed values.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-align\-dark COLOR
+Sets the color of the dark modules of the alignment patterns.
+See \fI\%\-\-color\fP for a description of allowed values.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-align\-light COLOR
+Sets the color of the light modules of the alignment patterns.
+See \fI\%\-\-color\fP for a description of allowed values.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-timing\-dark COLOR
+Sets the color of the dark modules of the timing pattern.
+See \fI\%\-\-color\fP for a description of allowed values.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-timing\-light COLOR
+Sets the color of the light modules of the timing pattern.
+See \fI\%\-\-color\fP for a description of allowed values.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-format\-dark COLOR
+Sets the color of the dark modules of the format information.
+See \fI\%\-\-color\fP for a description of allowed values.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-format\-light COLOR
+Sets the color of the light modules of the format information.
+See \fI\%\-\-color\fP for a description of allowed values.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-version\-dark COLOR
+Sets the color of the dark modules of the version information.
+See \fI\%\-\-color\fP for a description of allowed values.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-version\-light COLOR
+Sets the color of the light modules of the version information.
+See \fI\%\-\-color\fP for a description of allowed values.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-dark\-module COLOR
+Sets the color of the dark module.
+See \fI\%\-\-color\fP for a description of allowed values.
+.UNINDENT
 .SH EXIT STATUS
 .sp
 \fBsegno\fP exits 0 on success, and >0 if an error occurs.
@@ -275,6 +365,6 @@ Saves the Micro QR Code (M2\-M) as PNG image, using the color #003399 for dark
 modules. Each module corresponds to 10 x 10 pixels because the scaling factor
 was set to a value of 10.
 .SH COPYRIGHT
-2016 - 2019 Lars Heuer -- "QR Code" and "Micro QR Code" are registered trademarks of DENSO WAVE INCORPORATED.
+2016 - 2020 Lars Heuer -- "QR Code" and "Micro QR Code" are registered trademarks of DENSO WAVE INCORPORATED.
 .\" Generated by docutils manpage writer.
 .