Merge branch 'release/0.3.1'

heuer · Jul 15, 2019 · 461562a · 461562a
2 parents 5590c35 + 82ec76e
commit 461562a
Show file tree

Hide file tree

Showing 69 changed files with 1,656 additions and 580 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,6 +1,20 @@
 Changes
 =======
 
+
+0.3.1 -- 2019-07-15
+-------------------
+* Performance improvements
+* Added man page for the CLI (fixes #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
+* Updated CSS for a better layout of tables with a lot of content
+* Removed deprecated functions ``encoder.score_n1``, ``encoder.score_n2``,
+  ``encoder.score_n3``, and ``encoder.score_n4`` (they didn't belong to the
+  public API anyway)
+
+
 0.3.0 -- 2019-06-25
 -------------------
 * Performance improvements (evaluation of mask scores)

diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2016 - 2018, Lars Heuer
+Copyright (c) 2016 - 2019, Lars Heuer
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

diff --git a/README.rst b/README.rst
@@ -12,11 +12,13 @@ Segno provides several serialization formats like Scalable Vector Graphics (SVG)
 Encapsulated PostScript (EPS), Portable Network Graphics (PNG),
 Portable Document Format (PDF), Portable Bitmap (PBM), Portable Arbitrary Map (PAM),
 LaTeX (PGF/TikZ), X PixMap (XBM), X Bitmap (XPM) or text output. None of these
-serializers require an external lib. Segno could provide more serialization
+serializers require an external lib. Segno can provide more serialization
 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 1000 test cases to verify a standard conform
+QR Code and Micro QR Code generation acc. to ISO/IEC 18004:2015(E).
 
 Installation
 ------------
@@ -51,7 +53,9 @@ Library
 .. code-block:: python
 
     >>> import segno
-    >>> qr = segno.make('Up Jumped the Devil')  # Let Segno choose the minimal version
+    >>> # Let Segno choose the minimal version and an optimal (maximal) error
+    >>> # level without changing the minimal version
+    >>> qr = segno.make('Up Jumped the Devil')
     >>> qr.is_micro
     False
     >>> qr.version

diff --git a/docs/_static/boost_example1.svg b/docs/_static/boost_example1.svg
diff --git a/docs/_static/boost_example2.svg b/docs/_static/boost_example2.svg
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/css/custom.css b/docs/_static/css/custom.css
@@ -0,0 +1,22 @@
+/* override table width restrictions */
+@media screen and (min-width: 767px) {
+
+   .wy-table-responsive table td {
+      /* !important prevents the common CSS stylesheets from overriding
+         this as on RTD they are loaded after this stylesheet */
+      white-space: normal !important;
+   }
+
+   .wy-table-responsive {
+      overflow: visible !important;
+   }
+}
+
+.feature_yes {
+   color: darkgreen;
+   font-weight: bolder;
+}
+
+.feature_no {
+   color: darkred;
+}
diff --git a/docs/_static/data_mask_mqr_0.svg b/docs/_static/data_mask_mqr_0.svg
diff --git a/docs/_static/data_mask_mqr_1.svg b/docs/_static/data_mask_mqr_1.svg
diff --git a/docs/_static/data_mask_mqr_2.svg b/docs/_static/data_mask_mqr_2.svg
diff --git a/docs/_static/data_mask_mqr_3.svg b/docs/_static/data_mask_mqr_3.svg
diff --git a/docs/_static/data_mask_qr_0.svg b/docs/_static/data_mask_qr_0.svg
diff --git a/docs/_static/data_mask_qr_1.svg b/docs/_static/data_mask_qr_1.svg
diff --git a/docs/_static/data_mask_qr_2.svg b/docs/_static/data_mask_qr_2.svg
diff --git a/docs/_static/data_mask_qr_3.svg b/docs/_static/data_mask_qr_3.svg
diff --git a/docs/_static/data_mask_qr_4.svg b/docs/_static/data_mask_qr_4.svg
diff --git a/docs/_static/data_mask_qr_5.svg b/docs/_static/data_mask_qr_5.svg
diff --git a/docs/_static/data_mask_qr_6.svg b/docs/_static/data_mask_qr_6.svg
diff --git a/docs/_static/data_mask_qr_7.svg b/docs/_static/data_mask_qr_7.svg
diff --git a/docs/_static/iso_fig1_1m.png b/docs/_static/iso_fig1_1m.png
diff --git a/docs/_static/iso_fig1_1m_pyqr.png b/docs/_static/iso_fig1_1m_pyqr.png
diff --git a/docs/_static/iso_fig1_1m_qrcode.png b/docs/_static/iso_fig1_1m_qrcode.png
diff --git a/docs/_static/iso_fig1_1m_segno.png b/docs/_static/iso_fig1_1m_segno.png
diff --git a/docs/_static/iso_fig2_m2l.png b/docs/_static/iso_fig2_m2l.png
diff --git a/docs/_static/iso_fig2_m2l_segno.png b/docs/_static/iso_fig2_m2l_segno.png
diff --git a/docs/_static/js/custom.js b/docs/_static/js/custom.js
@@ -0,0 +1,17 @@
+document.addEventListener('DOMContentLoaded', function(){
+    var x = document.getElementsByClassName("pylib-comparison");
+    if (x.length == 1) {
+        feature_table = x[0];
+        var cells = feature_table.getElementsByTagName("td");
+        for (var i = 0; i < cells.length; i++) {
+            var content = cells[i].innerHTML;
+            console.log(content);
+            if (content === "Yes") {
+                cells[i].classList.add('feature_yes')
+            }
+            else if (content == "No") {
+                cells[i].classList.add('feature_no')
+            }
+        }
+    }
+}, false);
diff --git a/docs/_static/structured_append_1_l-02-01.svg b/docs/_static/structured_append_1_l-02-01.svg
diff --git a/docs/_static/structured_append_1_l-02-02.svg b/docs/_static/structured_append_1_l-02-02.svg
diff --git a/docs/_static/structured_append_2_l.svg b/docs/_static/structured_append_2_l.svg
diff --git a/docs/_static/structured_append_example_2_2-L-04-01.svg b/docs/_static/structured_append_example_2_2-L-04-01.svg