avendesora / pythonbible

A python library for validating, parsing, normalizing scripture references and retrieving scripture texts (for open source and public domain versions)
https://docs.python.bible
MIT License
60 stars 12 forks source link

Normalize Book Shortcode length (3-character) #37

Closed rtbs-dev closed 3 years ago

rtbs-dev commented 3 years ago

Made it possible for all books to be referred to as their common (?) 3-character shortcode. Most are the first 3 letters, though others are non-standard (e.g. Judges->Jdg, Philippians->Php)

sourcery-ai[bot] commented 3 years ago

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.82%.

Quality metrics Before After Change
Complexity 0.13 ⭐ 0.13 ⭐ 0.00
Method Length 112.60 🙂 113.60 🙂 1.00 👎
Working memory 16.29 ⛔ 17.18 ⛔ 0.89 👎
Quality 48.88% 😞 48.06% 😞 -0.82% 👎
Other metrics Before After Change
Lines 188 196 8
Changed files Quality Before Quality After Quality Change
pythonbible/regular_expressions.py 48.88% 😞 48.06% 😞 -0.82% 👎

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

File Function Complexity Length Working Memory Quality Recommendation

Legend and Explanation

The emojis denote the absolute quality of the code:

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!

avendesora commented 3 years ago

The "Test" GitHub action failed due to it failing to upload the code coverage report to codacy. The actual tests all passed with 100% coverage.

avendesora commented 3 years ago

@tbsexton Thanks for the contribution!

rtbs-dev commented 3 years ago

The "Test" GitHub action failed due to it failing to upload the code coverage report to codacy. The actual tests all passed with 100% coverage.

Cool, yeah I had replicated a dev environment locally to verify as well (to rule out tests). Thanks!