Review Python coding conventions, update as necessary

[zsoltkebel]

As a developer I would like to have an agreed on central python coding convention definition.

I suggest using ruff for linting as it is super fast and supports linting, formatting. I suggest this file as a starting point: https://github.com/ISISComputingGroup/IBEX-device-generator-new/blob/main/ruff.toml

Acceptance Criteria

What is the acceptance criteria?

• [ ] Review existing page and agree on changes
  • [ ] Agree on a linter/formatter to be used for python source code. I suggest ruff as it is wide spread, has lots of documentation, fast and can do both linting and formatting.
  • [ ] Subsequently a configuration file (e.g. ruff.toml) file is created specifying the linting pattern that can be used for all of our new python projects to achieve consistency.
  • [ ] GitHub actions are set up for our (new? maybe some old) projects to run the ruff check on commit informing us whether or not additional code follows our conventions.

Extra Information

Why it is needed?

It is needed to improve our code quality and robustness.

Where required files/links are

How to Test

verbose instructions for reviewer to test changes (Add before making a PR)

Discussed ~1:15 20/06/24

[KathrynBaker]

Is this not covered by https://github.com/ISISComputingGroup/ibex_developers_manual/wiki/Python-conventions? The title is agree, but the acceptance criteria are implement a solution - which don't quite match up.

[LowriJenkins]

is the first acceptence criteria: Review existing page and agree on changes, suggesting holding a meeting for the agree on changes section?

[isaachilly]

I think person doing ticket should make some observations and then some suggestions about the current standards beforehand but I think it may still be quite an involved meeting.

P.S. I assigned & unassigned as I saw another ticket with higher priority but your welcome to crack at it.