scripturelookup 0.0.1__py3-none-any.whl

scripturelookup/data.py

@@ -0,0 +1,58 @@
+# Python standard libraries
+import os
+import sys
+import json
+
+# Third-party libraries
+import requests
+
+
+data_directory = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'data')
+os.makedirs(data_directory, exist_ok = True)
+
+# Download JSON data
+def download_data(filename, filepath):
+  request_url = f'https://raw.githubusercontent.com/samuelbradshaw/python-scripture-scraper/refs/heads/main/sample/{filename}'
+  r = requests.get(request_url)
+  r.encoding = 'utf-8'
+  if r and r.status_code == 200:
+    data = r.content
+    with open(filepath, 'wb') as f:
+      f.write(data)
+  else:
+    sys.exit('\nError: Couldn’t download JSON data:\n{request_url}\n')
+
+# Load JSON data
+def load_data(filename):
+  filepath = os.path.join(data_directory, filename)
+  if os.path.isfile(filepath):
+    with open(filepath, 'r', encoding='utf-8') as f:
+      return json.load(f)
+  else:
+    download_data(filename, filepath)
+    load_data(filename)
+
+# Update JSON data
+def update_data():
+  for filename in ('metadata-languages.min.json', 'metadata-scriptures.min.json',):
+    download_data(filename, os.path.join(data_directory, filename))
+
+languages = load_data('metadata-languages.min.json')
+scriptures = load_data('metadata-scriptures.min.json')
+
+
+
+# Get the BCP 47 language tag for a given language code
+def get_bcp47(lang):
+  if lang and 'Hant' in lang:
+    lang = 'cmn-Hant'
+  elif lang and 'Hans' in lang:
+    lang = 'cmn-Hans'
+  
+  bcp47 = languages.get('mapToBcp47', {}).get(lang)
+  if not bcp47:
+    bcp47 = 'en'
+    if lang:
+      sys.stdout.write(f'Warning: Couldn’t find BCP 47 language tag for “{lang}” – falling back to “en” (English).\n')
+  
+  return bcp47

scripturelookup/lookup.py

