Move Bible XML parser functionality into separate library (#86)

* initial gutting of parser code. tests expected to fail.

* remove defusedxml references

* made readme prettier

* added Bible output from pythonbible-parser for KJV and ASV and updated formatter to fix several tests

* refactoring / tidying up

* refactoring / tidying up

* refactoring / tidying up

* updated asv bibles

* updated kjv bibles

* support for version book titles

* exclude large bible files from pre-commit checks

* updated sourcery config to ignore large bible files and to support python 3.7

* update asv bibles

* update asv bibles

* update kjv bibles

* improve test coverage

* gotta support python 3.7 for a couple more months :)

* attempt to tell codacy to ignore the large bible files

* test coverage

Author: avendesora

.codacy.yaml

@@ -0,0 +1,4 @@
+---
+exclude_paths:
+  - "pythonbible/bible/asv/*.py"
+  - "pythonbible/bible/kjv/*.py"

.pre-commit-config.yaml

@@ -8,7 +8,6 @@ repos:
       - id: debug-statements
       - id: name-tests-test
       - id: requirements-txt-fixer
-      - id: check-added-large-files
   - repo: https://github.com/psf/black
     rev: 23.3.0
     hooks:
@@ -42,3 +41,19 @@ repos:
           - flake8-tidy-imports
           - flake8-warnings
           - wemake-python-styleguide
+
+exclude: |
+  (?x)^(
+      pythonbible/bible/asv/html.py|
+      pythonbible/bible/asv/html_notes.py|
+      pythonbible/bible/asv/html_readers.py|
+      pythonbible/bible/asv/plain_text.py|
+      pythonbible/bible/asv/plain_text_notes.py|
+      pythonbible/bible/asv/plain_text_readers.py|
+      pythonbible/bible/kjv/html.py|
+      pythonbible/bible/kjv/html_notes.py|
+      pythonbible/bible/kjv/html_readers.py|
+      pythonbible/bible/kjv/plain_text.py|
+      pythonbible/bible/kjv/plain_text_notes.py|
+      pythonbible/bible/kjv/plain_text_readers.py
+  )$

.sourcery.yaml

