Add ruff

[jo47011]

Replace all the original project setup, linting, etc. with ruff.

Still WIP. Need to adjust docs.

Taking it step by step. We could have a PR for each step to simplify code reading and discussions.

1. Ruff: Introduce ruff.
   We disable all linting errors that we get so we can focus on the project setup 1st.

2. Formatting: We agree on some parameters, see [tool.ruff.format] in pyproject.toml. Then we reformat the code (replaces black):

   ruff format .

   Then we can also add a format check to build workflow.

3. Linting: We agree on which parameter we want to enable and which we want to ignore in future, see [tool.ruff.lint] in pyproject.toml, e.g.;

    "D106",  # Missing docstring in public nested class
    "D107",  # Ignore D107 Missing docstring  # FIXME: enable again???
    "D200",  # One-line docstring should fit on one line
    ...

invoke like this:

ruff check --fix .

4. Build-system: we could consider switching from Setuptools to Hatchling further down the road. Provides for some more advanced environment management and other nice features.

BTW I think there was a bug in your previous setup.cfg:

I fixed it in the pyproject.toml. If it was intentional we need to change it back.

There is another issue in the main repo: the midi module seems to be missing for the unittest. Thus 3 tests in test_midi.py are skipped. I did the same in my build.yml as otherwise they would fail. So if we want them to be run in the workflow need to fix them there first. This is from the main repo (e.g. here https://github.com/mhthies/smarthomeconnect/actions/runs/12109227223/job/33758107287?pr=99):

[jo47011]

Do we want this here to avoid the warning:
WARNING: html_static_path entry '_static' does not exist

[jo47011]

This is a workaround so some midi tests are skipped as in the main branch of the core repo. See PR description for details.

[jo47011]

TBD all these errors occur, currently disabled so we could merge the current state.

We should discuss which ones what we want to ignore, some are easy to auto-fix. We can do ti step by step.

[jo47011]

For me it's fine to always have quotes. But we can discuss it once we address formatting in the 2nd stage.