linkture 2.5.6__tar.gz → 2.6.1__tar.gz

{linkture-2.5.6 → linkture-2.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: linkture
-Version: 2.5.6
+Version: 2.6.1
 Summary: PARSE and PROCESS BIBLE SCRIPTURE REFERENCES: extract, tag, link, rewrite, translate, BCV-encode and decode
 Keywords: bible,scriptures,scripture-references,scripture-translation,scripture-parser,scripture-linker
 Author-Email: "Eryk J." <infiniti@inventati.org>
@@ -23,13 +23,9 @@ Requires-Dist: setuptools>=59.6.0
 Requires-Dist: argparse>=1.4.0
 Requires-Dist: regex>=2023.8.8
 Requires-Dist: unidecode>=1.3.8
-Requires-Dist: pathlib>=1.0.1
 Requires-Dist: pandas==2.2.2
 Description-Content-Type: text/markdown
 
-# linkture
-
-
 ## Purpose
 
 This module contains functions to parse and process Bible scripture references.
@@ -117,15 +113,18 @@ John 17:17; 2 Tim. 3:16, 17
 $ python3 -m linkture -r "Joh 17:17; 2Ti 3:16, 17" --official
 Joh 17:17; 2Ti 3:16, 17
 
+
 $ python3 -m linkture -r "Joh 17:17; 2Ti 3:16, 17" -c
 [('43017017', '43017017'), ('55003016', '55003017')]
 
 $ python3 -m linkture -r "[('43017017', '43017017'), ('55003016', '55003017')]" -d --translate German
 ['Johannes 17:17', '2. Timotheus 3:16, 17']
 
+
 $ python3 -m linkture -r "Joh 17:17; 2Ti 3:16, 17" -l '<a href="https://my.website.com/' '/index.html" class="test">'
 <a href="https://my.website.com/43:17:17/index.html" class="test">John 17:17</a>; <a href="https://my.website.com/55:3:16-55:3:17/index.html" class="test">2 Timothy 3:16, 17</a>
 
+
 $ python3 -m linkture -r "Joh 17:17; 2Ti 3:16, 17" --translate Chinese
 约翰福音 17:17; 提摩太后书 3:16, 17
 
@@ -138,6 +137,7 @@ Juan 17:17; 2 Tim. 3:16, 17
 $ python3 -m linkture -r "Mat 17:17; Paul 3:16, 17" --full -x
 ['Matthew 17:17']
 
+
 $ python3 -m linkture -cc 2
 ('01002001', '01002025')
 
@@ -150,6 +150,7 @@ $ python3 -m linkture -sv '01001001'
 python3 -m linkture -sc '66022001'
 1189
 
+
 python3 -m linkture -r '2Ti 3:16, 17' --full -s '_'
 2_Timothy_3:16,_17
 ```
@@ -163,12 +164,14 @@ Unless you use `-q`, you will see in the terminal any out-of-range errors encoun
 ____
 ## Script/import usage
 
-Assume the text (short string or long document) you want to process is in the variable `txt`. It's in English, but you would like the scriptures to be in Spanish, with the full book name:
+Assume the text (short string or long document) you want to process is in the variable `txt`.
+
 ```
 from linkture import Scriptures
 
 s = Scriptures(language="English", translate="Spanish", form="full")
 
+
 lst = s.list_scriptures(txt)
 # returns a list of (valid) extracted scriptures in the desired language and format
 
@@ -181,19 +184,20 @@ html = s.link_scriptures(txt, prefix='<a href="http://mywebsite.com/', suffix='"
 tagged = s.tag_scriptures(txt)
 # tagged will contain your document with the translated references enclosed within double braces
 
-txt = s.rewrite_scriptures(txt)
+new_txt = s.rewrite_scriptures(txt)
 # the references will simply be rewritten in the desired language and format
 
-i = s.serial_chapter_number(txt)
+
+i = s.serial_chapter_number(ch_bcv)
 # returns the serial number (1-1189) of the chapter identified by the provided BCV-format string; verse digits irrelevant
 
-i = s.serial_verse_number(txt)
+i = s.serial_verse_number(vs_bcv)
 # returns the serial number (1-31091) of the verse identified by the provided BCV-format string
 
-txt = s.code_chapter(i)
+ch_bcv = s.code_chapter(i)
 # returns a BCV-format range string for the whole chapter indicated by the provided integer (1-1189)
 
-txt = s.code_verse(i)
+vs_bcv = s.code_verse(i)
 # returns a BCV-format range string for the verse indicated by the provided integer (1-31091)
 ```
 

{linkture-2.5.6 → linkture-2.6.1}/README.md

@@ -1,6 +1,3 @@
-# linkture
-
-
 ## Purpose
 
 This module contains functions to parse and process Bible scripture references.
@@ -88,15 +85,18 @@ John 17:17; 2 Tim. 3:16, 17
 $ python3 -m linkture -r "Joh 17:17; 2Ti 3:16, 17" --official
 Joh 17:17; 2Ti 3:16, 17
 
+
 $ python3 -m linkture -r "Joh 17:17; 2Ti 3:16, 17" -c
 [('43017017', '43017017'), ('55003016', '55003017')]
 
 $ python3 -m linkture -r "[('43017017', '43017017'), ('55003016', '55003017')]" -d --translate German
 ['Johannes 17:17', '2. Timotheus 3:16, 17']
 
+
 $ python3 -m linkture -r "Joh 17:17; 2Ti 3:16, 17" -l '<a href="https://my.website.com/' '/index.html" class="test">'
 <a href="https://my.website.com/43:17:17/index.html" class="test">John 17:17</a>; <a href="https://my.website.com/55:3:16-55:3:17/index.html" class="test">2 Timothy 3:16, 17</a>
 
+
 $ python3 -m linkture -r "Joh 17:17; 2Ti 3:16, 17" --translate Chinese
 约翰福音 17:17; 提摩太后书 3:16, 17
 
@@ -109,6 +109,7 @@ Juan 17:17; 2 Tim. 3:16, 17
 $ python3 -m linkture -r "Mat 17:17; Paul 3:16, 17" --full -x
 ['Matthew 17:17']
 
+
 $ python3 -m linkture -cc 2
 ('01002001', '01002025')
 
@@ -121,6 +122,7 @@ $ python3 -m linkture -sv '01001001'
 python3 -m linkture -sc '66022001'
 1189
 
+
 python3 -m linkture -r '2Ti 3:16, 17' --full -s '_'
 2_Timothy_3:16,_17
 ```
@@ -134,12 +136,14 @@ Unless you use `-q`, you will see in the terminal any out-of-range errors encoun
 ____
 ## Script/import usage
 
-Assume the text (short string or long document) you want to process is in the variable `txt`. It's in English, but you would like the scriptures to be in Spanish, with the full book name:
+Assume the text (short string or long document) you want to process is in the variable `txt`.
+
 ```
 from linkture import Scriptures
 
 s = Scriptures(language="English", translate="Spanish", form="full")
 
+
 lst = s.list_scriptures(txt)
 # returns a list of (valid) extracted scriptures in the desired language and format
 
@@ -152,19 +156,20 @@ html = s.link_scriptures(txt, prefix='<a href="http://mywebsite.com/', suffix='"
 tagged = s.tag_scriptures(txt)
 # tagged will contain your document with the translated references enclosed within double braces
 
-txt = s.rewrite_scriptures(txt)
+new_txt = s.rewrite_scriptures(txt)
 # the references will simply be rewritten in the desired language and format
 
-i = s.serial_chapter_number(txt)
+
+i = s.serial_chapter_number(ch_bcv)
 # returns the serial number (1-1189) of the chapter identified by the provided BCV-format string; verse digits irrelevant
 
-i = s.serial_verse_number(txt)
+i = s.serial_verse_number(vs_bcv)
 # returns the serial number (1-31091) of the verse identified by the provided BCV-format string
 
-txt = s.code_chapter(i)
+ch_bcv = s.code_chapter(i)
 # returns a BCV-format range string for the whole chapter indicated by the provided integer (1-1189)
 
-txt = s.code_verse(i)
+vs_bcv = s.code_verse(i)
 # returns a BCV-format range string for the verse indicated by the provided integer (1-31091)
 ```
 

{linkture-2.5.6 → linkture-2.6.1}/pyproject.toml

@@ -10,7 +10,6 @@ dependencies = [
     "argparse>=1.4.0",
     "regex>=2023.8.8",
     "unidecode>=1.3.8",
-    "pathlib>=1.0.1",
     "pandas==2.2.2",
 ]
 requires-python = ">=3.9"
@@ -36,7 +35,7 @@ keywords = [
     "scripture-parser",
     "scripture-linker",
 ]
-version = "v2.5.6"
+version = "v2.6.1"
 
 [project.license]
 text = "MIT"
@@ -56,4 +55,4 @@ distribution = true
 
 [tool.pdm.version]
 source = "file"
-path = "src/linkture/__main__.py"
+path = "src/linkture/linkture.py"

linkture-2.6.1/src/linkture/__init__.py

@@ -0,0 +1,3 @@
+#!/usr/bin/env python
+
+from .linkture import *

linkture-2.6.1/src/linkture/__main__.py

@@ -0,0 +1,133 @@
+#!/usr/bin/env python3
+
+"""
+  File:           linkture
+
+  Description:    Parse and process Bible scripture references
+
+  MIT License:    Copyright (c) 2024 Eryk J.
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.
+"""
+
+import argparse
+from .linkture import _available_languages, __app__, __version__, Scriptures
+from ast import literal_eval
+
+
+def main(args):
+
+    def switchboard(text):
+        if args['cc']:
+            return s.code_chapter(args['cc'])
+        elif args['cv']:
+            return s.code_verse(args['cv'])
+        elif args['sc']:
+            return s.serial_chapter_number(args['sc'])
+        elif args['sv']:
+            return s.serial_verse_number(args['sv'])
+        if args['l'] is not None:
+            prefix = '<a href="'
+            suffix = '">'
+            if len(args['l']) > 1 and args['l'][1] != '':
+                suffix = args['l'][1]
+            if len(args['l']) > 0 and args['l'][0] != '':
+                prefix = args['l'][0]
+            return s.link_scriptures(text, prefix, suffix)
+        elif args['c']:
+            return s.code_scriptures(text)
+        elif args['d']:
+            return s.decode_scriptures(literal_eval(text))
+        elif args['x']:
+            return s.list_scriptures(text)
+        elif args['t']:
+            return s.tag_scriptures(text)
+        else:
+            return s.rewrite_scriptures(text)
+
+    form = None
+    if args['standard']:
+        form = 'standard'
+    elif args['official']:
+        form = 'official'
+    elif args['full']:
+        form = 'full'
+
+    s = Scriptures(language=args['language'], translate=args['translate'], form=form, separator=args['s'], upper=args['u'], verbose=(not args['q']))
+
+    if args['f']:
+        if args['o'] and (args['o'] == args['f']):
+            print('Make sure in-file and out-file are different!\n')
+            exit()
+        with open(args['f'], 'r', encoding='UTF-8') as f:
+            txt = f.read()
+    else:
+        txt = args['r']
+
+    if txt:
+        txt = switchboard(txt)
+    else:
+        print(parser.format_help())
+        exit()
+
+    if args['o']:
+        with open(args['o'], 'w', encoding='UTF-8') as f:
+            f.write(str(txt))
+    else:
+        print(txt)
+
+
+parser = argparse.ArgumentParser(description="PARSE and PROCESS BIBLE SCRIPTURE REFERENCES: extract, tag, link, rewrite, translate, BCV-encode and decode. See README for more information")
+
+parser.add_argument('-v', action='version', version=f"{__app__} {__version__}", help='show version and exit')
+parser.add_argument('-q', action='store_true', help="don't show errors")
+
+function_group = parser.add_argument_group('data source (one required - except for auxiliary functions, which only take command-line arguments)', 'choose between terminal or file input:')
+mode = function_group.add_mutually_exclusive_group()
+mode.add_argument('-f', metavar='in-file', help='get input from file (UTF-8)')
+mode.add_argument('-r', metavar='reference', help='process "reference; reference; etc."')
+parser.add_argument('-o', metavar='out-file', help='output file (terminal output if not provided)')
+
+parser.add_argument('--language', default='English', choices=_available_languages, help='indicate source language for book names (English if unspecified)')
+parser.add_argument('--translate', choices=_available_languages, help='indicate output language for book names (same as source if unspecified)')
+parser.add_argument('-s', metavar='separator', default=' ', help='segment separator (space by default)')
+parser.add_argument('-u', action='store_true', help='capitalize (upper-case) book names')
+format_group = parser.add_argument_group('output format (optional)', 'if provided, book names will be rewritten accordingly:')
+formats = format_group.add_mutually_exclusive_group()
+formats.add_argument('--full', action='store_true', help='output as full name - default (eg., "Genesis")')
+formats.add_argument('--official', action='store_true', help='output as official abbreviation (eg., "Ge")')
+formats.add_argument('--standard', action='store_true', help='output as standard abbreviation (eg., "Gen.")')
+
+type_group = parser.add_argument_group('type of conversion', 'if not specified, references are simply rewritten according to chosen (or default) output format:')
+tpe = type_group.add_mutually_exclusive_group(required=False)
+tpe.add_argument('-c', action='store_true', help='encode as BCV-notation ranges')
+tpe.add_argument('-d', action='store_true', help='decode list of BCV-notation ranges')
+tpe.add_argument('-l', nargs='*', metavar=('prefix', 'suffix'), help='create <a></a> links; provide a "prefix" and a "suffix" (or neither for testing)')
+tpe.add_argument('-t', action='store_true', help='tag scriptures with {{ }}')
+tpe.add_argument('-x', action='store_true', help='extract list of scripture references')
+
+aux_group = parser.add_argument_group('auxiliary functions')
+aux = aux_group.add_mutually_exclusive_group(required=False)
+aux.add_argument('-sc', metavar=('BCV'), help='return the serial number (1-1189) of the chapter with code "BCV" ("bbcccvvv")')
+aux.add_argument('-sv', metavar=('BCV'), help='return the serial number (1-31091) of the verse with code "BCV" ("bbcccvvv")')
+aux.add_argument('-cc', metavar=('chapter'), help='return the BCV range for serial chapter number "chapter" (integer value)')
+aux.add_argument('-cv', metavar=('verse'), help='return the BCV code for serial verse number "verse" (integer value)')
+
+args = parser.parse_args()
+main(vars(args))

linkture-2.5.6/src/linkture/__main__.py → linkture-2.6.1/src/linkture/linkture.py

@@ -26,19 +26,17 @@
   SOFTWARE.
 """
 
-__version__ = 'v2.5.6'
+__app__ = 'linkture'
+__version__ = 'v2.6.1'
 
 
-import argparse, json, regex, sqlite3
+import json, regex, sqlite3
 import pandas as pd
-
-from ast import literal_eval
-from pathlib import Path
 from unidecode import unidecode
 
 
-available_languages = ('Cebuano', 'Chinese', 'Danish', 'Dutch', 'English', 'French', 'German', 'Greek', 'Hungarian', 'Italian', 'Japanese', 'Korean', 'Norwegian', 'Polish', 'Portuguese', 'Russian', 'Spanish', 'Tagalog', 'Ukrainian')
-non_latin = ('Chinese', 'Greek', 'Japanese', 'Korean', 'Russian', 'Ukrainian')
+_available_languages = ('Cebuano', 'Chinese', 'Danish', 'Dutch', 'English', 'French', 'German', 'Greek', 'Hungarian', 'Italian', 'Japanese', 'Korean', 'Norwegian', 'Polish', 'Portuguese', 'Russian', 'Spanish', 'Tagalog', 'Ukrainian')
+_non_latin = ('Chinese', 'Greek', 'Japanese', 'Korean', 'Russian', 'Ukrainian')
 
 
 class Scriptures():
@@ -46,14 +44,14 @@ class Scriptures():
     def __init__(self, language='English', translate=None, form=None, separator=' ', upper=False, verbose=False):
         self._verbose = verbose
         self._separator = separator
-        if language not in available_languages:
+        if language not in _available_languages:
             raise ValueError("Indicated source language is not an option!")
         if translate:
-            if translate not in available_languages:
+            if translate not in _available_languages:
                 raise ValueError("Indicated translation language is not an option!")
         else:
             translate = language
-        if language in non_latin:
+        if language in _non_latin:
             self._nl = True
         else:
             self._nl = False
@@ -68,10 +66,9 @@ class Scriptures():
         else:
             form = 3
         self._src_book_names = {}
-        path = Path(__file__).resolve().parent
 
         self._tr_book_names = ['Bible']
-        con = sqlite3.connect(path / 'res/resources.db')
+        con = sqlite3.connect('src/linkture/res/resources.db')
         cur = con.cursor()
         for rec in cur.execute(f"SELECT * FROM Books WHERE Language = '{translate}';").fetchall():
             if self._upper:
@@ -86,7 +83,7 @@ class Scriptures():
                     item = unidecode(item)
                 normalized = regex.sub(r'\p{P}|\p{Z}', '', item.upper())
                 self._src_book_names[normalized] = rec[2]
-        with open(path / 'res/custom.json', 'r', encoding='UTF-8') as json_file:
+        with open('src/linkture/res/custom.json', 'r', encoding='UTF-8') as json_file:
             b = json.load(json_file)
         if language in b.keys():
             for row in b[language]:
@@ -608,106 +605,3 @@ class Scriptures():
         except:
             self._error_report(verse, 'OUT OF RANGE')
             return None
-
-
-def _main(args):
-
-    def switchboard(text):
-        if args['cc']:
-            return s.code_chapter(args['cc'])
-        elif args['cv']:
-            return s.code_verse(args['cv'])
-        elif args['sc']:
-            return s.serial_chapter_number(args['sc'])
-        elif args['sv']:
-            return s.serial_verse_number(args['sv'])
-        if args['l'] is not None:
-            prefix = '<a href='
-            suffix = '>'
-            if len(args['l']) > 1:
-                suffix = args['l'][1]
-            if len(args['l']) > 0:
-                prefix = args['l'][0]
-            return s.link_scriptures(text, prefix, suffix)
-        elif args['c']:
-            return s.code_scriptures(text)
-        elif args['d']:
-            return s.decode_scriptures(literal_eval(text))
-        elif args['x']:
-            return s.list_scriptures(text)
-        elif args['t']:
-            return s.tag_scriptures(text)
-        else:
-            return s.rewrite_scriptures(text)
-
-    form = None
-    if args['standard']:
-        form = 'standard'
-    elif args['official']:
-        form = 'official'
-    elif args['full']:
-        form = 'full'
-
-    s = Scriptures(language=args['language'], translate=args['translate'], form=form, separator=args['s'], upper=args['u'], verbose=(not args['q']))
-
-    if args['f']:
-        if args['o'] and (args['o'] == args['f']):
-            print('Make sure in-file and out-file are different!\n')
-            exit()
-        with open(args['f'], 'r', encoding='UTF-8') as f:
-            txt = f.read()
-    else:
-        txt = args['r']
-
-    if txt:
-        txt = switchboard(txt)
-    else:
-        print(parser.format_help())
-        exit()
-
-    if args['o']:
-        with open(args['o'], 'w', encoding='UTF-8') as f:
-            f.write(str(txt))
-    else:
-        print(txt)
-
-if __name__ == "__main__":
-    PROJECT_PATH = Path(__file__).resolve().parent
-    APP = 'linkture' # Path(__file__).stem
-    parser = argparse.ArgumentParser(description="PARSE and PROCESS BIBLE SCRIPTURE REFERENCES: extract, tag, link, rewrite, translate, BCV-encode and decode. See README for more information")
-
-    parser.add_argument('-v', action='version', version=f"{APP} {__version__}", help='show version and exit')
-    parser.add_argument('-q', action='store_true', help="don't show errors")
-
-    function_group = parser.add_argument_group('data source (one required - except for auxiliary functions, which only take command-line arguments)', 'choose between terminal or file input:')
-    mode = function_group.add_mutually_exclusive_group()
-    mode.add_argument('-f', metavar='in-file', help='get input from file (UTF-8)')
-    mode.add_argument('-r', metavar='reference', help='process "reference; reference; etc."')
-    parser.add_argument('-o', metavar='out-file', help='output file (terminal output if not provided)')
-
-    parser.add_argument('--language', default='English', choices=available_languages, help='indicate source language for book names (English if unspecified)')
-    parser.add_argument('--translate', choices=available_languages, help='indicate output language for book names (same as source if unspecified)')
-    parser.add_argument('-s', metavar='separator', default=' ', help='segment separator (space by default)')
-    parser.add_argument('-u', action='store_true', help='capitalize (upper-case) book names')
-    format_group = parser.add_argument_group('output format (optional)', 'if provided, book names will be rewritten accordingly:')
-    formats = format_group.add_mutually_exclusive_group()
-    formats.add_argument('--full', action='store_true', help='output as full name - default (eg., "Genesis")')
-    formats.add_argument('--official', action='store_true', help='output as official abbreviation (eg., "Ge")')
-    formats.add_argument('--standard', action='store_true', help='output as standard abbreviation (eg., "Gen.")')
-
-    type_group = parser.add_argument_group('type of conversion', 'if not specified, references are simply rewritten according to chosen (or default) output format:')
-    tpe = type_group.add_mutually_exclusive_group(required=False)
-    tpe.add_argument('-c', action='store_true', help='encode as BCV-notation ranges')
-    tpe.add_argument('-d', action='store_true', help='decode list of BCV-notation ranges')
-    tpe.add_argument('-l', nargs='*', metavar=('prefix', 'suffix'), help='create <a></a> links; provide a "prefix" and a "suffix" (or neither for testing)')
-    tpe.add_argument('-t', action='store_true', help='tag scriptures with {{ }}')
-    tpe.add_argument('-x', action='store_true', help='extract list of scripture references')
-
-    aux_group = parser.add_argument_group('auxiliary functions')
-    aux = aux_group.add_mutually_exclusive_group(required=False)
-    aux.add_argument('-sc', metavar=('BCV'), help='return the serial number (1-1189) of the chapter with code "BCV" ("bbcccvvv")')
-    aux.add_argument('-sv', metavar=('BCV'), help='return the serial number (1-31091) of the verse with code "BCV" ("bbcccvvv")')
-    aux.add_argument('-cc', metavar=('chapter'), help='return the BCV range for serial chapter number "chapter" (integer value)')
-    aux.add_argument('-cv', metavar=('verse'), help='return the BCV code for serial verse number "verse" (integer value)')
-    args = parser.parse_args()
-    _main(vars(args))