@@ -0,0 +1,14 @@
+ignore:
+    - .git
+    - venv
+    - .venv
+    - env
+    - .env
+    - .tox
+    - node_modules
+    - vendor
+    - pythonbible/bible/asv/*.py
+    - pythonbible/bible/kjv/*.py
+
+rule_settings:
+  python_version: '3.7'

README.md

@@ -2,19 +2,39 @@
 
 The pythonbible library serves several purposes related to the Christian Bible and Scripture references.
 
-[![PyPI version](https://img.shields.io/pypi/v/pythonbible?color=blue&logo=pypi&logoColor=lightgray)](https://pypi.org/project/pythonbible/)
-[![license MIT](https://img.shields.io/badge/license-MIT-orange.svg)](https://opensource.org/licenses/MIT)
-
-![Test](https://github.com/avendesora/pythonbible/workflows/Test/badge.svg)
-[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/dc1333c64b434f7bb813d08750462921)](https://www.codacy.com/gh/avendesora/pythonbible/dashboard?utm_source=github.com&utm_medium=referral&utm_content=avendesora/pythonbible&utm_campaign=Badge_Coverage)
-
-![CodeQL](https://github.com/avendesora/pythonbible/workflows/CodeQL/badge.svg)
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/dc1333c64b434f7bb813d08750462921)](https://www.codacy.com/gh/avendesora/pythonbible/dashboard?utm_source=github.com&utm_medium=referral&utm_content=avendesora/pythonbible&utm_campaign=Badge_Grade)
-
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/avendesora/pythonbible/main.svg)](https://results.pre-commit.ci/latest/github/avendesora/pythonbible/main)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-
-[![Python 3.11](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20dev-blue?logo=python&logoColor=lightgray)](https://www.python.org/downloads/)
+<table>
+    <tr>
+        <td>Latest Version</td>
+        <td>
+            <a href="https://pypi.org/project/pythonbible/"><img src="https://img.shields.io/pypi/v/pythonbible?color=gold&logo=pypi&logoColor=lightgray"></a>
+            <img src="https://img.shields.io/pypi/dm/pythonbible?color=gold">
+        </td>
+    </tr>
+    <tr>
+        <td>License</td>
+        <td><a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-orange.svg"></a></td>
+    </tr>
+    <tr>
+        <td>Tests</td>
+        <td>
+            <img src="https://github.com/avendesora/pythonbible/workflows/Test/badge.svg">
+            <a href="https://www.codacy.com/gh/avendesora/pythonbible/dashboard?utm_source=github.com&utm_medium=referral&utm_content=avendesora/pythonbible&utm_campaign=Badge_Coverage"><img src="https://app.codacy.com/project/badge/Coverage/dc1333c64b434f7bb813d08750462921"></a>
+        </td>
+    </tr>
+    <tr>
+        <td>Code Quality</td>
+        <td>
+            <img src="https://github.com/avendesora/pythonbible/workflows/CodeQL/badge.svg">
+            <a href="https://www.codacy.com/gh/avendesora/pythonbible/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=avendesora/pythonbible&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/dc1333c64b434f7bb813d08750462921"></a><br/>
+            <a href="https://results.pre-commit.ci/latest/github/avendesora/pythonbible/main"><img src="https://results.pre-commit.ci/badge/github/avendesora/pythonbible/main.svg"></a>
+            <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
+        </td>
+    </tr>
+    <tr>
+        <td>Supported Python Versions</td>
+        <td><a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20dev-blue?logo=python&logoColor=lightgray"></a></td>
+    </tr>
+</table>
 
 ## Documentation
 
@@ -26,16 +46,6 @@ The full documentation for pythonbible can be found at [docs.python.bible](https
 pip install pythonbible
 ```
 
-### Optional Dependencies
-
-If the [defusedxml](https://github.com/tiran/defusedxml) library is installed, pythonbible will use it to parse XML files rather than the builtin xml.etree library.
-
-To install pythonbible with all optional dependencies, use the following command.
-
-```shell script
-pip install pythonbible[all]
-```
-
 ## Features
 
 ### Searching text for scripture references

pyproject.toml

@@ -44,10 +44,8 @@ doc = [
 dev = [
     "pre-commit >=2.20.0",
 ]
-all = [
-    "defusedxml >=0.7.1",
-]
 
 [tool.isort]
 profile = "black"
 add_imports = "from __future__ import annotations"
+force_single_line = true

pythonbible/__init__.py

@@ -11,49 +11,40 @@
 
 __version__ = "0.8"
 
-from .bible.osis.parser import OSISParser
-from .book_groups import BOOK_GROUPS, BookGroup
+from .bible.bible import Bible
+from .book_groups import BOOK_GROUPS
+from .book_groups import BookGroup
 from .books import Book
-from .converter import (
-    convert_reference_to_verse_ids,
-    convert_references_to_verse_ids,
-    convert_verse_ids_to_references,
-)
+from .converter import convert_reference_to_verse_ids
+from .converter import convert_references_to_verse_ids
+from .converter import convert_verse_ids_to_references
 from .counters.book_counter import count_books
 from .counters.chapter_counter import count_chapters
 from .counters.verse_counter import count_verses
-from .errors import (
-    InvalidBibleParserError,
-    InvalidBookError,
-    InvalidChapterError,
-    InvalidVerseError,
-    MissingBookFileError,
-    MissingVerseFileError,
-)
-from .formatter import (
-    format_scripture_references,
-    format_scripture_text,
-    format_single_reference,
-    get_book_titles,
-    get_parser,
-    get_verse_text,
-)
+from .errors import InvalidBibleParserError
+from .errors import InvalidBookError
+from .errors import InvalidChapterError
+from .errors import InvalidVerseError
+from .errors import MissingBookFileError
+from .errors import MissingVerseFileError
+from .formatter import format_scripture_references
+from .formatter import format_scripture_text
+from .formatter import format_single_reference
+from .formatter import get_book_titles
+from .formatter import get_verse_text
 from .normalized_reference import NormalizedReference
-from .parser import get_references, normalize_reference
-from .validator import (
-    is_valid_book,
-    is_valid_chapter,
-    is_valid_reference,
-    is_valid_verse,
-    is_valid_verse_id,
-)
-from .verses import (
-    get_book_chapter_verse,
-    get_book_number,
-    get_chapter_number,
-    get_number_of_chapters,
-    get_number_of_verses,
-    get_verse_id,
-    get_verse_number,
-)
+from .parser import get_references
+from .parser import normalize_reference
+from .validator import is_valid_book
+from .validator import is_valid_chapter
+from .validator import is_valid_reference
+from .validator import is_valid_verse
+from .validator import is_valid_verse_id
+from .verses import get_book_chapter_verse
+from .verses import get_book_number
+from .verses import get_chapter_number
+from .verses import get_number_of_chapters
+from .verses import get_number_of_verses
+from .verses import get_verse_id
+from .verses import get_verse_number
 from .versions import Version