Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Further tooling: black, flake8, and precommit-hooks #32

Merged
merged 9 commits into from
Jul 16, 2023

Conversation

CodeLionX
Copy link
Member

Improve the code quality of this project and make contributing easier by adding the following tools to our process and CI:

  • black (automatic file formatting)
  • flake8 (Python linting)
  • pre-commit (run hooks on every commit)

We additionally include flake8 in the CI to ensure proper code quality before merging or building a package.


Most changes in this PR are from the tools. See individual commits for better review.

@codecov
Copy link

codecov bot commented Jul 16, 2023

Codecov Report

Merging #32 (d393ccf) into main (6834ec8) will increase coverage by 0.12%.
The diff coverage is 82.95%.

@@            Coverage Diff             @@
##             main      #32      +/-   ##
==========================================
+ Coverage   89.87%   89.99%   +0.12%     
==========================================
  Files          53       53              
  Lines        2083     2088       +5     
==========================================
+ Hits         1872     1879       +7     
+ Misses        211      209       -2     
Flag Coverage Δ
unittests 89.99% <82.95%> (+0.12%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
gutenTAG/anomalies/types/frequency.py 96.42% <0.00%> (ø)
gutenTAG/anomalies/types/platform.py 92.30% <0.00%> (ø)
gutenTAG/api/__init__.py 0.00% <0.00%> (ø)
gutenTAG/config/schema_loader.py 100.00% <ø> (ø)
gutenTAG/utils/compatibility.py 75.00% <ø> (ø)
gutenTAG/utils/default_values.py 100.00% <ø> (ø)
gutenTAG/utils/global_variables.py 100.00% <ø> (ø)
gutenTAG/utils/logger.py 87.50% <0.00%> (+14.77%) ⬆️
gutenTAG/anomalies/types/mode_correlation.py 91.30% <33.33%> (ø)
gutenTAG/anomalies/types/mean.py 92.85% <50.00%> (ø)
... and 34 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@CodeLionX CodeLionX merged commit 9ebc74e into main Jul 16, 2023
4 of 5 checks passed
@CodeLionX CodeLionX deleted the feat/further-tooling branch July 16, 2023 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant