Merge pull request #27 from daniel-tran/1.3.0

Version 1.3.0

Author: daniel-tran

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 1.3.0
+- Added functionality to include minimal copyright information into the Base Extractor and Web Extractor
+- Added Bible Gateway translation-specific copyright URL to output files
+- Added translation support for: AMP, CSB, LSB, RSV
+
 ## 1.2.0
 - Fixed an issue where the YAML Extractor sometimes includes extra whitespace that is not present in the Web Extractor
 - Fixed an issue where the `output_as_list` flag in the Base Extractor would be modified when an error occurred while calling one of the text searching functions

CONTRIBUTING.md

@@ -111,6 +111,7 @@ This is the dictionary structure that is passed into `write` and returned from `
     }
   },
   "Info": {
+    "Copyright": "URL to the copyright information for this translation on Bible Gateway",
     "Language": "Translation Language",
     "Translation": "Translation Code",
     "Timestamp": "Timestamp in ISO 8601 format",

README.md

@@ -36,9 +36,11 @@ You can view the API documentation as static HTML documents from `docs\index.htm
 
 ## English
 
+- AMP
 - ASV
 - AKJV
 - BRG
+- CSB
 - EHV
 - ESV
 - ESVUK
@@ -49,6 +51,7 @@ You can view the API documentation as static HTML documents from `docs\index.htm
 - KJV
 - KJ21
 - LEB
+- LSB
 - MEV
 - NASB
 - NASB1995
@@ -62,6 +65,7 @@ You can view the API documentation as static HTML documents from `docs\index.htm
 - NOG
 - NRSV
 - NRSVUE
+- RSV
 - WEB
 - YLT
 
@@ -108,6 +112,7 @@ Ecclesiastes:
 Info:
   Language: English
   Translation: NIV
+  Copyright: https://www.biblegateway.com/versions/new-international-version-niv-bible/#copy
   Timestamp: '0000-00-00T00:00:00.000000+00:00'
   Meaningless: 0.0.0
 ```
@@ -154,6 +159,7 @@ Ecclesiastes:
 Info:
   Language: English
   Translation: NIV
+  Copyright: https://www.biblegateway.com/versions/new-international-version-niv-bible/#copy
   Timestamp: '0000-00-00T00:00:00.000000+00:00'
   Meaningless: 0.0.0
   Customised?: true
@@ -179,6 +185,7 @@ Running the above code would produce a file called `Ecclesiastes.json` in the cu
     }
   },
   "Info": {
+    "Copyright": "https://www.biblegateway.com/versions/new-international-version-niv-bible/#copy",
     "Language": "English",
     "Meaningless": "0.0.0",
     "Timestamp": "0000-00-00T00:00:00.000000+00:00",
@@ -230,6 +237,7 @@ Running the above code would produce a file called `Ecclesiastes.json` in the cu
     }
   },
   "Info": {
+    "Copyright": "https://www.biblegateway.com/versions/new-international-version-niv-bible/#copy",
     "Customised?": true,
     "Language": "English",
     "Meaningless": "0.0.0",
@@ -257,6 +265,7 @@ Running the above code would produce a file called `Ecclesiastes.xml` in the cur
   <info>
     <language>English</language>
     <translation>NIV</translation>
+    <copyright>https://www.biblegateway.com/versions/new-international-version-niv-bible/#copy</copyright>>
     <timestamp>0000-00-00T00:00:00.000000+00:00</timestamp>
     <meaningless>0.0.0</meaningless>
   </info>
@@ -312,6 +321,7 @@ Running the above code would produce a file called `Ecclesiastes.xml` in the cur
   <info>
     <language>English</language>
     <translation>NIV</translation>
+    <copyright>https://www.biblegateway.com/versions/new-international-version-niv-bible/#copy</copyright>
     <timestamp>0000-00-00T00:00:00.000000+00:00</timestamp>
     <meaningless>0.0.0</meaningless>
     <customised>true</customised>
@@ -342,11 +352,11 @@ Output:
 
 Running the above code would produce a file called `Ecclesiastes.csv` in the current working directory with the approximate contents:
 ```
-Book,Chapter,Passage,Text,Language,Translation,Timestamp,Meaningless
+Book,Chapter,Passage,Text,Language,Translation,Copyright,Timestamp,Meaningless
 Ecclesiastes,1,2,"² “Meaningless! Meaningless!”
     says the Teacher.
 “Utterly meaningless!
-    Everything is meaningless.”",English,NIV,0000-00-00T00:00:00.000000+00:00,0.0.0
+    Everything is meaningless.”",English,NIV,https://www.biblegateway.com/versions/new-international-version-niv-bible/#copy,0000-00-00T00:00:00.000000+00:00,0.0.0
 ```
 
 ## CSV Extractor
@@ -385,11 +395,11 @@ Output:
 
 Running the above code would produce a file called `Ecclesiastes.csv` in the current working directory with the approximate contents:
 ```
-Book,Chapter,Passage,Text,Language,Translation,Timestamp,Meaningless
+Book,Chapter,Passage,Text,Language,Translation,Copyright,Timestamp,Meaningless
 Ecclesiastes,1,2,"² “Meaningless! Meaningless!”
     says the Teacher.
 “Utterly meaningless!
-    Everything is meaningless.”",English (EN),NIV,0000-00-00T00:00:00.000000+00:00,0.0.0
+    Everything is meaningless.”",English (EN),NIV,https://www.biblegateway.com/versions/new-international-version-niv-bible/#copy,0000-00-00T00:00:00.000000+00:00,0.0.0
 ```
 
 ## Text searching within files

docs/_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.2.0',
+    VERSION: '1.3.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

docs/genindex.html

@@ -4,10 +4,10 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; Meaningless 1.2.0 documentation</title>
+    <title>Index &#8212; Meaningless 1.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=28c8e701" />
-    <script src="_static/documentation_options.js?v=6efca38a"></script>
+    <script src="_static/documentation_options.js?v=1f29e9d3"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="_static/favicon.png"/>

docs/index.html

@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Meaningless 1.2.0 - API Documentation &#8212; Meaningless 1.2.0 documentation</title>
+    <title>Meaningless 1.3.0 - API Documentation &#8212; Meaningless 1.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=28c8e701" />
-    <script src="_static/documentation_options.js?v=6efca38a"></script>
+    <script src="_static/documentation_options.js?v=1f29e9d3"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="_static/favicon.png"/>
@@ -78,7 +78,7 @@ <h3 id="searchlabel">Quick search</h3>
           <div class="body" role="main">
 
   <section id="meaningless-library-version-api-documentation">
-<h1>Meaningless 1.2.0 - API Documentation<a class="headerlink" href="#meaningless-library-version-api-documentation" title="Link to this heading">¶</a></h1>
+<h1>Meaningless 1.3.0 - API Documentation<a class="headerlink" href="#meaningless-library-version-api-documentation" title="Link to this heading">¶</a></h1>
 <div class="toctree-wrapper compound">
 <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>