@@ -0,0 +1,307 @@
+# Python standard libraries
+import sys
+import re
+import unicodedata
+
+# Internal imports
+from . import data, numbers
+
+
+class Reference:
+  def __init__(self, lang = 'en', publication_slug = None, book_slug = None, chapter = None, verse_groups = [], context_verse_groups = []):
+    self.lang = lang
+    self.publication_slug = publication_slug
+    self.book_slug = book_slug
+    self.chapter = chapter
+    self.verse_groups = verse_groups
+    self.context_verse_groups = context_verse_groups
+  
+  # Get a localized label (e.g. Old Testament, Genesis 1, Helaman 5:12, etc.)
+  def label(self, skip_book_name = False, abbreviated = False):
+    translated_names = data.scriptures['languages'][self.lang]['translatedNames']
+    english_translated_names = data.scriptures['languages']['en']['translatedNames']
+    
+    if self.publication_slug and not self.book_slug:
+      publication_name = translated_names.get(self.publication_slug, {}).get('name') or english_translated_names.get(self.publication_slug, {}).get('name')
+      if abbreviated:
+        publication_name = translated_names.get(self.publication_slug, {}).get('abbrev') or publication_name
+      return publication_name
+    
+    label = ''
+    book_slug = self.book_slug
+    if not skip_book_name:
+      if book_slug == 'psalms':
+        book_slug = 'psalm'
+      elif book_slug == 'sections':
+        book_slug = 'doctrine-and-covenants'
+      elif book_slug == 'official-declarations':
+        book_slug = 'official-declaration'
+      elif book_slug == 'facsimiles':
+        book_slug = 'facsimile'
+      elif book_slug == 'jst-psalms':
+        book_slug = 'jst-psalm'
+      
+      book_name = translated_names.get(book_slug, {}).get('name') or english_translated_names.get(book_slug, {}).get('name') or ''
+      if abbreviated:
+        book_name = translated_names.get(book_slug, {}).get('abbrev') or book_name
+      label += book_name
+    
+    if self.chapter:
+      punctuation = data.scriptures['languages'][self.lang]['punctuation']
+      numerals = data.scriptures['languages'][self.lang]['numerals']
+      if not skip_book_name:
+        label += punctuation['bookChapterSeparator']
+      
+      # Get localized chapter name
+      chapter_name = (
+        translated_names.get(self.chapter, {}).get('name') or
+        english_translated_names.get(self.chapter, {}).get('name') or
+        numbers.get_formatted_number(self.chapter, target_lang = self.lang, target_custom_numerals = numerals) or
+        punctuation['verseRangeSeparator'].join([numbers.get_formatted_number(ch, target_lang = self.lang, target_custom_numerals = numerals) for ch in re.split(verse_range_separators_pattern, self.chapter)]) or
+        self.chapter
+      )
+      if abbreviated:
+        chapter_name = translated_names.get(self.chapter, {}).get('abbrev') or chapter_name
+      label += chapter_name
+      
+      # Get localized verses
+      if self.verse_groups:
+        label += punctuation['chapterVerseSeparator']
+        label += convert_verse_groups_to_string(self.verse_groups, punctuation['verseRangeSeparator'], punctuation['verseGroupSeparator'], numerals, lang = self.lang)
+        if self.context_verse_groups:
+          label += punctuation['openingParenthesis'] + convert_verse_groups_to_string(self.context_verse_groups, punctuation['verseRangeSeparator'], punctuation['verseGroupSeparator'], numerals, lang = self.lang) + punctuation['closingParenthesis']
+    
+    return label
+  
+  # Get the Church URI (e.g. /scriptures/ot, /scriptures/bofm/1-ne/3.7)
+  def church_uri(self, use_query_parameters = False):
+    if self.publication_slug and not self.book_slug:
+      uri = data.scriptures['structure'].get(self.publication_slug, {}).get('churchUri')
+      return uri
+    
+    uri = ''
+    for publication_data in data.scriptures['structure'].values():
+      for slug, book_data in publication_data['books'].items():
+        if slug == self.book_slug:
+          uri += book_data['churchUri']
+          break
+    
+    if uri and self.chapter:
+      chapter = str(self.chapter)
+      if re.match(rf'\d+{verse_range_separators_pattern}\d+', chapter):
+        # Chapter range – only use the first chapter
+        chapter = re.split(verse_range_separators_pattern, chapter)[0]
+      uri += '/' + str(chapter)
+      if self.verse_groups:
+        if use_query_parameters:
+          uri += '?id=' + convert_verse_groups_to_string(self.verse_groups, '-', ',', verse_number_prefix = 'p')
+          if self.context_verse_groups:
+            uri += '&context=' + convert_verse_groups_to_string(self.context_verse_groups, '-', ',', verse_number_prefix = 'p')
+        else:
+          uri += '.' + convert_verse_groups_to_string(self.verse_groups, '-', ',')
+          if self.context_verse_groups:
+            uri += '(' + convert_verse_groups_to_string(self.context_verse_groups, '-', ',') + ')'
+    
+    return uri
+  
+  # Get the Church website URL (e.g. https://www.churchofjesuschrist.org/study/scriptures/bofm/1-ne/3?id=p7&lang=eng#p7)
+  # TODO: Add validation based on online availability in the given language
+  def church_url(self, skip_lang = False, skip_fragment = False):
+    url = 'https://www.churchofjesuschrist.org/study'
+    url += self.church_uri(use_query_parameters = True)
+    if not skip_lang:
+      church_lang = data.languages['languages'][self.lang]['churchLang']
+      url += f'&lang={church_lang}' if '?' in url else f'?lang={church_lang}'
+    if self.verse_groups and not skip_fragment:
+      url += '#p' + str(self.verse_groups[0][0])
+    return url
+  
+  # Get an HTML link to the Church website
+  def church_link(self, link_class = None, link_target = None, skip_book_name = False, abbreviated = False, skip_lang = False, skip_fragment = False):
+    additional_attributes = ''
+    if link_class:
+      additional_attributes += f' class="{link_class}"'
+    if link_target:
+      additional_attributes += f' target="{link_target}"'
+    label = self.label(skip_book_name = skip_book_name, abbreviated = abbreviated)
+    url = self.church_url(skip_lang = skip_lang, skip_fragment = skip_fragment)
+    return f'<a href="{url}"{additional_attributes}>{label}</a>'
+  
+  def __str__(self):
+    return label(self)
+
+
+reference_separators_pattern = r'|'.join([re.escape(s.strip()) for s in data.scriptures['summary']['punctuation']['referenceSeparator']] + [re.escape(';'), re.escape('\n')])
+chapter_verse_separators_pattern = r'|'.join([re.escape(s.strip()) for s in data.scriptures['summary']['punctuation']['chapterVerseSeparator']] + [re.escape(':')])
+verse_group_separators_pattern = r'|'.join([re.escape(s.strip()) for s in data.scriptures['summary']['punctuation']['verseGroupSeparator']] + [re.escape(',')])
+verse_range_separators_pattern = r'|'.join([re.escape(s.strip()) for s in data.scriptures['summary']['punctuation']['verseRangeSeparator']] + [re.escape('-'), re.escape('–'), re.escape('〜')])
+opening_parenthesis_pattern = r'|'.join([re.escape(s.strip()) for s in data.scriptures['summary']['punctuation']['openingParenthesis']] + [re.escape('(')])
+closing_parenthesis_pattern = r'|'.join([re.escape(s.strip()) for s in data.scriptures['summary']['punctuation']['closingParenthesis']] + [re.escape(')')])
+
+
+# Normalize text by removing anything that's not a letter or number, and converting to lowercase. This allows for a fuzzy comparison between input text and a known list of values.
+def normalizeForCompare(text):
+  decomposed_text = unicodedata.normalize('NFKD', text)
+  normalized_text = ''.join([c for c in decomposed_text if unicodedata.category(c)[0] in ['L', 'N']]).lower()
+  return normalized_text
+
+
+# Parse verses into verse groups
+# Example: '1-2,5-7' –> [[1, 2], [5, 6, 7]]
+def parse_verses_string(verses_string):
+  verses_string = (verses_string or '').replace('p', '').strip()
+  if not verses_string:
+    return None
+  
+  unique_verses = set()
+  for verse_group_string in re.split(verse_group_separators_pattern, verses_string):
+    verse_strings = re.split(verse_range_separators_pattern, verse_group_string)
+    lower_int = numbers.convert_number_to_int(verse_strings[0])
+    upper_int = numbers.convert_number_to_int(verse_strings[-1])
+    unique_verses.update(range(lower_int, upper_int + 1))
+  
+  verse_groups = []
+  verses = sorted(unique_verses)
+  previous_verse = -1
+  for verse in verses:
+    if verse == previous_verse + 1:
+      verse_groups[-1].append(verse)
+    else:
+      verse_groups.append([verse])
+    previous_verse = verse
+  
+  return verse_groups
+
+
+# Format verse groups to a localized string
+# Example: [[1, 2], [5, 6, 7]] –> '1-2,5-7'
+def convert_verse_groups_to_string(verse_groups, verse_range_separator, verse_group_separator, numerals = [], lang = 'en', verse_number_prefix = ''):
+  verse_ranges = []
+  for verse_group in verse_groups:
+    if verse_group[0] == verse_group[-1]:
+      verse_range = verse_number_prefix + numbers.get_formatted_number(verse_group[0], target_lang = lang, target_custom_numerals = numerals)
+    else:
+      verse_range = verse_number_prefix + numbers.get_formatted_number(verse_group[0], target_lang = lang, target_custom_numerals = numerals) + verse_range_separator + verse_number_prefix + numbers.get_formatted_number(verse_group[-1], target_lang = lang, target_custom_numerals = numerals)
+    verse_ranges.append(verse_range)
+  return verse_group_separator.join(verse_ranges)
+
+
+# Parse one or more scripture references, URIs, URLs, or slugs
+def parse_references_string(input_string, lang = 'en'):
+  lang = data.get_bcp47(lang)
+  
+  input_list = re.split(reference_separators_pattern, input_string)
+  references = []
+  
+  previous_book_slug = None
+  for input_string in input_list:
+    input_string = input_string.strip()
+    
+    verses_string = None
+    context_verses_string = None
+    chapter_string = None
+    book_string = None
+    
+    if '/scriptures/' in input_string:
+      # Church URI or URL
+      # Example: /scriptures/ot
+      # Example: /scriptures/ot/gen
+      # Example: /scriptures/ot/gen/1
+      # Example: /scriptures/ot/gen/1.1-3
+      # Example: gospellibrary://content/scriptures/ot/gen/3.1-3
+      # Example: http://lds.org/scriptures/ot/gen/3.1-3?lang=eng
+      # Example: https://www.churchofjesuschrist.org/study/scriptures/ot/gen/3?id=p1-p3&lang=eng#p1
+      
+      unparsed = '/scriptures/' + input_string.split('/scriptures/')[1]
+      query_string = None
+      if '?' in unparsed:
+        unparsed, query_string = unparsed.split('?')
+      
+      # Get verses string
+      if '.' in unparsed:
+        unparsed, verses_string = unparsed.split('.')
+        if '(' in verses_string:
+          verses_string, context_verses_string = verses_string.replace(')', '').split('(')
+      elif query_string:
+        if 'id=' in query_string:
+          verses_string = query_string.split('id=')[1].split('&')[0]
+          if 'context=' in query_string:
+            context_verses_string = query_string.split('context=')[1].split('&')[0]
+        elif '#' in query_string:
+          verses_string = query_string.split('#')[1]
+      
+      # Get chapter string and book string
+      book_string = unparsed
+      if book_string.count('/') > 3:
+        book_string, chapter_string = book_string.rsplit('/', 1)
+      
+    else:
+      # Scripture reference or slug
+      # Examples: Old Testament; 1 Nephi; Matthew 1; Helaman 5:12; words-of-mormon
+      
+      # Get verses string
+      unparsed, verses_string = (re.split(chapter_verse_separators_pattern, input_string) + [''])[:2]
+      verses_string, context_verses_string = (re.split(opening_parenthesis_pattern, re.sub(closing_parenthesis_pattern, '', verses_string)) + [''])[:2]
+      
+      # Get chapter string and book string
+      book_string = unparsed
+      chapter_match = re.match(rf'^(?:.*[^\d{verse_range_separators_pattern}])?([\d{verse_range_separators_pattern}]*)$', book_string)
+      if chapter_match:
+        chapter_string = chapter_match.group(1)
+        book_string = book_string.removesuffix(chapter_string).strip()
+    
+    verse_groups = parse_verses_string(verses_string)
+    context_verse_groups = parse_verses_string(context_verses_string)
+    chapter = numbers.convert_number_to_int(chapter_string)
+    book_slug = None
+    skip_book_name = False
+    if book_string:
+      book_slug = data.scriptures['mapToSlug'].get(book_string, None)
+      if not book_slug:
+        for key, value in data.scriptures['mapToSlug'].items():
+          if normalizeForCompare(book_string) == normalizeForCompare(key):
+            book_slug = value
+            break
+      if book_slug == previous_book_slug:
+        skip_book_name = True
+      previous_book_slug = book_slug
+    else:
+      book_slug = previous_book_slug
+      skip_book_name = True
+    
+    publication_slug = None
+    if book_slug in data.scriptures['structure'].keys():
+      publication_slug = book_slug
+      book_slug = None
+    
+    reference = Reference(lang = lang, publication_slug = publication_slug, book_slug = book_slug, chapter = chapter, verse_groups = verse_groups, context_verse_groups = context_verse_groups)
+    references.append(reference)
+    
+  return references
+
+
+
+def get_label(input_string, lang = 'en', separator = '\n', skip_book_name = False, abbreviated = False, **kwargs):
+  references = parse_references_string(input_string, lang = lang)
+  return separator.join([ref.label(skip_book_name = skip_book_name, abbreviated = abbreviated) for ref in references])
+
+def get_church_uri(input_string, separator = '\n', use_query_parameters = False, **kwargs):
+  references = parse_references_string(input_string)
+  return separator.join([ref.church_uri(use_query_parameters = use_query_parameters) for ref in references])
+
+def get_church_url(input_string, lang = 'en', separator = '\n', skip_lang = False, skip_fragment = False, **kwargs):
+  references = parse_references_string(input_string, lang = lang)
+  return separator.join([ref.church_url(skip_lang = skip_lang, skip_fragment = skip_fragment) for ref in references])
+
+def get_church_link(input_string, lang = 'en', separator = '\n', link_class = None, link_target = None, skip_book_name = False, abbreviated = False, skip_lang = False, skip_fragment = False, **kwargs):
+  references = parse_references_string(input_string, lang = lang)
+  return separator.join([ref.church_link(link_class = link_class, link_target = link_target, skip_book_name = skip_book_name, abbreviated = abbreviated, skip_lang = skip_lang, skip_fragment = skip_fragment) for ref in references])
+  
+def get_langs(**kwargs):
+  return data.scriptures['languages'].keys()
+
+def get_punctuation(lang = 'en', **kwargs):
+  return data.scriptures['languages'][lang]['punctuation']
+
+def get_numerals(lang = 'en', **kwargs):
+  return data.scriptures['languages'][lang]['numerals']

