IdentityPython / SATOSA

Proxy translating between different authentication protocols (SAML2, OpenID Connect and OAuth2)
https://idpy.org
Apache License 2.0
197 stars 121 forks source link

Check code style using pre-commit and flake8 #454

Open niheconomoum opened 7 months ago

niheconomoum commented 7 months ago

I've added a small set of pre-commit hooks, including the flake8 linter, to the project. Developers can use these hooks by running pre-commit install. They can bypass the hooks if necessary with git commit -n; see also githooks(5).

I also added a continuous integration (CI) workflow using GitHub Actions. This workflow gets invoked when pushing changes to a branch on GitHub, when filing a pull request, or manually running the workflow (requires write access to the repository on GitHub). Right now, the CI workflow only runs the linter via pre-commit, but I plan to add test, build, and deployment jobs that replicate the old Travis CI workflow. Note that developers can run GitHub Actions locally using act, albeit with some limitations.

Except in one case, I have not actually made any changes to SATOSA's code style. I've also avoided making changes to how SATOSA gets built and packaged. Unfortunately, that means the CI workflow currently fails due to a number of flake8 errors. I'd like to coordinate future changes to address this in a future PR with the core development team and with other contributors (essentially, everyone with an open pull request).

All Submissions:

niheconomoum commented 7 months ago

Note that the last three items on the checklist do not apply as this makes no changes to the SATOSA code base itself.

c00kiemon5ter commented 4 months ago

I think I will move forward with this.