scripturelookup 0.0.1__tar.gz → 0.0.2__tar.gz

{scripturelookup-0.0.1 → scripturelookup-0.0.2}/.gitignore

@@ -7,3 +7,4 @@ __pycache__/
 Icon?
 *~
 
+localtesting.py

scripturelookup-0.0.2/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.1
+Name: scripturelookup
+Version: 0.0.2
+Summary: Python and command-line utility for converting scripture references between formats.
+Author-email: Samuel Bradshaw <samuel.h.bradshaw@gmail.com>
+License: 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.
+Project-URL: Repository, https://github.com/samuelbradshaw/python-scripture-lookup
+Project-URL: Issues, https://github.com/samuelbradshaw/python-scripture-lookup/issues
+Project-URL: Changelog, https://github.com/samuelbradshaw/python-scripture-lookup/releases
+Keywords: python,command,scripture,bible,book of mormon,reference
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+
+# Scripture Lookup
+
+Scripture Lookup is a Python library and command-line tool for looking up scripture verses or chapters. It can also convert scripture references between formats and languages. The tool is built around data from [Python Scripture Scraper](https://github.com/samuelbradshaw/python-scripture-scraper).
+
+
+## Installation
+
+The Python package and command-line tool can be installed from [PyPI](https://pypi.org/project/scripturelookup/) via pip:
+```
+pip install scripturelookup
+```
+
+
+## Command-line usage
+
+Pattern:
+```
+scripturelookup [command] [input] [options]
+```
+
+Examples:
+```
+% scripturelookup get_content "john 3:16" --lang "en"
+16 ¶ For God so loved the world, that he gave his only begotten Son, that whosoever believeth in him should not perish, but have everlasting life.
+
+% scripturelookup get_label "니파이전서 3:7" --lang "fr" --abbreviated
+1 Né 3:7
+
+% scripturelookup get_church_url "helaman 5:12"
+https://www.churchofjesuschrist.org/study/scriptures/bofm/hel/5?id=p12&lang=eng#p12
+
+% scripturelookup get_label "/scriptures/nt/1-jn/3.2-3" --lang "cmn-Hant"
+約翰一書3：2-3
+
+% scripturelookup get_church_url "/scriptures/ot" --lang "es"
+https://www.churchofjesuschrist.org/study/scriptures/ot?lang=spa
+```
+
+
+## Python usage
+
+Examples:
+```
+from scripturelookup import lookup
+
+lookup.get_content('john 3:16', lang = 'en')
+# 16 ¶ For God so loved the world, that he gave his only begotten Son, that whosoever believeth in him should not perish, but have everlasting life.
+
+lookup.get_label('니파이전서 3:7', lang = 'fr', abbreviated = True)
+# 1 Né 3:7
+
+lookup.get_church_url('helaman 5:12')
+# https://www.churchofjesuschrist.org/study/scriptures/bofm/hel/5?id=p12&lang=eng#p12
+
+lookup.get_label('/scriptures/nt/1-jn/3.2-3', lang = 'cmn-Hant')
+# 約翰一書3：2-3
+
+lookup.get_church_url('/scriptures/ot', lang = 'es')
+# https://www.churchofjesuschrist.org/study/scriptures/ot?lang=spa
+```
+
+
+## Commands, inputs, and options
+
+### Commands
+
+- **get_content** – Get chapter or verse content.
+- **get_label** – Get a scripture reference label (i.e. "John 3:16").
+- **get_church_uri** – Get a Gospel Library URI (i.e. "/scriptures/bofm/hel/5.12").
+- **get_church_url** – Get a Gospel Library URL.
+- **get_church_link** – Get an HTML link to Gospel Library.
+
+### Inputs
+
+Any of the following input types are supported. You can also provide several inputs at once as a list (separated by semicolons or line-breaks).
+
+- Chapter or verse references, in any supported language. Examples:
+  - John 3:16
+  - Enos 1:13, 15–18
+  - Psalm 23
+  - Gen. 1:3 (3–4)
+  - D&C 20:23; 76:41
+- Scripture publication or book names. Examples:
+  - Old Testament
+  - Book of Mormon
+  - 1 Corinthians
+  - Psalms
+- Gospel Library URIs (starting with `/scriptures`). Examples:
+  - /scriptures/ot/gen
+  - /scriptures/nt/matt/1
+  - /scriptures/nt/john/3.16
+  - /scriptures/bofm/enos/1.13,15-18
+  - /scriptures/pgp
+- Gospel Library URLs (old or new). Examples:
+  - https://www.churchofjesuschrist.org/study/scriptures/bofm/hel/5?id=p12&lang=eng#p12
+  - https://www.churchofjesuschrist.org/study/scriptures/ot?lang=eng
+  - http://lds.org/scriptures/bofm/1-ne/3.7?lang=eng
+
+### Options
+
+Several options are available. Some are only applicable to certain commands.
+
+- **lang** (optional) – Output language. BCP 47 language codes and Gospel Library language codes are supported. Default: 'en'.
+- **separator** (optional) – String separator between outputs when a list of references is being requested. Default: '\n'.
+- **source** (optional) – Content source. Default: 'python-scripture-scraper'. Supported values: 'python-scripture-scraper' or 'ChurchofJesusChrist.org'.
+- **link_class** (optional) – String for the “class” attribute on links. Default: None.
+- **link_target** (optional) – String for the “target” attribute on links. Default: None.
+- **use_query_parameters** (optional) – Whether query parameters should be used on URIs. Default: False.
+- **skip_lang** (optional) – Whether “lang” query parameters should be skipped on URLs. Default: False.
+- **skip_fragment** (optional) – Whether fragments should be skipped on URLs. Default: False.
+- **skip_book_name** (optional) – Whether book names should be skipped on labels. Default: False.
+- **abbreviated** (optional) – Whether book abbrevions should be used on labels. Default: False.
+
+
+## Acknowledgements
+[Python Scripture Scraper](https://github.com/samuelbradshaw/python-scripture-scraper) – tool for scraping scripture content and metadata from ChurchofJesusChrist.org.
+[geezify-python](https://github.com/logicalperson0/geezify-python) – tool for converting numbers to and from Geez numerals.

scripturelookup-0.0.2/README.md

@@ -0,0 +1,117 @@
+# Scripture Lookup
+
+Scripture Lookup is a Python library and command-line tool for looking up scripture verses or chapters. It can also convert scripture references between formats and languages. The tool is built around data from [Python Scripture Scraper](https://github.com/samuelbradshaw/python-scripture-scraper).
+
+
+## Installation
+
+The Python package and command-line tool can be installed from [PyPI](https://pypi.org/project/scripturelookup/) via pip:
+```
+pip install scripturelookup
+```
+
+
+## Command-line usage
+
+Pattern:
+```
+scripturelookup [command] [input] [options]
+```
+
+Examples:
+```
+% scripturelookup get_content "john 3:16" --lang "en"
+16 ¶ For God so loved the world, that he gave his only begotten Son, that whosoever believeth in him should not perish, but have everlasting life.
+
+% scripturelookup get_label "니파이전서 3:7" --lang "fr" --abbreviated
+1 Né 3:7
+
+% scripturelookup get_church_url "helaman 5:12"
+https://www.churchofjesuschrist.org/study/scriptures/bofm/hel/5?id=p12&lang=eng#p12
+
+% scripturelookup get_label "/scriptures/nt/1-jn/3.2-3" --lang "cmn-Hant"
+約翰一書3：2-3
+
+% scripturelookup get_church_url "/scriptures/ot" --lang "es"
+https://www.churchofjesuschrist.org/study/scriptures/ot?lang=spa
+```
+
+
+## Python usage
+
+Examples:
+```
+from scripturelookup import lookup
+
+lookup.get_content('john 3:16', lang = 'en')
+# 16 ¶ For God so loved the world, that he gave his only begotten Son, that whosoever believeth in him should not perish, but have everlasting life.
+
+lookup.get_label('니파이전서 3:7', lang = 'fr', abbreviated = True)
+# 1 Né 3:7
+
+lookup.get_church_url('helaman 5:12')
+# https://www.churchofjesuschrist.org/study/scriptures/bofm/hel/5?id=p12&lang=eng#p12
+
+lookup.get_label('/scriptures/nt/1-jn/3.2-3', lang = 'cmn-Hant')
+# 約翰一書3：2-3
+
+lookup.get_church_url('/scriptures/ot', lang = 'es')
+# https://www.churchofjesuschrist.org/study/scriptures/ot?lang=spa
+```
+
+
+## Commands, inputs, and options
+
+### Commands
+
+- **get_content** – Get chapter or verse content.
+- **get_label** – Get a scripture reference label (i.e. "John 3:16").
+- **get_church_uri** – Get a Gospel Library URI (i.e. "/scriptures/bofm/hel/5.12").
+- **get_church_url** – Get a Gospel Library URL.
+- **get_church_link** – Get an HTML link to Gospel Library.
+
+### Inputs
+
+Any of the following input types are supported. You can also provide several inputs at once as a list (separated by semicolons or line-breaks).
+
+- Chapter or verse references, in any supported language. Examples:
+  - John 3:16
+  - Enos 1:13, 15–18
+  - Psalm 23
+  - Gen. 1:3 (3–4)
+  - D&C 20:23; 76:41
+- Scripture publication or book names. Examples:
+  - Old Testament
+  - Book of Mormon
+  - 1 Corinthians
+  - Psalms
+- Gospel Library URIs (starting with `/scriptures`). Examples:
+  - /scriptures/ot/gen
+  - /scriptures/nt/matt/1
+  - /scriptures/nt/john/3.16
+  - /scriptures/bofm/enos/1.13,15-18
+  - /scriptures/pgp
+- Gospel Library URLs (old or new). Examples:
+  - https://www.churchofjesuschrist.org/study/scriptures/bofm/hel/5?id=p12&lang=eng#p12
+  - https://www.churchofjesuschrist.org/study/scriptures/ot?lang=eng
+  - http://lds.org/scriptures/bofm/1-ne/3.7?lang=eng
+
+### Options
+
+Several options are available. Some are only applicable to certain commands.
+
+- **lang** (optional) – Output language. BCP 47 language codes and Gospel Library language codes are supported. Default: 'en'.
+- **separator** (optional) – String separator between outputs when a list of references is being requested. Default: '\n'.
+- **source** (optional) – Content source. Default: 'python-scripture-scraper'. Supported values: 'python-scripture-scraper' or 'ChurchofJesusChrist.org'.
+- **link_class** (optional) – String for the “class” attribute on links. Default: None.
+- **link_target** (optional) – String for the “target” attribute on links. Default: None.
+- **use_query_parameters** (optional) – Whether query parameters should be used on URIs. Default: False.
+- **skip_lang** (optional) – Whether “lang” query parameters should be skipped on URLs. Default: False.
+- **skip_fragment** (optional) – Whether fragments should be skipped on URLs. Default: False.
+- **skip_book_name** (optional) – Whether book names should be skipped on labels. Default: False.
+- **abbreviated** (optional) – Whether book abbrevions should be used on labels. Default: False.
+
+
+## Acknowledgements
+[Python Scripture Scraper](https://github.com/samuelbradshaw/python-scripture-scraper) – tool for scraping scripture content and metadata from ChurchofJesusChrist.org.
+[geezify-python](https://github.com/logicalperson0/geezify-python) – tool for converting numbers to and from Geez numerals.

scripturelookup-0.0.2/requirements.txt

@@ -0,0 +1,2 @@
+requests==2.32.3
+beautifulsoup4==4.12.3

{scripturelookup-0.0.1 → scripturelookup-0.0.2}/src/scripturelookup/command_line.py

@@ -7,9 +7,10 @@ from . import data, numbers, lookup
 def main_cli():
   parser = argparse.ArgumentParser(description='Scripture lookup')
   parser.add_argument('command', help='Command to run. Required.')
-  parser.add_argument('--input', help='Input text to parse (one or more references).')
+  parser.add_argument('input', help='Input text to parse (one or more references).')
   parser.add_argument('--lang', help='Output language. Default: "en".')
   parser.add_argument('--separator', help='Separator when there are multiple results. Default: "\n".')
+  parser.add_argument('--source', help='Content source ("python-scripture-scraper" or "ChurchofJesusChrist.org"). Default: "python-scripture-scraper".')
   parser.add_argument('--link_class', help='Link "class" attribute.')
   parser.add_argument('--link_target', help='Link "target" attribute.')
   parser.add_argument('--use_query_parameters', action='store_true', help='Use "id" and "context" parameters in URIs.')
@@ -25,6 +26,7 @@ def main_cli():
     args.input,
     lang = args.lang or 'en',
     separator = args.separator or '\n',
+    source = args.source or 'python-scripture-scraper',
     link_class = args.link_class,
     link_target = args.link_target,
     use_query_parameters = args.use_query_parameters,

scripturelookup-0.0.2/src/scripturelookup/data.py

@@ -0,0 +1,117 @@
+# Python standard libraries
+import os
+import sys
+import json
+import time
+
+# Third-party libraries
+import requests
+from bs4 import BeautifulSoup
+
+
+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://cdn.jsdelivr.net/gh/samuelbradshaw/python-scripture-scraper@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
+
+
+# Get the content for a given chapter verse from python-scripture-scraper or ChurchofJesusChrist.org
+def request_content(publication_slug, book_slug, chapter, verse_groups, church_url, lang = 'en', source = 'python-scripture-scraper'):
+  text_content = ''
+  
+  if not publication_slug and book_slug and chapter:
+    return text_content
+  
+  verse_numbers = []
+  if verse_groups:
+    for verse_group in verse_groups:
+      for verse_number in verse_group:
+        verse_numbers.append(str(verse_number))
+  
+  if source == 'python-scripture-scraper':
+    request_url = f'https://cdn.jsdelivr.net/gh/samuelbradshaw/python-scripture-scraper@main/sample/en-json/{publication_slug}/{book_slug}/{book_slug}-{chapter}.json'
+    r = requests.get(request_url)
+    r.encoding = 'utf-8'
+    if r and r.status_code == 200:
+      chapter_data = r.json()
+      
+      if verse_numbers:
+        for paragraph in chapter_data['paragraphs']:
+          if paragraph['type'] == 'verse' and paragraph['number'] in verse_numbers:
+            text_content += paragraph['number'] + ' ' + paragraph['content'] + '\n\n'
+      else:
+        for paragraph in chapter_data['paragraphs']:
+          text_content += (paragraph['number'] + ' ' if paragraph['number'] else '') + paragraph['content'] + '\n\n'
+      
+      text_content += '---------------------\n'
+      text_content += 'Source: https://github.com/samuelbradshaw/python-scripture-scraper/tree/main/sample\n'
+      text_content += 'Public domain.\n'
+  
+  elif source == 'ChurchofJesusChrist.org' and church_url:
+    r = requests.get(church_url)
+    r.encoding = 'utf-8'
+    if r and r.status_code == 200:
+      soup = BeautifulSoup(r.text, 'html.parser')
+      paragraphs = soup.select('header [data-aid], .body-block [data-aid]')
+      if verse_numbers:
+        for paragraph in paragraphs:
+          verse_number_span = paragraph.select_one('.verse-number')
+          if verse_number_span and verse_number_span.text.strip() in verse_numbers:
+            text_content += paragraph.text.strip() + '\n\n'
+      else:
+        for paragraph in paragraphs:
+          text_content += paragraph.text.strip() + '\n\n'
+        
+      text_content += '---------------------\n'
+      text_content += f'Source: {church_url}\n'
+      text_content += 'Some content from this source may be subject to copyright.\n'
+      
+      # Pause for 1 second between requests to avoid overloading server
+      time.sleep(1)
+    
+  return text_content
+

{scripturelookup-0.0.1 → scripturelookup-0.0.2}/src/scripturelookup/lookup.py

@@ -105,11 +105,12 @@ class Reference:
     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:
+      if self.lang not in data.scriptures['summary']['churchAvailability'][self.publication_slug]:
+        return ''
       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:
@@ -127,6 +128,10 @@ class Reference:
     url = self.church_url(skip_lang = skip_lang, skip_fragment = skip_fragment)
     return f'<a href="{url}"{additional_attributes}>{label}</a>'
   
+  # Get chapter or verse content
+  def content(self, source):
+    return data.request_content(self.publication_slug, self.book_slug, self.chapter, self.verse_groups, self.church_url(), lang = self.lang, source = source)
+  
   def __str__(self):
     return label(self)
 
@@ -273,6 +278,10 @@ def parse_references_string(input_string, lang = 'en'):
     if book_slug in data.scriptures['structure'].keys():
       publication_slug = book_slug
       book_slug = None
+    else:
+      for pub_slug, pub_data in data.scriptures['structure'].items():
+        if book_slug in pub_data['books'].keys():
+          publication_slug = pub_slug
     
     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)
@@ -280,6 +289,11 @@ def parse_references_string(input_string, lang = 'en'):
   return references
 
 
+# Functions that can be called via Python or from the command line (see README.md for more information)
+
+def get_content(input_string, lang = 'en', separator = '\n', source = 'python-scripture-scraper', **kwargs):
+  references = parse_references_string(input_string, lang = lang)
+  return separator.join([ref.content(source = source) for ref in 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)

scripturelookup-0.0.2/src/scripturelookup.egg-info/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.1
+Name: scripturelookup
+Version: 0.0.2
+Summary: Python and command-line utility for converting scripture references between formats.
+Author-email: Samuel Bradshaw <samuel.h.bradshaw@gmail.com>
+License: 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.
+Project-URL: Repository, https://github.com/samuelbradshaw/python-scripture-lookup
+Project-URL: Issues, https://github.com/samuelbradshaw/python-scripture-lookup/issues
+Project-URL: Changelog, https://github.com/samuelbradshaw/python-scripture-lookup/releases
+Keywords: python,command,scripture,bible,book of mormon,reference
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+
+# Scripture Lookup
+
+Scripture Lookup is a Python library and command-line tool for looking up scripture verses or chapters. It can also convert scripture references between formats and languages. The tool is built around data from [Python Scripture Scraper](https://github.com/samuelbradshaw/python-scripture-scraper).
+
+
+## Installation
+
+The Python package and command-line tool can be installed from [PyPI](https://pypi.org/project/scripturelookup/) via pip:
+```
+pip install scripturelookup
+```
+
+
+## Command-line usage
+
+Pattern:
+```
+scripturelookup [command] [input] [options]
+```
+
+Examples:
+```
+% scripturelookup get_content "john 3:16" --lang "en"
+16 ¶ For God so loved the world, that he gave his only begotten Son, that whosoever believeth in him should not perish, but have everlasting life.
+
+% scripturelookup get_label "니파이전서 3:7" --lang "fr" --abbreviated
+1 Né 3:7
+
+% scripturelookup get_church_url "helaman 5:12"
+https://www.churchofjesuschrist.org/study/scriptures/bofm/hel/5?id=p12&lang=eng#p12
+
+% scripturelookup get_label "/scriptures/nt/1-jn/3.2-3" --lang "cmn-Hant"
+約翰一書3：2-3
+
+% scripturelookup get_church_url "/scriptures/ot" --lang "es"
+https://www.churchofjesuschrist.org/study/scriptures/ot?lang=spa
+```
+
+
+## Python usage
+
+Examples:
+```
+from scripturelookup import lookup
+
+lookup.get_content('john 3:16', lang = 'en')
+# 16 ¶ For God so loved the world, that he gave his only begotten Son, that whosoever believeth in him should not perish, but have everlasting life.
+
+lookup.get_label('니파이전서 3:7', lang = 'fr', abbreviated = True)
+# 1 Né 3:7
+
+lookup.get_church_url('helaman 5:12')
+# https://www.churchofjesuschrist.org/study/scriptures/bofm/hel/5?id=p12&lang=eng#p12
+
+lookup.get_label('/scriptures/nt/1-jn/3.2-3', lang = 'cmn-Hant')
+# 約翰一書3：2-3
+
+lookup.get_church_url('/scriptures/ot', lang = 'es')
+# https://www.churchofjesuschrist.org/study/scriptures/ot?lang=spa
+```
+
+
+## Commands, inputs, and options
+
+### Commands
+
+- **get_content** – Get chapter or verse content.
+- **get_label** – Get a scripture reference label (i.e. "John 3:16").
+- **get_church_uri** – Get a Gospel Library URI (i.e. "/scriptures/bofm/hel/5.12").
+- **get_church_url** – Get a Gospel Library URL.
+- **get_church_link** – Get an HTML link to Gospel Library.
+
+### Inputs
+
+Any of the following input types are supported. You can also provide several inputs at once as a list (separated by semicolons or line-breaks).
+
+- Chapter or verse references, in any supported language. Examples:
+  - John 3:16
+  - Enos 1:13, 15–18
+  - Psalm 23
+  - Gen. 1:3 (3–4)
+  - D&C 20:23; 76:41
+- Scripture publication or book names. Examples:
+  - Old Testament
+  - Book of Mormon
+  - 1 Corinthians
+  - Psalms
+- Gospel Library URIs (starting with `/scriptures`). Examples:
+  - /scriptures/ot/gen
+  - /scriptures/nt/matt/1
+  - /scriptures/nt/john/3.16
+  - /scriptures/bofm/enos/1.13,15-18
+  - /scriptures/pgp
+- Gospel Library URLs (old or new). Examples:
+  - https://www.churchofjesuschrist.org/study/scriptures/bofm/hel/5?id=p12&lang=eng#p12
+  - https://www.churchofjesuschrist.org/study/scriptures/ot?lang=eng
+  - http://lds.org/scriptures/bofm/1-ne/3.7?lang=eng
+
+### Options
+
+Several options are available. Some are only applicable to certain commands.
+
+- **lang** (optional) – Output language. BCP 47 language codes and Gospel Library language codes are supported. Default: 'en'.
+- **separator** (optional) – String separator between outputs when a list of references is being requested. Default: '\n'.
+- **source** (optional) – Content source. Default: 'python-scripture-scraper'. Supported values: 'python-scripture-scraper' or 'ChurchofJesusChrist.org'.
+- **link_class** (optional) – String for the “class” attribute on links. Default: None.
+- **link_target** (optional) – String for the “target” attribute on links. Default: None.
+- **use_query_parameters** (optional) – Whether query parameters should be used on URIs. Default: False.
+- **skip_lang** (optional) – Whether “lang” query parameters should be skipped on URLs. Default: False.
+- **skip_fragment** (optional) – Whether fragments should be skipped on URLs. Default: False.
+- **skip_book_name** (optional) – Whether book names should be skipped on labels. Default: False.
+- **abbreviated** (optional) – Whether book abbrevions should be used on labels. Default: False.
+
+
+## Acknowledgements
+[Python Scripture Scraper](https://github.com/samuelbradshaw/python-scripture-scraper) – tool for scraping scripture content and metadata from ChurchofJesusChrist.org.
+[geezify-python](https://github.com/logicalperson0/geezify-python) – tool for converting numbers to and from Geez numerals.

scripturelookup-0.0.1/PKG-INFO

@@ -1,40 +0,0 @@
-Metadata-Version: 2.1
-Name: scripturelookup
-Version: 0.0.1
-Summary: Python and command-line utility for converting scripture references between formats.
-Author-email: Samuel Bradshaw <samuel.h.bradshaw@gmail.com>
-License: 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.
-Project-URL: Repository, https://github.com/samuelbradshaw/python-scripture-lookup
-Project-URL: Issues, https://github.com/samuelbradshaw/python-scripture-lookup/issues
-Project-URL: Changelog, https://github.com/samuelbradshaw/python-scripture-lookup/releases
-Keywords: python,command,scripture,bible,book of mormon,reference
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests
-
-# Scripture Lookup
-
-TODO: Add readme

scripturelookup-0.0.1/README.md

@@ -1,3 +0,0 @@
-# Scripture Lookup
-
-TODO: Add readme

scripturelookup-0.0.1/requirements.txt

@@ -1,3 +0,0 @@
-requests
-
-# -e git+https://github.com/logicalperson0/geezify-python.git@main#egg=geezify-python-main

scripturelookup-0.0.1/src/scripturelookup/data.py

@@ -1,58 +0,0 @@
-# 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-0.0.1/src/scripturelookup.egg-info/PKG-INFO

@@ -1,40 +0,0 @@
-Metadata-Version: 2.1
-Name: scripturelookup
-Version: 0.0.1
-Summary: Python and command-line utility for converting scripture references between formats.
-Author-email: Samuel Bradshaw <samuel.h.bradshaw@gmail.com>
-License: 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.
-Project-URL: Repository, https://github.com/samuelbradshaw/python-scripture-lookup
-Project-URL: Issues, https://github.com/samuelbradshaw/python-scripture-lookup/issues
-Project-URL: Changelog, https://github.com/samuelbradshaw/python-scripture-lookup/releases
-Keywords: python,command,scripture,bible,book of mormon,reference
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests
-
-# Scripture Lookup
-
-TODO: Add readme