TomographicImaging / CIL

A versatile python framework for tomographic imaging
https://tomographicimaging.github.io/CIL/
Apache License 2.0
98 stars 45 forks source link

Add auto-formatter and formatting for python code #1229

Open Pasarus opened 2 years ago

Pasarus commented 2 years ago

To improve readability in CIL I recommended some tools to be used for auto-formatting such as yapf () or black (). It should be possible to use GitHub actions to automagically format each and every PR with a fresh commit after every commit is posted to it, and when the PR is committed, that way it will just be handled for developers.

With this formatting implemented a bunch of Flake8 warnings will be fixed and a move to more static analysis tools will be much smoother if that is how we want to move forward.

jakobsj commented 2 years ago

Yes please!

On Tue, 26 Apr 2022 at 15:02, Samuel Jones @.***> wrote:

To improve readability in CIL I recommended some tools to be used for auto-formatting such as yapf () or black (). It should be possible to use GitHub actions to automagically format each and every PR with a fresh commit after every commit is posted to it, and when the PR is committed, that way it will just be handled for developers.

With this formatting implemented a bunch of Flake8 warnings will be fixed and a move to more static analysis tools will be much smoother if that is how we want to move forward.

— Reply to this email directly, view it on GitHub https://github.com/TomographicImaging/CIL/issues/1229, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACMDSCFDD7DGMDLCASVFGLTVG7SNDANCNFSM5ULY4PUQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>

paskino commented 2 years ago

something like https://github.com/marketplace/actions/autoyapf Maybe this can be added to our current workflow?