python-best-practices-cookiecutter icon indicating copy to clipboard operation
python-best-practices-cookiecutter copied to clipboard

Badges, Black, Code coverage, GitHub Actions, License

Open jevandezande opened this issue 4 years ago β€’ 1 comments

This commit add a number of quality of life improvements, including

Badges - license, formatting, GitHub actions, code coverage Black - with line-length selection option Code coverage - uses Codecov.io GitHub actions - actions integration License - MIT

There are sections that have hardcoded parts that could be excised.

I'm happy to make any changes or cut things out if they are not desired, as I realize this is meant to be as light and easy as possible.

jevandezande avatar May 26 '21 16:05 jevandezande

Sourcery Code Quality Report

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

Quality metrics Before After Change
Complexity 0.94 ⭐ 1.08 ⭐ 0.14 πŸ‘Ž
Method Length 23.75 ⭐ 30.42 ⭐ 6.67 πŸ‘Ž
Working memory 3.38 ⭐ 4.49 ⭐ 1.11 πŸ‘Ž
Quality 92.73% ⭐ 88.86% ⭐ -3.87% πŸ‘Ž
Other metrics Before After Change
Lines 42 101 59
Changed files Quality Before Quality After Quality Change
hooks/post_gen_project.py 92.36% ⭐ 89.41% ⭐ -2.95% πŸ‘Ž
hooks/pre_gen_project.py 90.55% ⭐ 87.66% ⭐ -2.89% πŸ‘Ž
{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}.py 94.02% ⭐ 84.62% ⭐ -9.40% πŸ‘Ž

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:

  • ⭐ 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!

sourcery-ai[bot] avatar Jan 06 '22 21:01 sourcery-ai[bot]