scripturelookup/numbers.py

@@ -0,0 +1,267 @@
+# Python standard libraries
+import sys
+import importlib
+
+# Third-party libraries
+GeezGeezify = importlib.import_module('geezify-python-main.geezify', package='...').Geezify
+GeezArabify = importlib.import_module('geezify-python-main.arabify', package='...').Arabify
+
+
+# Format a positive whole number to a specified language or numeral system
+# Either a target_lang, target_format, or target_custom_numerals must be provided
+# Supported target formats:
+#   --- STANDARD DECIMAL ---
+#   decimal-int (ex: 14)
+#   decimal-string (ex: '14') – default for most languages
+#   --- SIMPLE CONVERSION ---
+#   arabic-eastern (ex: ١٤) – default if target_lang is 'ar'
+#   arabic-extended (ex: ۱۴) – default if target_lang is 'fa' OR 'ur'
+#   devangari (ex: १४) – default if target_lang is 'ne'
+#   khmer (ex: ១៤) – default if target_lang is 'km'
+#   myanmar (ex: ၁၄) – default if target_lang is 'my'
+#   thai (ex: ๑๔) – default if target_lang is 'th'
+#   custom – requires numerals 0–9 to be passed in as a list
+#   --- COMPLEX CONVERSION ---
+#   chinese-simplified (ex: 十四)
+#   chinese-traditional (ex: 十四)
+#   decimal-fullwidth (ex: '14') – uses full-width numeral only if the number is a single digit
+#   geez (ex: ፲፬) – default if target_lang is 'am'
+#   roman-upper (ex: 'XIV')
+#   roman-lower (ex: 'xiv')
+#   alphabet-upper (ex: 'N')
+#   alphabet-lower (ex: 'n')
+def get_formatted_number(number, target_lang = None, target_format = None, target_custom_numerals = []):
+  formatted_number = ''
+  
+  try:
+    int_number = abs(convert_number_to_int(number))
+  except:
+    # Number can't be formatted (ex: 56-57 OR fac-1)
+    return formatted_number
+    
+  if target_custom_numerals:
+    target_format = 'custom'
+  if not target_format:
+    if target_lang in ('ar',):
+      target_format = 'arabic-eastern'
+    elif target_lang in ('fa', 'ur',):
+      target_format = 'arabic-extended'
+    elif target_lang in ('ne',):
+      target_format = 'devangari'
+    elif target_lang in ('km',):
+      target_format = 'khmer'
+    elif target_lang in ('my',):
+      target_format = 'myanmar'
+    elif target_lang in ('th',):
+      target_format = 'thai'
+    elif target_lang in ('am',):
+      target_format = 'geez'
+    else:
+      target_format = 'decimal-string'
+  
+  # Numerals 0–9: ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9']
+  simple_numeral_mapping = {
+    'arabic-eastern': ['٠', '١', '٢', '٣', '٤', '٥', '٦', '٧', '٨', '٩'],
+    'arabic-extended': ['۰', '۱', '۲', '۳', '۴', '۵', '۶', '۷', '۸', '۹'],
+    'devangari': ['०', '१', '२', '३', '४', '५', '६', '७', '८', '९'],
+    'khmer': ['០', '១', '២', '៣', '៤', '៥', '៦', '៧', '៨', '៩'],
+    'myanmar': ['၀', '၁', '၂', '၃', '၄', '၅', '၆', '၇', '၈', '၉'],
+    'thai': ['๐', '๑', '๒', '๓', '๔', '๕', '๖', '๗', '๘', '๙'],
+    'custom': target_custom_numerals,
+  }
+  
+  if int_number is not None:
+    # Standard decimal
+    if target_format == 'decimal-int':
+      formatted_number = int_number
+    elif target_format == 'decimal-string':
+      formatted_number = str(int_number)
+    
+    # Simple conversion
+    elif target_format in ('arabic-eastern', 'arabic-extended', 'devangari', 'khmer', 'myanmar', 'thai', 'custom'):
+      formatted_number = ''
+      for digit in str(int_number):
+        formatted_number += simple_numeral_mapping[target_format][int(digit)]
+    
+    # Complex conversion
+    elif target_format == 'chinese-simplified':
+      formatted_number = format_number_chinese(int_number, script = 'Hans')
+    elif target_format == 'chinese-traditional':
+      formatted_number = format_number_chinese(int_number, script = 'Hant')
+    elif target_format == 'decimal-fullwidth':
+      formatted_number = format_number_fullwidth(int_number, convert_one_digit = True, convert_two_digits = False, convert_more_than_two_digits = False)
+    elif target_format == 'geez':
+      formatted_number = format_number_geez(int_number)
+    elif target_format == 'roman-upper':
+      formatted_number = format_number_roman(int_number, uppercase = True)
+    elif target_format == 'roman-lower':
+      formatted_number = format_number_roman(int_number, uppercase = False)
+    elif target_format == 'alphabet-upper':
+      formatted_number = format_number_alphabet(int_number, uppercase = True)
+    elif target_format == 'alphabet-lower':
+      formatted_number = format_number_alphabet(int_number, uppercase = False)
+  
+  return formatted_number
+  
+
+# Convert a formatted number to an integer
+def convert_number_to_int(number):
+  int_number = None
+  
+  if isinstance(number, int) or isinstance(number, float):
+    int_number = int(number)
+  
+  elif isinstance(number, str) and len(number) > 0:
+    number = number.strip()
+    try:
+      int_number = int(number)
+    except:
+      if all(char in ['〇', '零', '一', '二', '三', '四', '五', '六', '七', '八', '九', '十', '百', '千', '万', '萬', '亿', '億'] for char in number):
+        int_number = chinese_numerals_to_int(number)
+      elif all(char in ['፲', '፳', '፴', '፵', '፶', '፷', '፸', '፹', '፺', '፻'] for char in number):
+        int_number = geez_numerals_to_int(number)
+      elif all(char in ['I', 'V', 'X', 'L', 'C', 'D', 'M', 'i', 'v', 'x', 'l', 'c', 'd', 'm'] for char in number):
+        int_number = roman_numerals_to_int(number)
+      elif all(char in ['A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z'] for char in number):
+        int_number = alphabet_numerals_to_int(number)
+      else:
+        int_number = number
+  
+  return int_number or None
+
+
+# Convert a formatted number (Chinese numerals) to an integer
+def chinese_numerals_to_int(number):
+  # TODO: Not yet implemented
+  sys.stdout.write('Warning: Conversion from Chinese numerals to an integer is not yet implemented.\n')
+  pass
+
+
+# Convert a formatted number (Geʽez numerals) to an integer
+def geez_numerals_to_int(number):
+  return GeezArabify.arabify(number)
+
+
+# Convert a formatted number (Roman numerals) to an integer
+# Algorithm adapted from:
+#   https://stackoverflow.com/a/48557664
+#   License: CC BY-SA 4.0 (https://creativecommons.org/licenses/by-sa/4.0/)
+def roman_numerals_to_int(number):
+  number = number.upper()
+  int_number = 0
+  
+  roman_numeral_values = { 'I': 1, 'V': 5, 'X': 10, 'L': 50, 'C': 100, 'D': 500, 'M': 1000 }
+  for i, c in enumerate(number):
+    if (i + 1) == len(number) or roman_numeral_values[c] >= roman_numeral_values[number[i + 1]]:
+      int_number += roman_numeral_values[c]
+    else:
+      int_number -= roman_numeral_values[c]
+  
+  return int_number
+
+
+# Convert a formatted number (alphabet numerals) to an integer
+def alphabet_numerals_to_int(number):
+  number = number.upper()
+  
+  # Algorithm adapted from:
+  #   https://stackoverflow.com/a/63013258
+  #   License: CC BY-SA 4.0 (https://creativecommons.org/licenses/by-sa/4.0/)
+  def recursive_letters_to_number(s):
+    n = ord(s[-1]) - 64
+    if s[:-1]:
+      return 26 * (recursive_letters_to_number(s[:-1])) + n
+    else:
+      return n
+  
+  return recursive_letters_to_number(number)
+
+
+# Convert an integer to Chinese numerals
+def format_number_chinese(int_number, script = 'Hans'):
+  int_number = int(int_number)
+  # TODO: Not yet implemented
+  sys.stdout.write('Warning: Conversion from an integer to Chinese numerals is not yet implemented.\n')
+  return str(int_number)
+
+
+# Convert an integer to fullwidth numerals
+def format_number_fullwidth(int_number, convert_one_digit = True, convert_two_digits = False, convert_more_than_two_digits = False):
+  num_digits = len(str(int_number))
+  fullwidth_numerals = ['０', '１', '２',	'３',	'４',	'５',	'６',	'７',	'８',	'９']
+  
+  if (num_digits == 1 and convert_one_digit) or (num_digits == 2 and convert_two_digits) or (num_digits > 2 and convert_more_than_two_digits):
+    formatted_number = ''
+    for digit in str(int_number):
+      formatted_number += fullwidth_numerals[int(digit)]
+  else:
+    formatted_number = str(int_number)
+  
+  return formatted_number
+
+
+# Convert an integer to Geʽez numerals
+def format_number_geez(int_number):
+  int_number = int(int_number)
+  return GeezGeezify.geezify(int_number)
+
+
+# Convert an integer to Roman numerals
+# Corresponds to /r or /R number style in PDF specification (/PageLabels)
+# Algorithm adapted from:
+#   https://stackoverflow.com/a/35728954
+#   License: CC BY-SA 4.0 (https://creativecommons.org/licenses/by-sa/4.0/)
+def format_number_roman(int_number, uppercase = True):
+  int_number = int(int_number)
+  formatted_number = ''
+  
+  if int_number < 1:
+    return formatted_number
+  
+  while int_number >= 1000:
+    formatted_number += 'm'
+    int_number -= 1000
+  
+  diffs = [900, 500, 400, 300, 200, 100, 90, 50, 40, 30, 20, 10, 9, 5, 4, 3, 2, 1]
+  digits = ['cm', 'd', 'cd', 'ccc', 'cc', 'c', 'xc', 'l', 'xl', 'xxx', 'xx', 'x', 'ix', 'v', 'iv', 'iii', 'ii', 'i']
+  
+  for i in range(len(diffs)):
+    if int_number >= diffs[i]:
+      formatted_number += digits[i]
+      int_number -= diffs[i]
+  
+  if uppercase:
+    formatted_number = formatted_number.upper()
+  
+  return formatted_number
+
+
+# Convert an integer to alphabet numerals (A, B, … Z, AA, AB, … AZ, etc.)
+# Corresponds to /a or /A number style in PDF specification (/PageLabels)
+# Also corresponds to how columns are numbered in a spreadsheet
+def format_number_alphabet(int_number, uppercase = True):
+  int_number = int(int_number)
+  formatted_number = ''
+  
+  if int_number < 1:
+    return formatted_number
+  
+  # Algorithm adapted from:
+  #   https://stackoverflow.com/a/63013258
+  #   License: CC BY-SA 4.0 (https://creativecommons.org/licenses/by-sa/4.0/)
+  def recursive_number_to_letters(n):
+    letters = list('abcdefghijklmnopqrstuvwxyz')
+    n, remainder = divmod(n - 1, 26)
+    char = letters[remainder]
+    if n:
+      return recursive_number_to_letters(n) + char
+    else:
+      return char
+
+  formatted_number = recursive_number_to_letters(int_number)
+  
+  if uppercase:
+    formatted_number = formatted_number.upper()
+  
+  return formatted_number
+

scripturelookup-0.0.1.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Samuel Bradshaw
+
+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.