README

Refspy is a Python package for working with biblical references in ordinary text.

README

eukras/refspy on Github | Report Issue | Contact Author
refspy on PyPI → pip install refspy.
refspy on ReadTheDocs → See docs/ dir.
CHANGES.md | TODO.md

Demo

Generated by demo.py.

Features

Find biblical references matching human writing styles (spaces, commas, prefixes, abbreviations)
Sequentially replace matched references.
Compile indexes of all matched references, or all verse ranges covered; list the most referenced chapters (hotspots) in a list of references.
Format references as names, abbreviated names, and URL parameters.
Generate HTML links of any required format.
Construct and manipulate verses, ranges, and references.
Compare and sort verses, ranges, and references.
Collate references by library and book for iteration.
Test if references or ranges contain, overlap, or adjoin one another; merge overlapping references and join adjacent ones.
Store verses as UNSIGNED INT(12) for database indexing.
Generally follow established conventions, so SBL style in English.

The Reference Manager

Initialising refspy with corpus and language names will return a reference manager. This provides a single convenient interface for the whole library. By default, refspy provides a Protestant canon in English.

from refspy import refspy
__ = refspy()

Or, to create specific canons:

from refspy.language.en import ENGLISH
from refspy.libraries.en_US import DC, DC_ORTHODOX, NT, OT
from refspy.manager import Manager 

# Protestant
__ = refspy('protestant', 'en_US')
__ = Manager(libraries=[OT, NT], language=ENGLISH)

# Catholic
__ = refspy('catholic', 'en_US')
__ = Manager(libraries=[OT, DC, NT], language=ENGLISH)

# Orthodox
__ = refspy('orthodox', 'en_US')
__ = Manager(libraries=[OT, DC, DC_ORTHODOX, NT], language=ENGLISH)

The file refspy/setup.py shows valid names for libraries and languages. There's only English initially. The en_US libraries conform to the SBL Style Guide for book names and abbreviations. Other libraries can be defined and added locally following the structure in refspy.libraries.en_US. If they follow established academic usage where possible, please contribute them to the project.

Creating references

Shortcut functions can create simple references using any book name, abbreviation, or alias in the libraries list. Firstly, we can create references from strings:

ref = __.r('Rom 2:6,9,1,2')

We can construct references more programmatically with __.bcv():

assert __.name(___.bcv('Rom')) == 'Romans' 
assert __.name(___.bcv('Rom', 2)) == 'Romans 2'
assert __.name(___.bcv('Rom', 2, 2)) == 'Romans 2:2'
assert __.name(___.bcv('Rom', 2, 2, 3)) == 'Romans 2:2-3'

Or __.bcr() to specify book, chapter and verse ranges:

assert __.name(___.bcr('Rom', 2, [(2, 3), 7])) == "Romans 2:2-3,7"

Formatting references

ref = ___.r('Rom 2:3-4,7')

assert __.name(ref) == 'Romans 2:3–4, 7'
assert __.book(ref) == 'Romans'
assert __.numbers(ref) == '2:3–4, 7'
assert __.abbrev_name(ref) == 'Rom 2:3–4, 7'
assert __.abbrev_book(ref) == 'Rom'
assert __.abbrev_numbers(ref) == '2:3–4, 7'

Some utility functions can be used to turn these into usable URL parameters if needed:

from refspy.utils import url_param, url_escape

ref = __.r('2 Cor 3:4-5')
assert url_param(__.abbrev_name(ref)) == '2+cor+3.4-5'
assert url_escape(__.abbrev_name(ref)) == '2%20Cor%203%3A4-5'

In general, though, templating is a better way to make links.

Templating references

bible_gateway = (
    '<a href="https://www.biblegateway.com/passage/'
  + '?search={ESC_ABBREV_NAME}&version=NRSVA">'
  + '{NAME}'
  + '</a>'
)
ref = __.r('2 Cor 3:4-5')
link = __.template(reference, bible_gateway) 

assert link.find('2%20Cor%203%3A4-5') > 0
assert link.find('2 Corinthians 3:4–5') > 0

The full list of template fields is:

