add Github Action for ruff formatting

[grische]

This is a basic CI for checking formatting with black, together with a dependabot configuration to keep it updated.
I will try to expand it using ruff or pylint or flake8 in the coming days.

Line length of 80 vs 88

I removed the line-length of 80 from the pyproject.toml, as it reduced the changes down to 60% (182 vs 117 inserts):

With a line-length of 80:

All done! ✨ 🍰 ✨
5 files reformatted, 2 files left unchanged.
 morgan/__init__.py     |  91 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------
 morgan/configurator.py |  39 ++++++++++++++++++++-------------------
 morgan/metadata.py     |  34 +++++++++++++++++++++-------------
 morgan/server.py       | 115 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-----------------------------------------------------
 morgan/utils.py        |  13 +++++++------
 pyproject.toml         |   7 +++++++
 6 files changed, 182 insertions(+), 117 deletions(-)

With black's default (=88):

All done! ✨ 🍰 ✨
5 files reformatted, 2 files left unchanged.
 morgan/__init__.py     |  18 ++++++++----------
 morgan/configurator.py |  39 ++++++++++++++++++++-------------------
 morgan/metadata.py     |  34 +++++++++++++++++++---------------
 morgan/server.py       | 113 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++---------------------------------------------------------
 morgan/utils.py        |  13 +++++++------
 pyproject.toml         |   8 +++++++-
 6 files changed, 117 insertions(+), 108 deletions(-)

Ruff instead of Black

Alternatively, we can also use ruff for formatting. It includes auto-formatting of includes which is usually very nice.
In the code that is formatted with both black and ruff, it is usually compatible with black. This code base would only have this difference:

diff --git a/morgan/server.py b/morgan/server.py
index d92197c..fbef175 100644
--- a/morgan/server.py
+++ b/morgan/server.py
@@ -155,9 +155,7 @@ class RequestHandler(http.server.BaseHTTPRequestHandler):
                             hashval,
                             file["filename"],
                             newline,
-                        ).encode(
-                            "utf-8"
-                        ),
+                        ).encode("utf-8"),
                     )
                 else:
                     self.wfile.write(

I'm happy to change this PR to ruff if you prefer.

[grische]

I am marking this as a draft until all outstanding PRs have been merged to avoid unnecessary merge conflicts.

[ido50]

I did actually move to use ruff in my other projects. Let's do that if you don't mind.

[shamilbi]

Could you please consider adding to pyproject.toml:

[tool.black]
skip-string-normalization = true

to help prevent excessive changes?

[grische]

I did actually move to use ruff in my other projects. Let's do that if you don't mind.

@ido50 I replaced black with ruff and did a tree-wide formatting using ruff.

[shamilbi]

Could you please consider adding to pyproject.toml:

[tool.ruff.format]
quote-style = "preserve"

to help prevent excessive changes?

[grische]

Could you please consider adding to pyproject.toml:

[tool.ruff.format]
quote-style = "preserve"

to help prevent excessive changes?

The difference is ~30 changed lines. I wouldn't call that excessive and it really impairs readability and long-term maintainability if you do not have a unified code style.