Merge pull request #41 from avendesora/main

[avendesora]

Merging main back into develop before starting a couple larger projects

[sourcery-ai[bot]]

Sourcery Code Quality Report

Merging this PR leaves code quality unchanged.

Quality metrics	Before	After	Change
Complexity	3.05 ⭐	3.05 ⭐	0.00
Method Length	40.69 ⭐	40.69 ⭐	0.00
Working memory	6.47 🙂	6.47 🙂	0.00
Quality	80.61% ⭐	80.61% ⭐	0.00%

Other metrics	Before	After	Change
Lines	6872	6872	0

Changed files	Quality Before	Quality After	Quality Change
pythonbible/init.py	81.99% ⭐	81.99% ⭐	0.00%
pythonbible/book_groups.py	71.74% 🙂	71.74% 🙂	0.00%
pythonbible/books.py	91.09% ⭐	91.09% ⭐	0.00%
pythonbible/converter.py	53.02% 🙂	53.02% 🙂	0.00%
pythonbible/errors.py	76.34% ⭐	76.34% ⭐	0.00%
pythonbible/formatter.py	74.86% 🙂	74.86% 🙂	0.00%
pythonbible/normalized_reference.py	97.84% ⭐	97.84% ⭐	0.00%
pythonbible/parser.py	53.81% 🙂	53.81% 🙂	0.00%
pythonbible/regular_expressions.py	48.09% 😞	48.09% 😞	0.00%
pythonbible/roman_numeral_util.py	86.09% ⭐	86.09% ⭐	0.00%
pythonbible/validator.py	86.81% ⭐	86.81% ⭐	0.00%
pythonbible/verses.py	86.43% ⭐	86.43% ⭐	0.00%
pythonbible/versions.py	85.13% ⭐	85.13% ⭐	0.00%
pythonbible/bible/init.py	%	%	%
pythonbible/bible/bible_parser.py	86.18% ⭐	86.18% ⭐	0.00%
pythonbible/bible/json_converter.py	88.98% ⭐	88.98% ⭐	0.00%
pythonbible/bible/osis/init.py	%	%	%
pythonbible/bible/osis/constants.py	87.00% ⭐	87.00% ⭐	0.00%
pythonbible/bible/osis/parser.py	72.90% 🙂	72.90% 🙂	0.00%
pythonbible/counters/init.py	%	%	%
pythonbible/counters/book_counter.py	98.18% ⭐	98.18% ⭐	0.00%
pythonbible/counters/chapter_counter.py	90.49% ⭐	90.49% ⭐	0.00%
pythonbible/counters/verse_counter.py	73.11% 🙂	73.11% 🙂	0.00%
tests/init.py	%	%	%
tests/conftest.py	96.91% ⭐	96.91% ⭐	0.00%
tests/test_converter.py	93.91% ⭐	93.91% ⭐	0.00%
tests/test_counters.py	93.91% ⭐	93.91% ⭐	0.00%
tests/test_errors.py	91.10% ⭐	91.10% ⭐	0.00%
tests/test_formatter.py	88.05% ⭐	88.05% ⭐	0.00%
tests/test_json_converter.py	82.91% ⭐	82.91% ⭐	0.00%
tests/test_parser.py	89.05% ⭐	89.05% ⭐	0.00%
tests/test_regular_expressions.py	90.58% ⭐	90.58% ⭐	0.00%
tests/test_validator.py	96.04% ⭐	96.04% ⭐	0.00%
tests/test_verses.py	90.83% ⭐	90.83% ⭐	0.00%
tests/test_versions.py	100.00% ⭐	100.00% ⭐	0.00%
tests/test_zzz_osis_constants.py	99.53% ⭐	99.53% ⭐	0.00%
tests/test_zzz_osis_parser.py	85.65% ⭐	85.65% ⭐	0.00%

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
pythonbible/parser.py	_process_sub_reference	14 🙂	218 ⛔	13 😞	38.70% 😞	Try splitting into smaller methods. Extract out complex expressions
pythonbible/parser.py	normalize_reference	18 🙂	183 😞	12 😞	39.71% 😞	Try splitting into smaller methods. Extract out complex expressions
pythonbible/converter.py	convert_verse_ids_to_references	11 🙂	179 😞	15 😞	41.63% 😞	Try splitting into smaller methods. Extract out complex expressions
pythonbible/formatter.py	format_scripture_text_verse_by_verse	13 🙂	112 🙂	15 😞	47.15% 😞	Extract out complex expressions
pythonbible/bible/osis/parser.py	_handle_child_element	12 🙂	116 🙂	11 😞	53.48% 🙂	Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

• ⭐ excellent
• 🙂 good
• 😞 poor
• ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

---

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!