python-best-practices-cookiecutter
python-best-practices-cookiecutter copied to clipboard
Badges, Black, Code coverage, GitHub Actions, License
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.
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!