Field	Output
`{NAME}`	`1 Corinthians 2:3–4`
`{BOOK}`	`1 Corinthians`
`{NUMBERS}`	`2:3–4`
`{ASCII_NUMBERS}`	`2:3-4`
`{ABBREV_NAME}`	`1 Cor 2:3–4`
`{ABBREV_BOOK}`	`1 Cor`
`{ABBREV_NUMBERS}`	`2:3–4`
`{ESC_NAME}`	`1%20Corinthians%202%3A3-4`
`{ESC_BOOK}`	`1%20Corinthians`
`{ESC_NUMBERS}`	`2%3A3-4`
`{ESC_ABBREV_NAME}`	`1%20Cor%202%3A3-4`
`{ESC_ABBREV_BOOK}`	`1%20Cor`
`{ESC_ABBREV_NUMBERS}`	`2%3A3-4`
`{PARAM_NAME}`	`1+cor+2.3-4`
`{PARAM_BOOK}`	`1+cor`
`{PARAM_NUMBERS}`	`2.3-4`

Templates can be passed as optional arguments to other rendering functions, say to generate links within indexes.

__.make_index(references, template=bible_gateway)

Comparing references

A reference can be a set of any valid verses and verse ranges spread across multiple books or even libraries.

rom_2 = __.r('Rom 2')
rom_4 = __.r('Rom 4')
rom_4a = __.bc('rom', 4)

assert rom_2 < rom_4
assert not rom_2 >= rom_4
assert rom_4 == rom_4a

Because references can be compared with <, they can also be sorted without any special functions, and used in min() and max().

assert __.sort_references([rom_4, rom_2]) == [rom_2, rom_4]
assert sorted([rom_4, rom_2]) == [rom_2, rom_4]  # <-- Same
assert min([rom_4, rom_2]) == rom_2

Contains, Overlaps, Adjoins

We will commonly want to know if one reference contains(), or overlaps() another. The adjoins() function works out adjacency for chapters and verses, but note it is limited by not knowing the lengths of chapters.

gen1 = __.r('Gen 1') 
gen2 = __.r('Gen 2') 
gen1_23_23 = __.r('Gen 1:22-23') 
gen1_24_28 = __.r('Gen 1:24-28')
  
assert gen1.contains(gen1_22_23)
assert gen1_22_23.overlaps(gen1)
assert gen1_22_23.adjoins(gen1_24_28)
assert gen1.adjoins(gen2)
assert not gen1.overlaps(gen2)

Sort, Merge, and Combine

References can be simplified by merging overlapping ranges and combining those that are adjacent.

assert __.merge_references([gen1_22_23, gen1]) == gen1
assert __.combine_references([gen1, gen2]) == __.r('Gen 1-2')
assert __.combine_references([gen1_22_23, gen1_24_28]) == __.r('Gen 1:22-28')

Under the hood, these methods just join the range lists together and merge or combine them into a new reference. (Note the * operator to unpack lists into arguments for reference().)

from refspy.range import merge_ranges, combine_ranges

assert reference(*merge_ranges(ranges)) == __.merge_references([reference(*ranges)])
assert reference(*combine_ranges(ranges)) == __.combine_references([reference(*ranges)])

Manipulating references

Among other transformations, references can be turned into their (first) book objects or references to just their books or chapters.

ref1 = __.ref('Rom 2:3-4,7')

assert __.get_book(ref1).chapters == 16
assert __.name(ref1.book_reference()) == 'Romans'
assert __.name(ref1.chapter_reference(ref1)) == 'Romans 2'

Navigating references

assert __.next_chapter(rom_2) == rom_3
assert __.prev_chapter(rom_2) == rom_1
assert __.prev_chapter(rom_1) == acts_28
assert __.prev_chapter(matt_1) is None

To create chapter references:

from refspy.libraries.en_US import NT

nt_chapter_refs_ = [  
  __.bcv(book.name, ch)   
  for ch in range(1, book.chapters)   
  for book in NT.books  
]

Matching references in text

To find references in text and print HTML links for them:

url = 'https://www.biblegateway.com/passage/?search=%s&version=NRSVA"

text = "Rom 1; 1 Cor 8:3,4; Rev 22:3-4"
   
strs, refs = __.find_references(text)
for match_str, ref in zip(strs, refs):
   print(f"{match_str} -> {url % __.param(ref)}")

Replacing references in text

To produce the demo image above, we use the sequential_replace function from refspy/utils:

from refspy.utils import sequential_replace

matches = __.find_references(text, include_books=True)
strs, tags = [], []
for match_str, ref in matches:
    strs.append(match_str)
    if ref.is_book():
        tags.append(f'<span class="yellow">{match_str}</span>')
    else:
        tags.append(
            f'<span class="green">{match_str}</span><sup>{__.abbrev(ref)}</sup>'
        )
html = sequential_replace(text, strs, tags)}

Collating and Indexing

To produce the index for the demo image above:

matches = __.find_references(text)

index = []
for library, book_collation in __.collate(
    sorted([ref for _, ref in matches])
):
    for book, reference_list in book_collation:
        new_reference = __.merge(reference_list)
        index.append(__.abbrev(new_reference))

html_list = "; ".join(index)

Internals

> cloc *.py *.toml *.md refspy tests

-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          35            710            847           2987
Markdown                         4            145              0            428
TOML                             1              5              0             30
Text                             3              1              0             30
-------------------------------------------------------------------------------
SUM:                            43            861            847           3475
-------------------------------------------------------------------------------

Glossary

Book, Format, Language, Library, Number, Range, Reference, and Verse are Pydantic types that will raise ValueErrors if initialised with bad data, say if a verse has Numbers outside the range 0..999, or if a Range has a start verse that is greater than its end verse.

Book. A book has id, name, abbrev, aliases, and chapters. No verse counts.
Format. The Format objects define what properties and characters to use when formatting references for various purposes.
Index. An integer which results from expanding a verse by powers of 1000; verse(1, 7, 16, 1) becomes the integer 1007016001. Used for database indexing.
Library. A library has id, name, abbrev, and a list of Books. See e.g. libraries/en_US.py. Library IDs are spaced out in a roughly historical order: OT is 200, NT is 400.
Number. An integer 1..999. We assume verses/chapters/books/libraries are limited to this size. This may need modifying to accommodate, say, zero verses in the Septuagint.
Range. A pair of (start, end) verses; 1 Cor 16:1-2 becomes range(verse(400, 7, 16, 1), verse(400, 7, 16, 2)).
Reference. A list of ranges; 1 Cor 16:1-2,6 becomes reference([range(verse(400, 7, 16, 1), verse(400, 7, 16, 2)), range(verse(400, 7, 16, 6), verse(400, 7, 16, 6))]). They do not automatically sort or simplify the ranges.
Verse. A quadruple of (library, book, chapter, verse) numbers; 1 Cor 16:1 becomes verse(400, 7, 16, 1)

Data Structures

Libraries and Books

Libraries and books are Pydantic BaseModels, which apply validation checks to the data whenever created or modified. These are defined by in locale files, such as refspy/languages/en_US.py:

OT = Library(
    id=200,
    name="Old Testament",
    abbrev="OT",
    books=[
        Book(
            id=1,
            name="Genesis",
            abbrev="Gen",
            aliases=[],
            chapters=50,
        ),
      ...
  ]
)

Any major class has its own file, so Library is defined in refspy/library.py and so on.

Books and libraries have names, abbrevs, and aliases. If URL params are needs, they are generated from these. So, the name '1 Corinthians' has the abbrev '1 Cor', wand generates the param '1+cor'. The languages/english.py file says that numeric prefixes must also match I and First (etc). The params are lowercase with no spaces.

Verses

A verse contains library, book, chapter, and verse numbers. The library, book, chapter, and verse numbers are all in 1-3 digits, in the range 1-999. It is assumed that there will not be 1000 or more verse in a chapter, chapters in a book, books in a library, or total libraries.

Refspy does not know or care how many verses there are in a chapter. It is expected that this will be determined from a database of texts by any client application, especially since not all verse numbers actually exist in texts (e.g. due to copying errors in the Vulgate at the time verse numbers were assigned). However, knowing the number of chapters per book allows the previous and next chapter to be determined, say, for navigating a library.

Verse(library=1, book=2, chapter=3, verse=4)
verse(1, 2, 3, 4)
verse(1, 2, 3, 1004)  # <-- ValueError

Index Numbers

Verses convert to an index value, verse(1, 2, 3, 4).index() == 1002003004 (UNSIGNED INT(12)), which allows efficient indexing in databases:

sql_clause = " OR ".join([
    f"({column_name} BETWEEN {range.start.index()} AND {range.end.index()})"
    for range in reference.ranges
])

Verses are read back with the class method refspy.verse.Verse.from_index().

Ranges

A range contains start and end verses.

A whole chapter is referenced as range(verse(1, 1, 1, 1), verse(1, 1, 1, 999)).

A whole book is referenced as range(verse(1, 1, 1, 1), verse(1, 1, 999, 999)).

So, a chapter or book contains every range and verse within that chapter or book, however long the chapter or book are.

Verses and ranges convert to tuples e.g. ((1, 2, 3, 4), (1, 2, 3, 5)) which can be sorted and compared.

Ranges can be tested for containment, overlap, or adjacency. Note that this does not take account of which verse numbers actually exist in any given text.

# Make ranges...
gen1 = range(verse(1, 1, 1, 1), verse(1, 1, 1, 999))
gen1_22_23 = range(verse(1, 1, 1, 22), verse(1, 1, 1, 23))
gen1_24_28 = range(verse(1, 1, 1, 24), verse(1, 1, 1, 28))
gen1 = range(verse(1, 1, 1, 1), verse(1, 1, 1, 999))
gen = range(verse(1, 1, 1, 1), verse(1, 1, 999, 999))
exod = range(verse(1, 2, 1, 1), verse(1, 2, 999, 999))

assert gen.is_book()
assert gen1.is_chapter()

assert gen1.contains(gen1_22_23)
assert gen1_22_23.overlaps(gen1)
assert gen1_22_23.adjoins(gen1_24_28)
assert gen1.adjoins(gen2)
assert not gen1.overlaps(gen2)
assert gen.adjoins(exod)
assert not gen.overlaps(exod)

Comparison operators can also be used, as well as sorting:

assert gen1 < gen2
assert not gen1 == gen2

gen_1_and_2 = range(verse(1, 1, 1, 1), verse(1, 1, 2, 999))

assert gen1 + gen2 == gen_1_and_2
assert sorted([gen2, gen1]) == [gen1, gen2]
assert min([gen2, gen1]) == gen1

References

References are lists of verse ranges. These are entirely numerical objects.

References, ranges, and verses have shorter constructor functions for programming convenience. Note reference() does not require list brackets.

Range(start=verse_1, end=verse_2)
range(verse_1, verse_2)

Reference(ranges=[range_1, range_2])
reference(range_1, range_2)

ref_1 = reference(
  range(verse(1, 1, 1, 1), verse(1, 1, 1, 3))
)

The reference module contains standalone functions for numeric reference construction that parallel the reference manager's __.bcv() method.

book = __.books[NT.id, 1]  # <-- Matthew is NT book ID 1
assert book_reference(NT.id, 1) == __.bcv(book.id)
assert chapter_reference(NT.id, 1, 2) == __.bcv(book.id, 2)
assert verse_reference(NT.id, 1, 2, 3) == __.bcv(book.id, 2, 3)
assert verse_reference(NT.id, 1, 2, 3, 4) == __.bcv(book.id, 2, 3, 4)

The same comparison operations that work on ranges also work on references. So references can be sorted(), min(), or max(). This becomes less intuitive the more complex their list of ranges becomes.

Name		Name	Last commit message	Last commit date
Latest commit History 110 Commits
.github/workflows		.github/workflows
docs		docs
media		media
refspy		refspy
tests		tests
.gitignore		.gitignore
.readthedocs.yaml		.readthedocs.yaml
CHANGES.md		CHANGES.md
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
TODO.md		TODO.md
demo.html		demo.html
demo.py		demo.py
pyproject.toml		pyproject.toml
requirements.txt		requirements.txt

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

README

Demo

Features

The Reference Manager

Creating references

Formatting references

Templating references

Comparing references

Contains, Overlaps, Adjoins

Sort, Merge, and Combine

Manipulating references

Navigating references

Matching references in text

Replacing references in text

Collating and Indexing

Internals

Glossary

Data Structures

Libraries and Books

Verses

Index Numbers

Ranges

References

About

Releases

Packages

Languages

License

eukras/refspy

Folders and files

Latest commit

History

Repository files navigation

README

Demo

Features

The Reference Manager

Creating references

Formatting references

Templating references

Comparing references

Contains, Overlaps, Adjoins

Sort, Merge, and Combine

Manipulating references

Navigating references

Matching references in text

Replacing references in text

Collating and Indexing

Internals

Glossary

Data Structures

Libraries and Books

Verses

Index Numbers

Ranges

References

About

Topics

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages