Add Ruff Formatter

.github/workflows/lint.yml

@@ -21,5 +21,13 @@ jobs:
         - name: "Install requirements"
           run: python3 -m pip install -r requirements.txt
 
-        - name: "Run"
-          run: python3 -m ruff check .
+        - name: "Format"
+          run: python3 -m ruff format .
+
+        - name: "Check"
+          run: python3 -m ruff check .
+
+        - name: "Auto Commit"
+          uses: stefanzweifel/git-auto-commit-action@v5.0.0
+          with:
+            commit_message: 'style fixes by ruff'

.ruff.toml

@@ -36,6 +36,25 @@ ignore = [
     "D411",  # Missing blank line before section
     "E501",  # line too long
     "E731",  # do not assign a lambda expression, use a def
+
+    # May conflict with the formatter, https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
+    "W191",
+    "E111",
+    "E114",
+    "E117",
+    "D206",
+    "D300",
+    "Q000",
+    "Q001",
+    "Q002",
+    "Q003",
+    "COM812",
+    "COM819",
+    "ISC001",
+    "ISC002",
+
+    # Disabled because ruff does not understand type of __all__ generated by a function
+    "PLE0605",
 ]
 
 [flake8-pytest-style]

CONTRIBUTING.md

@@ -19,7 +19,7 @@ Pull requests are the best way to propose changes to the codebase.
 4. Test you contribution.
 5. Issue that pull request!
 
-## Any contributions you make will be under the MIT Software License
+## Any contributions you make will be under the Apache-2.0 License
 
 In short, when you submit code changes, your submissions are understood to be under the same [Apache-2.0](https://github.com/Pirate-Weather/pirate-weather-ha?tab=Apache-2.0-1-ov-file#readme) that covers the project. Feel free to contact the maintainers if that's a concern.