linkture 2.6.0__tar.gz → 2.6.2__tar.gz

{linkture-2.6.0 → linkture-2.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: linkture
-Version: 2.6.0
+Version: 2.6.2
 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>
@@ -24,11 +24,9 @@ Requires-Dist: argparse>=1.4.0
 Requires-Dist: regex>=2023.8.8
 Requires-Dist: unidecode>=1.3.8
 Requires-Dist: pandas==2.2.2
+Requires-Dist: pathlib>=1.0.1
 Description-Content-Type: text/markdown
 
-# linkture
-
-
 ## Purpose
 
 This module contains functions to parse and process Bible scripture references.
@@ -116,15 +114,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
 
@@ -137,6 +138,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')
 
@@ -149,6 +151,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
 ```
@@ -162,12 +165,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
 
@@ -180,19 +185,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.6.0 → linkture-2.6.2}/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.6.0 → linkture-2.6.2}/pyproject.toml

@@ -11,6 +11,7 @@ dependencies = [
     "regex>=2023.8.8",
     "unidecode>=1.3.8",
     "pandas==2.2.2",
+    "pathlib>=1.0.1",
 ]
 requires-python = ">=3.9"
 readme = "README.md"
@@ -35,7 +36,7 @@ keywords = [
     "scripture-parser",
     "scripture-linker",
 ]
-version = "v2.6.0"
+version = "v2.6.2"
 
 [project.license]
 text = "MIT"

{linkture-2.6.0 → linkture-2.6.2}/src/linkture/__main__.py

@@ -27,7 +27,7 @@
 """
 
 import argparse
-from .linkture import available_languages, __app__, __version__, Scriptures
+from .linkture import _available_languages, __app__, __version__, Scriptures
 from ast import literal_eval
 
 
@@ -43,11 +43,11 @@ def main(args):
         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:
+            prefix = '<a href="'
+            suffix = '">'
+            if len(args['l']) > 1 and args['l'][1] != '':
                 suffix = args['l'][1]
-            if len(args['l']) > 0:
+            if len(args['l']) > 0 and args['l'][0] != '':
                 prefix = args['l'][0]
             return s.link_scriptures(text, prefix, suffix)
         elif args['c']:
@@ -104,8 +104,8 @@ 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('--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:')

{linkture-2.6.0 → linkture-2.6.2}/src/linkture/linkture.py

@@ -27,16 +27,17 @@
 """
 
 __app__ = 'linkture'
-__version__ = 'v2.6.0'
+__version__ = 'v2.6.2'
 
 
 import json, regex, sqlite3
 import pandas as pd
+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():
@@ -44,14 +45,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
@@ -66,9 +67,10 @@ class Scriptures():
         else:
             form = 3
         self._src_book_names = {}
+        path = Path(__file__).resolve().parent
 
         self._tr_book_names = ['Bible']
-        con = sqlite3.connect('res/resources.db')
+        con = sqlite3.connect(path / 'res/resources.db')
         cur = con.cursor()
         for rec in cur.execute(f"SELECT * FROM Books WHERE Language = '{translate}';").fetchall():
             if self._upper:
@@ -83,7 +85,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('res/custom.json', 'r', encoding='UTF-8') as json_file:
+        with open(path / '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]: