pep-0008: Fix Package and Module Names✨

[yezz123]

Update Project Name, based on this #125 #124

[lgtm-com]

This pull request fixes 1 alert when merging 4ea31a7 into a40f829 - view on LGTM.com

fixed alerts:

• 1 for Mismatch between signature and use of an overriding method

[pull-request-quantifier-deprecated]

This PR has 276 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

---

Quantification details

Label      : Large
Size       : +138 -138
Percentile : 67.6%

Total files changed: 42

Change summary by file extension:
.yml : +2 -2
.py : +134 -134
.cfg : +1 -1
Makefile : +1 -1

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

• Fast and predictable releases to production:
  • Optimal size changes are more likely to be reviewed faster with fewer
    iterations.
  • Similarity in low PR complexity drives similar review times.
• Review quality is likely higher as complexity is lower:
  • Bugs are more likely to be detected.
  • Code inconsistencies are more likely to be detetcted.
• Knowledge sharing is improved within the participants:
  • Small portions can be assimilated better.
• Better engineering practices are exercised:
  • Solving big problems by dividing them in well contained, smaller problems.
  • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

• Use the PullRequestQuantifier to quantify your PR accurately
  • Create a context profile for your repo using the context generator
  • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
  • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
  • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
• Change your engineering behaviors
  • For PRs that fall outside of the desired spectrum, review the details and check if:
    • Your PR could be split in smaller, self-contained PRs instead
    • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

• One line was added: +1 -0
• One line was deleted: +0 -1
• One line was modified: +1 -1 (git diff doesn't know about modified, it will
  interpret that line like one addition plus one deletion)
• Change percentiles: Change characteristics (addition, deletion, modification)
  of this PR in relation to all other PRs within the repository.

---

Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

[sourcery-ai]

Sourcery Code Quality Report

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

Quality metrics	Before	After	Change
Complexity	1.49 ⭐	1.49 ⭐	0.00
Method Length	39.87 ⭐	39.86 ⭐	-0.01 👍
Working memory	6.95 🙂	6.95 🙂	0.00
Quality	79.52% ⭐	79.51% ⭐	-0.01% 👎

Other metrics	Before	After	Change
Lines	4351	4351	0

Changed files	Quality Before	Quality After	Quality Change
setup.py	89.09% ⭐	89.09% ⭐	0.00%
AuthX/init.py	97.67% ⭐	97.67% ⭐	0.00%
AuthX/main.py	77.88% ⭐	77.88% ⭐	0.00%
AuthX/api/init.py	100.00% ⭐	100.00% ⭐	0.00%
AuthX/api/users.py	85.89% ⭐	85.79% ⭐	-0.10% 👎
AuthX/core/config.py	69.64% 🙂	69.64% 🙂	0.00%
AuthX/core/jwt.py	83.14% ⭐	83.14% ⭐	0.00%
AuthX/core/logger.py	82.98% ⭐	82.98% ⭐	0.00%
AuthX/core/user.py	80.21% ⭐	80.21% ⭐	0.00%
AuthX/database/init.py	99.67% ⭐	99.67% ⭐	0.00%
AuthX/database/mongodb.py	90.48% ⭐	90.52% ⭐	0.04% 👍
AuthX/errors/init.py	100.00% ⭐	100.00% ⭐	0.00%
AuthX/errors/social.py	91.58% ⭐	91.58% ⭐	0.00%
AuthX/models/social.py	85.46% ⭐	85.46% ⭐	0.00%
AuthX/models/user.py	76.39% ⭐	76.39% ⭐	0.00%
AuthX/resources/error_messages.py	89.13% ⭐	89.13% ⭐	0.00%
AuthX/routers/init.py	98.50% ⭐	98.50% ⭐	0.00%
AuthX/routers/admin.py	80.86% ⭐	80.86% ⭐	0.00%
AuthX/routers/auth.py	61.93% 🙂	61.93% 🙂	0.00%
AuthX/routers/password.py	70.85% 🙂	70.85% 🙂	0.00%
AuthX/routers/search.py	78.65% ⭐	78.65% ⭐	0.00%
AuthX/routers/social.py	63.48% 🙂	63.48% 🙂	0.00%
AuthX/services/init.py	98.17% ⭐	98.17% ⭐	0.00%
AuthX/services/admin.py	86.30% ⭐	86.30% ⭐	0.00%
AuthX/services/auth.py	78.88% ⭐	78.88% ⭐	0.00%
AuthX/services/password.py	79.57% ⭐	79.57% ⭐	0.00%
AuthX/services/search.py	86.98% ⭐	86.98% ⭐	0.00%
AuthX/services/social.py	65.35% 🙂	65.35% 🙂	0.00%
tests/core/test_core_email.py	89.26% ⭐	89.26% ⭐	0.00%
tests/core/test_core_jwt.py	87.94% ⭐	87.94% ⭐	0.00%
tests/core/test_core_user.py	92.57% ⭐	92.57% ⭐	0.00%
tests/routers/test_routers_admin.py	90.03% ⭐	90.03% ⭐	0.00%
tests/routers/test_routers_auth.py	86.87% ⭐	86.87% ⭐	0.00%
tests/routers/test_routers_password.py	84.86% ⭐	84.86% ⭐	0.00%
tests/routers/test_routers_search.py	89.64% ⭐	89.64% ⭐	0.00%
tests/routers/test_routers_social.py	71.78% 🙂	71.78% 🙂	0.00%
tests/services/test_services_auth.py	78.66% ⭐	78.66% ⭐	0.00%
tests/services/test_services_password.py	87.59% ⭐	87.59% ⭐	0.00%

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

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
AuthX/routers/auth.py	get_router	6 ⭐	383 ⛔	16 ⛔	36.36% 😞	Try splitting into smaller methods. Extract out complex expressions
AuthX/services/social.py	SocialService.resolve_user	14 🙂	165 😞	14 😞	41.56% 😞	Try splitting into smaller methods. Extract out complex expressions
AuthX/routers/social.py	get_router	6 ⭐	226 ⛔	10 😞	50.69% 🙂	Try splitting into smaller methods. Extract out complex expressions
AuthX/main.py	Authentication.__init__	0 ⭐	129 😞	21 ⛔	52.43% 🙂	Try splitting into smaller methods. Extract out complex expressions
AuthX/routers/password.py	get_router	0 ⭐	187 😞	13 😞	54.23% 🙂	Try splitting into smaller methods. 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!

[lgtm-com]

This pull request fixes 1 alert when merging ff742a8 into a40f829 - view on LGTM.com

fixed alerts:

• 1 for Mismatch between signature and use of an overriding method