Merge pull request #12 from daniel-tran/0.6.1

Version 0.6.1
daniel-tran · Sep 9, 2022 · 80e5d2a · 80e5d2a
2 parents 83ec54f + 1b57662
commit 80e5d2a
Show file tree

Hide file tree

Showing 12 changed files with 21 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Change Log
 
+## 0.6.1
+- Fixed an issue where the JSON file interface was writing Unicode characters incorrectly to output files
+
 ## 0.6.0
 - Added text searching functionality into Base Extractor
 - Added a dedicated area for experimental functionality and helper scripts

diff --git a/README.md b/README.md
@@ -172,7 +172,7 @@ Running the above code would produce a file called `Ecclesiastes.json` in the cu
 {
   "Ecclesiastes": {
     "1": {
-      "2": "\u00b2 \u201cMeaningless! Meaningless!\u201d\n    says the Teacher.\n\u201cUtterly meaningless!\n    Everything is meaningless.\u201d"
+      "2": "² “Meaningless! Meaningless!”\n    says the Teacher.\n“Utterly meaningless!\n    Everything is meaningless.”"
     }
   },
   "Info": {
@@ -221,7 +221,7 @@ Running the above code would produce a file called `Ecclesiastes.json` in the cu
 {
   "Ecclesiastes": {
     "1": {
-      "2": "\u00b2 \u201cMeaningless! Meaningless!\u201d\n    says the Teacher.\n\u201cUtterly meaningless!\n    Everything is meaningless.\u201d"
+      "2": "² “Meaningless! Meaningless!”\n    says the Teacher.\n“Utterly meaningless!\n    Everything is meaningless.”"
     }
   },
   "Info": {
@@ -478,10 +478,14 @@ If you notice any problems such as unhandled omitted passages or incorrect taggi
 
 ## Does this library provide support for the Apocrypha books?
 
-At the moment, you can use the Web Extractor's `search()` and `search_multiple()` functions to obtain passages from the Apocrypha books.
-There is currently no official support for the Apocrypha books in the other downloaders and extractors, at least until proper use cases can be identified.
+At the moment, you can use the Web Extractor's `search()`, `search_multiple()` and other related functions to obtain passages from the Apocrypha books.
+There is currently no official support for the Apocrypha books in the other downloaders and extractors, at least until the issues identified [here](https://github.com/daniel-tran/meaningless/pull/10#issuecomment-1236274786) become easier to work around.
 
 # Contributors
 - [daniel-tran](https://github.com/daniel-tran) (Creator & current maintainer)
 
 To make a contribution to this library, refer to `CONTRIBUTING.md`.
+
+# Disclaimer
+
+This library is not endorsed by nor affiliated with Bible Gateway or any of its partners.
diff --git a/VERSION.txt b/VERSION.txt
@@ -1 +1 @@
-0.6.0
+0.6.1
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.6.0',
+    VERSION: '0.6.1',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; Meaningless 0.6.0 documentation</title>
+    <title>Index &#8212; Meaningless 0.6.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/index.html b/docs/index.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>Meaningless - API Documentation &#8212; Meaningless 0.6.0 documentation</title>
+    <title>Meaningless - API Documentation &#8212; Meaningless 0.6.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/meaningless.html b/docs/meaningless.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>meaningless package &#8212; Meaningless 0.6.0 documentation</title>
+    <title>meaningless package &#8212; Meaningless 0.6.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/modules.html b/docs/modules.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>meaningless &#8212; Meaningless 0.6.0 documentation</title>
+    <title>meaningless &#8212; Meaningless 0.6.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Python Module Index &#8212; Meaningless 0.6.0 documentation</title>
+    <title>Python Module Index &#8212; Meaningless 0.6.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/search.html b/docs/search.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Search &#8212; Meaningless 0.6.0 documentation</title>
+    <title>Search &#8212; Meaningless 0.6.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
 

diff --git a/docs/utilities.html b/docs/utilities.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>meaningless.utilities package &#8212; Meaningless 0.6.0 documentation</title>
+    <title>meaningless.utilities package &#8212; Meaningless 0.6.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/meaningless/utilities/json_file_interface.py b/meaningless/utilities/json_file_interface.py
@@ -22,7 +22,7 @@ def write(data_file, document):
         os.makedirs(data_directory, exist_ok=True)
     # Use UTF-8 encoding to allow for Unicode characters to be written to the file
     with open(data_file, 'w', newline='', encoding='utf-8') as file:
-        json.dump(document, file, sort_keys=True, indent=2)
+        json.dump(document, file, sort_keys=True, indent=2, ensure_ascii=False)
     return 1