scripturelookup 0.0.2__tar.gz → 0.0.3__tar.gz

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

@@ -8,3 +8,5 @@ Icon?
 *~
 
 localtesting.py
+build/*
+src/scripturelookup.egg-info/*

{scripturelookup-0.0.2/src/scripturelookup.egg-info → scripturelookup-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scripturelookup
-Version: 0.0.2
+Version: 0.0.3
 Summary: Python and command-line utility for converting scripture references between formats.
 Author-email: Samuel Bradshaw <samuel.h.bradshaw@gmail.com>
 License: MIT License
@@ -42,7 +42,12 @@ Scripture Lookup is a Python library and command-line tool for looking up script
 
 ## Installation
 
-The Python package and command-line tool can be installed from [PyPI](https://pypi.org/project/scripturelookup/) via pip:
+1. Install [Python 3](https://gist.github.com/samuelbradshaw/932d48ef1eff07e288e25e4355dbce5d) and the [Homebrew](https://brew.sh) package manager (if you don’t already have them installed).
+2. Install icu4c via Homebrew:
+```
+brew install icu4c
+```
+3. Install Scripture Lookup:
 ```
 pip install scripturelookup
 ```
@@ -106,6 +111,9 @@ lookup.get_church_url('/scriptures/ot', lang = 'es')
 - **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.
+- **get_reference_objects** – Get a list of references as objects.
+- **get_reference_attributes** – Get a list of references as dictionaries.
+- **sort_references** – Sort a list of references by label or in traditional book order.
 
 ### Inputs
 
@@ -132,13 +140,15 @@ Any of the following input types are supported. You can also provide several inp
   - 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
+  - [gospellibrary://content/scriptures/nt/john/3.16?lang=eng#16](https://www.churchofjesuschrist.org/study/scriptures/nt/john/3?id=p16&lang=eng#p16)
 
 ### 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'.
+- **separator** (optional) – String separator between outputs when a list of references is requested. Default: '\n'.
+- **sort_by** (optional) – Method for sorting references. Default: 'none'. Supported values: 'none', 'traditional', or 'label'.
 - **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.

{scripturelookup-0.0.2 → scripturelookup-0.0.3}/README.md

@@ -5,7 +5,12 @@ Scripture Lookup is a Python library and command-line tool for looking up script
 
 ## Installation
 
-The Python package and command-line tool can be installed from [PyPI](https://pypi.org/project/scripturelookup/) via pip:
+1. Install [Python 3](https://gist.github.com/samuelbradshaw/932d48ef1eff07e288e25e4355dbce5d) and the [Homebrew](https://brew.sh) package manager (if you don’t already have them installed).
+2. Install icu4c via Homebrew:
+```
+brew install icu4c
+```
+3. Install Scripture Lookup:
 ```
 pip install scripturelookup
 ```
@@ -69,6 +74,9 @@ lookup.get_church_url('/scriptures/ot', lang = 'es')
 - **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.
+- **get_reference_objects** – Get a list of references as objects.
+- **get_reference_attributes** – Get a list of references as dictionaries.
+- **sort_references** – Sort a list of references by label or in traditional book order.
 
 ### Inputs
 
@@ -95,13 +103,15 @@ Any of the following input types are supported. You can also provide several inp
   - 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
+  - [gospellibrary://content/scriptures/nt/john/3.16?lang=eng#16](https://www.churchofjesuschrist.org/study/scriptures/nt/john/3?id=p16&lang=eng#p16)
 
 ### 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'.
+- **separator** (optional) – String separator between outputs when a list of references is requested. Default: '\n'.
+- **sort_by** (optional) – Method for sorting references. Default: 'none'. Supported values: 'none', 'traditional', or 'label'.
 - **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.

{scripturelookup-0.0.2 → scripturelookup-0.0.3}/requirements.txt

@@ -1,2 +1,3 @@
 requests==2.32.3
 beautifulsoup4==4.12.3
+PyICU >= 2.12

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

@@ -10,6 +10,7 @@ def main_cli():
   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('--sort-by', help='Sort the returned references ("none", "traditional", or "label"). Default: "none".')
   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.')
@@ -26,6 +27,7 @@ def main_cli():
     args.input,
     lang = args.lang or 'en',
     separator = args.separator or '\n',
+    sort_by = args.sort_by,
     source = args.source or 'python-scripture-scraper',
     link_class = args.link_class,
     link_target = args.link_target,
@@ -33,7 +35,7 @@ def main_cli():
     skip_lang = args.skip_lang,
     skip_fragment = args.skip_fragment,
     skip_book_name = args.skip_book_name,
-    abbreviated = args.abbreviated
+    abbreviated = args.abbreviated,
   )
   
   print(result)

scripturelookup-0.0.3/src/scripturelookup/data/metadata-languages.min.json

@@ -0,0 +1 @@
+{"_about":"Generated 2024-11-06 by Python Scripture Scraper (https://github.com/samuelbradshaw/python-scripture-scraper)","languages":{"af":{"name":"Afrikaans","autonym":"Afrikaans","churchLang":"afr"},"am":{"name":"Amharic","autonym":"አማርኛ","churchLang":"amh"},"ar":{"name":"Arabic","autonym":"العربية","churchLang":"ara"},"ase":{"name":"American Sign Language (ASL)","autonym":"American Sign Language","churchLang":"ase"},"ay":{"name":"Aymara","autonym":"Aymar Aru","churchLang":"aym"},"be":{"name":"Belarusian","autonym":"Беларуская","churchLang":"bel"},"bfi":{"name":"British Sign Language (BSL)","autonym":"British Sign Language","churchLang":"bfi"},"bg":{"name":"Bulgarian","autonym":"Български","churchLang":"bul"},"bi":{"name":"Bislama","autonym":"Bislama","churchLang":"bis"},"bik":{"name":"Bikolano","autonym":"Bikol","churchLang":"bik"},"bla":{"name":"Blackfoot","autonym":"Nitsi’powahsin","churchLang":"bla"},"bm":{"name":"Bambara","autonym":"Bamanankan","churchLang":"bam"},"bn":{"name":"Bengali","autonym":"বাংলা","churchLang":"ben"},"ca":{"name":"Catalan","autonym":"Català","churchLang":"cat"},"cag":{"name":"Nivaclé","autonym":"Nivacle","churchLang":"cag"},"cak":{"name":"Kaqchikel (Cakchiquel)","autonym":"Cakchiquel","churchLang":"cak"},"ceb":{"name":"Cebuano","autonym":"Cebuano","churchLang":"ceb"},"ch":{"name":"Chamorro","autonym":"Chamoru","churchLang":"cha"},"chk":{"name":"Chuukese","autonym":"Fosun Chuuk","churchLang":"chk"},"cmn-Hans":{"name":"Mandarin (Simplified)","autonym":"简体中文 - 普通话","churchLang":"zhs"},"cmn-Hant":{"name":"Mandarin (Traditional)","autonym":"繁體中文 - 國語","churchLang":"zho"},"cmn-Latn":{"name":"Mandarin (Romanized/Pinyin)","autonym":"漢語拼音","churchLang":"cmn-Latn"},"cs":{"name":"Czech","autonym":"Česky","churchLang":"ces"},"cuk":{"name":"Kuna","autonym":"Dulegaya","churchLang":"cuk"},"cy":{"name":"Welsh","autonym":"Cymraeg","churchLang":"cym"},"da":{"name":"Danish","autonym":"Dansk","churchLang":"dan"},"de":{"name":"German","autonym":"Deutsch","churchLang":"deu"},"efi":{"name":"Efik","autonym":"Efik","churchLang":"efi"},"el":{"name":"Greek","autonym":"Ελληνικά","churchLang":"ell"},"en":{"name":"English","autonym":"English","churchLang":"eng"},"es":{"name":"Spanish","autonym":"Español","churchLang":"spa"},"et":{"name":"Estonian","autonym":"Eesti","churchLang":"est"},"eu":{"name":"Basque","autonym":"Euskera","churchLang":"eus"},"fat":{"name":"Fante","autonym":"Fante","churchLang":"fat"},"fi":{"name":"Finnish","autonym":"Suomi","churchLang":"fin"},"fj":{"name":"Fijian","autonym":"Vosa vakaviti","churchLang":"fij"},"fon":{"name":"Fon","autonym":"Fɔngbè","churchLang":"fon"},"fr":{"name":"French","autonym":"Français","churchLang":"fra"},"gil":{"name":"Kiribati (Gilbertese)","autonym":"Kiribati","churchLang":"gil"},"gn":{"name":"Guarani","autonym":"Guaraní (Avañe'ẽ)","churchLang":"grn"},"guz":{"name":"Gusii (Kisii)","autonym":"EkeGusii","churchLang":"guz"},"haw":{"name":"Hawaiian","autonym":"ʻŌlelo Hawaiʻi","churchLang":"haw"},"hi":{"name":"Hindi","autonym":"हिन्दी","churchLang":"hin"},"hif":{"name":"Hindi (Fiji)","autonym":"Fiji Hindi","churchLang":"hif"},"hil":{"name":"Hiligaynon","autonym":"Hiligaynon","churchLang":"hil"},"hmn":{"name":"Hmong","autonym":"Hmoob","churchLang":"hmn"},"hr":{"name":"Croatian","autonym":"Hrvatski","churchLang":"hrv"},"ht":{"name":"Haitian Creole","autonym":"Kreyòl Ayisyen","churchLang":"hat"},"hu":{"name":"Hungarian","autonym":"Magyar","churchLang":"hun"},"hy":{"name":"Armenian (East)","autonym":"Հայերեն","churchLang":"hye"},"hyw":{"name":"Armenian (West)","autonym":"արեւմտահայերէն","churchLang":"hyw"},"id":{"name":"Indonesian","autonym":"Bahasa Indonesia","churchLang":"ind"},"ig":{"name":"Igbo","autonym":"Igbo","churchLang":"ibo"},"ilo":{"name":"Ilokano","autonym":"Ilokano","churchLang":"ilo"},"is":{"name":"Icelandic","autonym":"íslenska","churchLang":"isl"},"it":{"name":"Italian","autonym":"Italiano","churchLang":"ita"},"ja":{"name":"Japanese","autonym":"日本語","churchLang":"jpn"},"ka":{"name":"Georgian","autonym":"ქართული","churchLang":"kat"},"kam":{"name":"Kamba","autonym":"Kikamba","churchLang":"kam"},"kek":{"name":"Kekchi","autonym":"Q’eqchi’","churchLang":"kek"},"kk":{"name":"Kazakh","autonym":"Қазақ","churchLang":"kaz"},"km":{"name":"Khmer (Cambodian)","autonym":"ភាសាខ្មែរ","churchLang":"khm"},"ko":{"name":"Korean","autonym":"한국어","churchLang":"kor"},"kos":{"name":"Kosraean","autonym":"Kahs Kosrae","churchLang":"kos"},"ksw":{"name":"Karen","autonym":"ကညီလံာ်ခီၣ်ထံ","churchLang":"ksw"},"ln":{"name":"Lingala","autonym":"Lingála","churchLang":"lin"},"lo":{"name":"Laotian","autonym":"ພາສາລາວ","churchLang":"lao"},"lt":{"name":"Lithuanian","autonym":"Lietuvių","churchLang":"lit"},"lua":{"name":"Tshiluba","autonym":"Tshiluba","churchLang":"lua"},"lv":{"name":"Latvian","autonym":"Latviešu","churchLang":"lav"},"mam":{"name":"Mam","autonym":"Mam","churchLang":"mam"},"meu":{"name":"Motu","autonym":"Motu","churchLang":"meu"},"mg":{"name":"Malagasy","autonym":"Malagasy","churchLang":"mlg"},"mh":{"name":"Marshallese","autonym":"Kajin Majōl","churchLang":"mah"},"mi":{"name":"Maori","autonym":"Te Reo Māori","churchLang":"mri"},"mk":{"name":"Macedonian","autonym":"Македонски","churchLang":"mkd"},"ml":{"name":"Malayalam","autonym":"മലയാളം","churchLang":"mal"},"mn":{"name":"Mongolian","autonym":"Монгол","churchLang":"mon"},"ms":{"name":"Malay","autonym":"Bahasa Melayu","churchLang":"msa"},"mt":{"name":"Maltese","autonym":"Malti","churchLang":"mlt"},"my":{"name":"Burmese (Myanmar)","autonym":"ဗမာစာ","churchLang":"mya"},"ne":{"name":"Nepali","autonym":"नेपाली","churchLang":"nep"},"niu":{"name":"Niuean","autonym":"ko e vagahau Niuē","churchLang":"niu"},"nl":{"name":"Dutch","autonym":"Nederlands","churchLang":"nld"},"no":{"name":"Norwegian","autonym":"Norsk","churchLang":"nor"},"nr":{"name":"Ndebele (Southern)","autonym":"isiNdebele","churchLang":"nbl"},"nso":{"name":"Sotho (Northern)","autonym":"sePêdi","churchLang":"nso"},"nv":{"name":"Navajo","autonym":"Diné bizaad","churchLang":"nav"},"ny":{"name":"Chewa","autonym":"Chichewa","churchLang":"nya"},"om":{"name":"Oromo","autonym":"Afaan Oromoo","churchLang":"orm"},"pag":{"name":"Pangasinan","autonym":"Pangasinan","churchLang":"pag"},"pam":{"name":"Pampango (Kapampangan)","autonym":"Pampango","churchLang":"pam"},"pap":{"name":"Papiamento","autonym":"Papiamento","churchLang":"pap"},"pau":{"name":"Palauan","autonym":"Palauan","churchLang":"pau"},"pes":{"name":"Persian (Iran) (Farsi)","autonym":"فارسی","churchLang":"pes"},"pl":{"name":"Polish","autonym":"Polski","churchLang":"pol"},"pon":{"name":"Pohnpeian","autonym":"Mahsen en Pohnpei","churchLang":"pon"},"pt":{"name":"Portuguese","autonym":"Português (Brasil)","churchLang":"por"},"pt-PT":{"name":"Portuguese (Portugal)","autonym":"Português (Portugal)","churchLang":"ept"},"quc":{"name":"Quiche","autonym":"Quiché","churchLang":"quc"},"quh":{"name":"Quechua (Bolivia)","autonym":"Quechua-Bolivia","churchLang":"quh"},"quz":{"name":"Quechua (Peru)","autonym":"Yunkay Quechua","churchLang":"quz"},"qvi":{"name":"Quichua (Ecuador)","autonym":"Kichwa","churchLang":"qvi"},"rar":{"name":"Rarotongan (Cook Islands Maori)","autonym":"Māori Kuki Airani","churchLang":"rar"},"ro":{"name":"Romanian","autonym":"Română","churchLang":"ron"},"ru":{"name":"Russian","autonym":"Русский","churchLang":"rus"},"rw":{"name":"Rwanda","autonym":"Kinyarwanda","churchLang":"kin"},"si":{"name":"Sinhala","autonym":"සිංහල","churchLang":"sin"},"sk":{"name":"Slovak","autonym":"Slovenčina","churchLang":"slk"},"sl":{"name":"Slovenian","autonym":"Slovenščina","churchLang":"slv"},"sm":{"name":"Samoan","autonym":"Gagana Samoa","churchLang":"smo"},"sn":{"name":"Shona","autonym":"Shona","churchLang":"sna"},"sq":{"name":"Albanian","autonym":"Shqip","churchLang":"alb"},"sr":{"name":"Serbian","autonym":"Српски","churchLang":"srp"},"ss":{"name":"Swazi","autonym":"siSwati","churchLang":"ssw"},"st":{"name":"Sotho (Southern)","autonym":"Sesotho","churchLang":"sot"},"sto":{"name":"Stoney Nakoda","autonym":"Îethka (Yethka)","churchLang":"sto"},"sv":{"name":"Swedish","autonym":"Svenska","churchLang":"swe"},"sw":{"name":"Swahili","autonym":"Kiswahili","churchLang":"swa"},"ta":{"name":"Tamil","autonym":"தமிழ்","churchLang":"tam"},"te":{"name":"Telugu","autonym":"తెలుగు","churchLang":"tel"},"th":{"name":"Thai","autonym":"ภาษาไทย","churchLang":"tha"},"tl":{"name":"Tagalog","autonym":"Tagalog","churchLang":"tgl"},"tn":{"name":"Tswana (Setswana)","autonym":"Setswana","churchLang":"tsn"},"to":{"name":"Tongan","autonym":"Faka-Tonga","churchLang":"ton"},"tpi":{"name":"Tok Pisin (Neomelanesian)","autonym":"Tok Pisin","churchLang":"tpi"},"tr":{"name":"Turkish","autonym":"Türkçe","churchLang":"tur"},"tvl":{"name":"Tuvalu","autonym":"gana Tuvalu","churchLang":"tvl"},"tw":{"name":"Twi","autonym":"Twi","churchLang":"twi"},"ty":{"name":"Tahitian","autonym":"Reo Tahiti","churchLang":"tah"},"tzo":{"name":"Tzotzil","autonym":"Bats'i k'op","churchLang":"tzo"},"uk":{"name":"Ukrainian","autonym":"Українська","churchLang":"ukr"},"ur":{"name":"Urdu","autonym":"اردو","churchLang":"urd"},"vi":{"name":"Vietnamese","autonym":"Tiếng Việt","churchLang":"vie"},"war":{"name":"Waray","autonym":"Waray","churchLang":"war"},"xh":{"name":"Xhosa","autonym":"isiXhosa","churchLang":"xho"},"yap":{"name":"Yapese","autonym":"Thin Nu Wa'ab","churchLang":"yap"},"yo":{"name":"Yoruba","autonym":"Èdè Yorùbá","churchLang":"yor"},"yua":{"name":"Maya (Yucatec)","autonym":"maayaʼ tʼàan","churchLang":"yua"},"yue-Hant":{"name":"Cantonese (Traditional)","autonym":"繁體中文 - 廣東話","churchLang":"yue"},"zu":{"name":"Zulu","autonym":"isiZulu","churchLang":"zul"}},"mapToBcp47":{"af":"af","afr":"af","am":"am","amh":"am","ar":"ar","ara":"ar","ase":"ase","ay":"ay","aym":"ay","be":"be","bel":"be","bfi":"bfi","bg":"bg","bul":"bg","bi":"bi","bis":"bi","bik":"bik","bla":"bla","bm":"bm","bam":"bm","bn":"bn","ben":"bn","ca":"ca","cat":"ca","cag":"cag","cak":"cak","ceb":"ceb","ch":"ch","cha":"ch","chk":"chk","cmn-Hans":"cmn-Hans","zhs":"cmn-Hans","cmn-Hant":"cmn-Hant","zho":"cmn-Hant","cmn-Latn":"cmn-Latn","cs":"cs","ces":"cs","cuk":"cuk","cy":"cy","cym":"cy","da":"da","dan":"da","de":"de","deu":"de","efi":"efi","el":"el","ell":"el","en":"en","eng":"en","es":"es","spa":"es","et":"et","est":"et","eu":"eu","eus":"eu","fat":"fat","fi":"fi","fin":"fi","fj":"fj","fij":"fj","fon":"fon","fr":"fr","fra":"fr","gil":"gil","gn":"gn","grn":"gn","guz":"guz","haw":"haw","hi":"hi","hin":"hi","hif":"hif","hil":"hil","hmn":"hmn","hr":"hr","hrv":"hr","ht":"ht","hat":"ht","hu":"hu","hun":"hu","hy":"hy","hye":"hy","hyw":"hyw","id":"id","ind":"id","ig":"ig","ibo":"ig","ilo":"ilo","is":"is","isl":"is","it":"it","ita":"it","ja":"ja","jpn":"ja","ka":"ka","kat":"ka","kam":"kam","kek":"kek","kk":"kk","kaz":"kk","km":"km","khm":"km","ko":"ko","kor":"ko","kos":"kos","ksw":"ksw","ln":"ln","lin":"ln","lo":"lo","lao":"lo","lt":"lt","lit":"lt","lua":"lua","lv":"lv","lav":"lv","mam":"mam","meu":"meu","mg":"mg","mlg":"mg","mh":"mh","mah":"mh","mi":"mi","mri":"mi","mk":"mk","mkd":"mk","ml":"ml","mal":"ml","mn":"mn","mon":"mn","ms":"ms","msa":"ms","mt":"mt","mlt":"mt","my":"my","mya":"my","ne":"ne","nep":"ne","niu":"niu","nl":"nl","nld":"nl","no":"no","nor":"no","nr":"nr","nbl":"nr","nso":"nso","nv":"nv","nav":"nv","ny":"ny","nya":"ny","om":"om","orm":"om","pag":"pag","pam":"pam","pap":"pap","pau":"pau","pes":"pes","pl":"pl","pol":"pl","pon":"pon","pt":"pt","por":"pt","pt-PT":"pt-PT","ept":"pt-PT","quc":"quc","quh":"quh","quz":"quz","qvi":"qvi","rar":"rar","ro":"ro","ron":"ro","ru":"ru","rus":"ru","rw":"rw","kin":"rw","si":"si","sin":"si","sk":"sk","slk":"sk","sl":"sl","slv":"sl","sm":"sm","smo":"sm","sn":"sn","sna":"sn","sq":"sq","alb":"sq","sr":"sr","srp":"sr","ss":"ss","ssw":"ss","st":"st","sot":"st","sto":"sto","sv":"sv","swe":"sv","sw":"sw","swa":"sw","ta":"ta","tam":"ta","te":"te","tel":"te","th":"th","tha":"th","tl":"tl","tgl":"tl","tn":"tn","tsn":"tn","to":"to","ton":"to","tpi":"tpi","tr":"tr","tur":"tr","tvl":"tvl","tw":"tw","twi":"tw","ty":"ty","tah":"ty","tzo":"tzo","uk":"uk","ukr":"uk","ur":"ur","urd":"ur","vi":"vi","vie":"vi","war":"war","xh":"xh","xho":"xh","yap":"yap","yo":"yo","yor":"yo","yua":"yua","yue-Hant":"yue-Hant","yue":"yue-Hant","zu":"zu","zul":"zu"}}