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.

Sign up for GitHub

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

Jump to bottom

Cleanups #30

Merged
merged 17 commits into from
Jun 19, 2024
Merged

Cleanups #30

merged 17 commits into from
Jun 19, 2024

Conversation

stv0g
Copy link
Contributor

@stv0g stv0g commented Jun 17, 2024 •
edited
Loading

Okay, this PR got a bit larger than anticipated.
But there were just too many small things which I want to cleanup:

  • General code-style:
    • Formatting via black
    • PEP-8 compliance via flake8
    • Fix a bunch of code-smells detected by Sonar Cloud
  • Improve code-quality
    • Remove print() and replace by logging module
    • Replace .format()-style string formatting by printf-style for logging module
  • Revamp CI pipelines:
    • I removed the in-repo CI action for building the documentation and converted it to a normal workflow
      • This allowed removing a lot of stuff:
        • Dockerfile
        • docu.sh
        • action.yaml
        • entrypoint.sh
      • Removal of GitLab CI config
      • The documentation is now also build in PR pipelines, but just not deployed.
  • Migrate to more modern Python packaging practices:
    • setup.py has been replace by pyproject.toml
  • Check code-style, formatting and more with pre-commit
    • Will also be enforced by CI workflow

stv0g added 13 commits June 17, 2024 15:41
@stv0g
Fix formatting with black formatter
e9896ea 
Signed-off-by: Steffen Vogel <[email protected]>
@stv0g
Add simple pre-commit config
807b1b6 
Signed-off-by: Steffen Vogel <[email protected]>
@stv0g
Add GitHub actions workflow for running pre-commit
2c35fc9 
Signed-off-by: Steffen Vogel <[email protected]>
@stv0g
Fix missing newline at end-of-file
d3784b6 
Signed-off-by: Steffen Vogel <[email protected]>
@stv0g
Remove trailing whitespaces
360746e 
Signed-off-by: Steffen Vogel <[email protected]>
@stv0g
Cleanup .gitignore
c90cd2a 
Signed-off-by: Steffen Vogel <[email protected]>
@stv0g
Fix warnings and formatting from black and flake8
aecadd0 
Signed-off-by: Steffen Vogel <[email protected]>
@stv0g
Make all filenames PEP-8 compliant
824caa6 
Signed-off-by: Steffen Vogel <[email protected]>
@stv0g
Update Python packaging files to use new best practices
9a99426 
Signed-off-by: Steffen Vogel <[email protected]>
@stv0g
Replace print with logging package
f37a217 
Signed-off-by: Steffen Vogel <[email protected]>
@stv0g
Use proper printf-style formatting for logging
4f63a10 
Signed-off-by: Steffen Vogel <[email protected]>
@stv0g
Fix capitalization of comments
8feb082 
Signed-off-by: Steffen Vogel <[email protected]>
@stv0g
Fix camelCase naming of variables
0e89379 
Signed-off-by: Steffen Vogel <[email protected]>
@stv0g stv0g force-pushed the cleanup-python branch 4 times, most recently from 8860a1b to 238a50b Compare June 17, 2024 15:38
@stv0g stv0g mentioned this pull request Jun 17, 2024
Closed
@stv0g stv0g changed the title Cleanup Python Cleanups Jun 17, 2024
@stv0g stv0g requested review from m-mirz and dinkelbachjan June 17, 2024 15:51
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@m-mirz m-mirz merged commit d23596b into master Jun 19, 2024
5 checks passed
@m-mirz m-mirz deleted the cleanup-python branch June 19, 2024 14:21
@stv0g
Copy link
Contributor Author

stv0g commented Jun 19, 2024

Thanks ☺️

@stv0g stv0g mentioned this pull request Jun 20, 2024
Merged
stv0g added a commit that referenced this pull request Jun 20, 2024
@stv0g
fix(ci): Fix permissions of GITHUB_TOKEN in order to deploy GitHub …
1376f9a 
…pages (#32)

This is just a small follow-up PR for #30 

I forgot to set the proper permissions for the GitHub actions workflow
which deploys the documentation to GitHub pages.
stv0g added a commit that referenced this pull request Jun 20, 2024
@stv0g
fix(ci): Fix permissions of GITHUB_TOKEN in order to deploy GitHub …
afba9cf 
…pages (#32)

This is just a small follow-up PR for #30

I forgot to set the proper permissions for the GitHub actions workflow
which deploys the documentation to GitHub pages.
This was referenced Jun 20, 2024
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@m-mirz m-mirz m-mirz approved these changes

@dinkelbachjan dinkelbachjan Awaiting requested review from dinkelbachjan

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@stv0g @m-mirz