bibref-python 2026.3.18__py3-none-any.whl

bibref/tools.py

@@ -0,0 +1,225 @@
+import sys, pexpect, os, re, shutil
+
+bibref_default_timeout = 5
+bibref_default_timeout_max = 180
+bibref_fullpath = ""
+
+bibref = None
+
+def set_bibref_path(fullpath = ""):
+    global bibref_fullpath
+    bibref_fullpath = fullpath
+
+def spawn_bibref():
+    global bibref
+    if bibref is not None:
+        return
+    sys.stderr.write("Waiting for bibref's full startup...\n")
+
+    if bibref_fullpath != "":
+        bibref = pexpect.spawn(bibref_fullpath + " -a")
+        bibref.expect("Done loading books of SBLGNT.")
+        bibref.timeout = bibref_default_timeout
+        return
+
+    bibref_fullpath_auto = shutil.which("bibref")
+
+    if bibref_fullpath_auto is None:
+        raise RuntimeError(
+            "No 'bibref' binary can be found in PATH. "
+            "Install it first by using `snap install bibref`, for example. "
+            "Alternatively, use 'set_bibref_path(...)' to set the correct full path."
+        )
+
+    sys.stderr.write(f"Spawning {bibref_fullpath_auto}...\n")
+    bibref = pexpect.spawn(bibref_fullpath_auto + " -a")
+    bibref.expect("Done loading books of SBLGNT.")
+    bibref.timeout = bibref_default_timeout
+
+def getrefs_maxlength(getrefs_input):
+    """
+    Returns the length of the longest match.
+    :param getrefs_input: All parameters of getref as string
+    :return: The length of the longest match
+    """
+    global bibref
+    spawn_bibref()
+    bibref.timeout = bibref_default_timeout_max
+    command = "getrefs " + getrefs_input
+    bibref.sendline(command)
+    bibref.expect("Finished")
+    lines = bibref.before.decode('utf-8').splitlines()
+    no_lines = len(lines)
+    length_regex = re.compile(r'length=([0-9]+),')
+    found = length_regex.search(lines[no_lines - 1])
+    maxlength0 = found.group()
+    maxlength1 = maxlength0.split("=")
+    maxlength2 = maxlength1[1]
+    maxlength3 = maxlength2.split(",")
+    maxlength = maxlength3[0]
+    bibref.timeout = bibref_default_timeout
+    return maxlength
+
+def text_n(c, greektext):
+    """
+    Stores the Greek input in the selected clipboard.
+    :param c: Clipboard number (1 or 2)
+    :param greektext: Greek input as string
+    :return: the input converted to Latin notation
+    """
+    global bibref
+    spawn_bibref()
+    bibref.timeout = bibref_default_timeout
+    command = "text" + str(c) + " " + greektext
+    bibref.sendline(command)
+    bibref.expect("Stored internally as (\\w+).")
+    form = bibref.match.groups()
+    return form[0].decode('utf-8')
+
+def latintext_n(c, latintext):
+    """
+    Stores the Latin input in the selected clipboard.
+    :param c: Clipboard number (1 or 2)
+    :param greektext: Latin input as string
+    """
+    global bibref
+    spawn_bibref()
+    bibref.timeout = bibref_default_timeout
+    command = "latintext" + str(c) + " " + latintext
+    bibref.sendline(command)
+    bibref.expect("Stored.")
+
+def lookup_n(c, passage):
+    """
+    Looks up the passage and stores it in the selected clipboard.
+    :param c: Clipboard number (1 or 2)
+    :param passage: The passage to look up
+    :return: the passage converted to Latin notation
+    """
+    global bibref
+    spawn_bibref()
+    bibref.timeout = bibref_default_timeout
+    command = "lookup" + str(c) + " " + passage
+    bibref.sendline(command)
+    bibref.expect("Stored internally as (\\w+).")
+    form = bibref.match.groups()
+    return form[0].decode('utf-8')
+
+def find_n(c, bible):
+    """
+    Finds the clipboard text in a Bible edition.
+    :param c: Clipboard number (1 or 2)
+    :param bible: Bible edition
+    :return: list of strings that explain the matches (in bibref format: passage, raw_start, raw_end)
+    """
+    global bibref
+    spawn_bibref()
+    bibref.timeout = bibref_default_timeout
+    command = "find" + str(c) + " " + bible
+    bibref.sendline(command)
+    ret = []
+    finished = False
+    # Found in Acts 13:33+88 13:33 (book position 43840-43871)
+    # Found in Hebrews 1:5+26 1:5-53 (book position 420-451)
+    # Found in Hebrews 5:5+70 5:5 (book position 6271-6302)
+    # 3 occurrences.
+    while not finished:
+        index = bibref.expect([r'Found in (.*?) \(book position ([0-9]+)\-([0-9]+)\)',r'([0-9]+) occurrences.'])
+        if index == 0:
+            passage, raw1, raw2 = bibref.match.groups()
+            ret.append([passage.decode('utf-8'), int(raw1), int(raw2)])
+        if index == 1:
+            finished = True
+    return ret
+
+def jaccard12():
+    """
+    Computes the Jaccard distance between the two clipboard texts.
+    :return: the Jaccard distance as a number between 0 and 1
+    """
+    global bibref
+    spawn_bibref()
+    bibref.timeout = bibref_default_timeout
+    command = "jaccard12"
+    bibref.sendline(command)
+    bibref.expect("Jaccard distance is ([0-9]+\\.[0-9]+).")
+    jaccard12 = bibref.match.groups()
+    jaccard = float(jaccard12[0]) * 100
+    return jaccard
+
+def jaccard(t1, t2):
+    """
+    Puts the Greek inputs in the clipboards and compute their Jaccard distance.
+    :param t1: the first Greek text
+    :param t2: the second Greek text
+    :return: the Jaccard distance as a number between 0 and 1
+    """
+    text_n(1, t1)
+    text_n(2, t2)
+    return jaccard12()
+
+def latin_to_greek(latin):
+    """
+    Converts the Latin input into Greek text.
+    :param latin: the input as Latin text
+    :return: the text in Greek letters
+    """
+    greek = latin
+    greek = greek.replace("a", "α") # Note that the implementation is not very elegant.
+    greek = greek.replace("b", "β")
+    greek = greek.replace("c", "ψ")
+    greek = greek.replace("d", "δ")
+    greek = greek.replace("e", "ε")
+    greek = greek.replace("f", "φ")
+    greek = greek.replace("g", "γ")
+    greek = greek.replace("h", "η")
+    greek = greek.replace("i", "ι")
+    greek = greek.replace("j", "ξ")
+    greek = greek.replace("k", "κ")
+    greek = greek.replace("l", "λ")
+    greek = greek.replace("m", "μ")
+    greek = greek.replace("n", "ν")
+    greek = greek.replace("o", "ο")
+    greek = greek.replace("p", "π")
+    greek = greek.replace("q", "ζ")
+    greek = greek.replace("r", "ρ")
+    greek = greek.replace("s", "σ")
+    greek = greek.replace("t", "τ")
+    greek = greek.replace("u", "θ")
+    greek = greek.replace("v", "ω")
+    greek = greek.replace("w", "ς") # unused
+    greek = greek.replace("x", "χ")
+    greek = greek.replace("y", "υ")
+    greek = greek.replace("z", "ζ") # maybe unused
+    return greek
+
+def nearest12():
+    """
+    Computes the nearest substring of clipboard 1 and the text in clipboard2.
+    :return: a 2-element list of the minimal Jaccard distance as a number between 0 and 1 and the nearest substring
+    """
+    global bibref
+    spawn_bibref()
+    bibref.timeout = bibref_default_timeout
+    command = "nearest12"
+    bibref.sendline(command)
+    bibref.expect("Nearest Jaccard distance is ([0-9]+\\.[0-9]+) with substring (\\w+).")
+    nearest12 = bibref.match.groups()
+    nearest = float(nearest12[0]) * 100
+    nearest_substring = nearest12[1].decode('utf-8')
+    return nearest, nearest_substring
+
+def maxresults(m):
+    """
+    Sets the maximal amount of matches to be found, for the find command.
+    :return: the value being actually set
+    """
+    global bibref
+    spawn_bibref()
+    bibref.timeout = bibref_default_timeout
+    command = "maxresults " + str(m)
+    bibref.sendline(command)
+    bibref.expect("Set to ([0-9]+).")
+    maxresults = bibref.match.groups()
+    return int(maxresults[0])
+

