TimeEval / GutenTAG

GutenTAG is an extensible tool to generate time series datasets with and without anomalies; integrated with TimeEval.
MIT License
71 stars 13 forks source link

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

Closed CodeLionX closed 1 year ago

CodeLionX commented 1 year ago

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

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[bot] commented 1 year ago

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%) :arrow_up:

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%) :arrow_up:
gutenTAG/anomalies/types/mode_correlation.py 91.30% <33.33%> (ø)
gutenTAG/anomalies/types/mean.py 92.85% <50.00%> (ø)
... and 34 more

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