diff --git a/docs/badges/coverage-badge.svg b/docs/badges/coverage-badge.svg index 1024b0e..eb0ef9c 100644 --- a/docs/badges/coverage-badge.svg +++ b/docs/badges/coverage-badge.svg @@ -1 +1 @@ -coverage: 88.14%coveragecoverage88.14%88.14% \ No newline at end of file +coverage: 88.97%coveragecoverage88.97%88.97% \ No newline at end of file diff --git a/docs/badges/flake8-badge.svg b/docs/badges/flake8-badge.svg index 5975b02..cb00fa6 100644 --- a/docs/badges/flake8-badge.svg +++ b/docs/badges/flake8-badge.svg @@ -1 +1 @@ -flake8: 1 C, 8941 W, 0 Iflake8flake81 C, 8941 W, 0 I1 C, 8941 W, 0 I \ No newline at end of file +flake8: 0 C, 3390 W, 0 Iflake8flake80 C, 3390 W, 0 I0 C, 3390 W, 0 I \ No newline at end of file diff --git a/docs/badges/test-badge.svg b/docs/badges/test-badge.svg index 63a0abd..51143d6 100644 --- a/docs/badges/test-badge.svg +++ b/docs/badges/test-badge.svg @@ -1 +1 @@ -tests: 36teststests3636 \ No newline at end of file +tests: 45teststests4545 \ No newline at end of file diff --git a/docs/generate_readme_badges.py b/docs/generate_readme_badges.py index 56f7f5c..b40c359 100644 --- a/docs/generate_readme_badges.py +++ b/docs/generate_readme_badges.py @@ -10,71 +10,124 @@ # Documentation will be automatically generated on new version release def generate_tests_coverage_badge(cwd: str): - run_command([ - sys.executable, "-m", "coverage", "run", "-m", "unittest", "discover", "./tests" - ], - cwd=cwd + run_command( + [ + sys.executable, + "-m", + "coverage", + "run", + "-m", + "unittest", + "discover", + "./tests", + ], + cwd=cwd, ) - run_command([ - sys.executable, "-m", "coverage", "xml", "-o", "./docs/reports/coverage/coverage.xml" - ], - cwd=cwd + run_command( + [ + sys.executable, + "-m", + "coverage", + "xml", + "-o", + "./docs/reports/coverage/coverage.xml", + ], + cwd=cwd, ) - run_command([ - sys.executable, "-m", "coverage", "html", "-d", "./docs/reports/coverage/" - ], - cwd=cwd + run_command( + [sys.executable, "-m", "coverage", "html", "-d", "./docs/reports/coverage/"], + cwd=cwd, ) - run_command([ - "genbadge", "coverage", "-i", "./docs/reports/coverage/coverage.xml", "-o", "./docs/badges/coverage-badge.svg" - ], - cwd=cwd + run_command( + [ + "genbadge", + "coverage", + "-i", + "./docs/reports/coverage/coverage.xml", + "-o", + "./docs/badges/coverage-badge.svg", + ], + cwd=cwd, ) def generate_test_badge(cwd: str): - test_report_path = pathlib.Path(curr_dir_path / 'reports' / 'junit') + test_report_path = pathlib.Path(curr_dir_path / "reports" / "junit") shutil.rmtree(test_report_path) os.makedirs(test_report_path, exist_ok=True) - run_command([ - sys.executable, "-m", "junitxml.main", "--o", "./docs/reports/junit/junit.xml" - ], - cwd=cwd + run_command( + [ + sys.executable, + "-m", + "junitxml.main", + "--o", + "./docs/reports/junit/junit.xml", + ], + cwd=cwd, ) - run_command([ - sys.executable, "-m", "junit2htmlreport", "./docs/reports/junit/junit.xml", "./docs/reports/junit/report.html" - ], - cwd=cwd + run_command( + [ + sys.executable, + "-m", + "junit2htmlreport", + "./docs/reports/junit/junit.xml", + "./docs/reports/junit/report.html", + ], + cwd=cwd, ) - run_command([ - "genbadge", "tests", "-i", "./docs/reports/junit/junit.xml", "-o", "./docs/badges/test-badge.svg" - ], - cwd=cwd + run_command( + [ + "genbadge", + "tests", + "-i", + "./docs/reports/junit/junit.xml", + "-o", + "./docs/badges/test-badge.svg", + ], + cwd=cwd, ) def generate_flake8_badge(cwd: str): - run_command([ - sys.executable, "-m", "flake8", "./rulekit", "--exit-zero", "--format=html", "--htmldir", "./docs/reports/flake8", "--statistics", "--tee", "--output-file", "./docs/reports/flake8/flake8stats.txt" - ], - cwd=cwd + run_command( + [ + sys.executable, + "-m", + "flake8", + "./rulekit", + "--exit-zero", + "--format=html", + "--htmldir", + "./docs/reports/flake8", + "--statistics", + "--tee", + "--output-file", + "./docs/reports/flake8/flake8stats.txt", + ], + cwd=cwd, ) - run_command([ - "genbadge", "flake8", "-i", "./docs/reports/flake8/flake8stats.txt", "-o", "./docs/badges/flake8-badge.svg" - ], - cwd=cwd + run_command( + [ + "genbadge", + "flake8", + "-i", + "./docs/reports/flake8/flake8stats.txt", + "-o", + "./docs/badges/flake8-badge.svg", + ], + cwd=cwd, ) def main(): - print('Updating badges') - cwd = pathlib.Path(curr_dir_path / '..') # root repo dir + print("Updating badges") + cwd = pathlib.Path(curr_dir_path / "..") # root repo dir - # generate_tests_coverage_badge(cwd) - # generate_test_badge(cwd) + generate_tests_coverage_badge(cwd) + generate_test_badge(cwd) generate_flake8_badge(cwd) - print('Badges generated successfully!') + print("Badges generated successfully!") if __name__ == "__main__": diff --git a/docs/reports/coverage/class_index.html b/docs/reports/coverage/class_index.html index ba3b712..2a5b9d8 100644 --- a/docs/reports/coverage/class_index.html +++ b/docs/reports/coverage/class_index.html @@ -11,7 +11,7 @@ Coverage report: - 88% + 89% @@ -83,42 +83,42 @@
coverage.py v7.6.4, - created at 2024-11-08 14:43 +0100 + created at 2024-11-28 12:33 +0100
@@ -65,7 +65,7 @@