bibref_python-2026.3.18.dist-info/METADATA

@@ -0,0 +1,20 @@
+Metadata-Version: 2.4
+Name: bibref-python
+Version: 2026.3.18
+Summary: Python wrapper for the bibref command-line tool for working with biblical references
+Author: Zoltán Kovács
+License: Copyright (C) 2026 Zoltán Kovács
+        
+        Copying and distribution of these files, with or without modification,
+        are permitted in any medium without royalty provided the copyright
+        notice and this notice are preserved.
+        
+Project-URL: Homepage, https://github.com/kovzol/bibref-python
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pexpect>=4.8
+Dynamic: license-file

bibref_python-2026.3.18.dist-info/RECORD

@@ -0,0 +1,7 @@
+bibref/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bibref/tools.py,sha256=NguBO5bXUWhgm8IaMkpPw9dp6F_ftvZZR3u93THVrIY,7407
+bibref_python-2026.3.18.dist-info/licenses/LICENSE,sha256=AE-9c3gRsMwA5aDYTqdjxGENJmM2k2EQVfUE8wbnRZk,212
+bibref_python-2026.3.18.dist-info/METADATA,sha256=9vw2hA-HoCcdwDc9XPcsWxnzkfAjfTUz0Jyp3sRlpHo,771
+bibref_python-2026.3.18.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+bibref_python-2026.3.18.dist-info/top_level.txt,sha256=RTH1l7THHwpMwkH5Ydrjmk5oQRI9UKUbyUuFtJRgYGs,7
+bibref_python-2026.3.18.dist-info/RECORD,,

bibref_python-2026.3.18.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

bibref_python-2026.3.18.dist-info/licenses/LICENSE

@@ -0,0 +1,5 @@
+Copyright (C) 2026 Zoltán Kovács
+
+Copying and distribution of these files, with or without modification,
+are permitted in any medium without royalty provided the copyright
+notice and this notice are preserved.

bibref_python-2026.3.18.dist-info/top_level.txt

@@ -0,0 +1 @@
+bibref