Merge pull request #26 from tekktrik/dev/ruff

Switch to ruff

Author: tekktrik

.pre-commit-config.yaml

@@ -2,17 +2,6 @@
 # SPDX-License-Identifier: MIT
 
 repos:
-  - repo: https://github.com/python/black
-    rev: 23.12.1
-    hooks:
-      - name: Run black
-        id: black
-  - repo: https://github.com/pycqa/isort
-    rev: 5.13.2
-    hooks:
-      - id: isort
-        name: Sort Python imports
-        args: ["--profile", "black", "--filter-files"]
   - repo: https://github.com/fsfe/reuse-tool
     rev: v2.1.0
     hooks:
@@ -27,10 +16,11 @@ repos:
         id: end-of-file-fixer
       - name: Trim trailing whitespace
         id: trailing-whitespace
-  - repo: local
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.14
     hooks:
-      - name: Run pylint
-        id: pylint
-        entry: pylint
-        language: system
-        types: [python]
+      - id: ruff
+        name: Lint via ruff
+        args: [--fix]
+      - id: ruff-format
+        name: Format via ruff

Makefile

@@ -0,0 +1,18 @@
+# SPDX-FileCopyrightText: 2024 Alec Delaney
+# SPDX-License-Identifier: MIT
+
+.PHONY: localhost
+localhost:
+	flask --app flask_app run
+
+.PHONY: lint
+lint:
+	pre-commit run ruff --all-files
+
+.PHONY: format
+format:
+	pre-commit run ruff-format --all-files
+
+.PHONY: check
+check:
+	pre-commit run --all-files

flask_app/__init__.py

@@ -1,8 +1,7 @@
 # SPDX-FileCopyrightText: 2023 Alec Delaney
 # SPDX-License-Identifier: MIT
 
-"""
-Main entry point for the flask application
+"""Main entry point for the flask application.
 
 Author: Alec Delaney
 """
@@ -51,24 +50,24 @@
 
 @app.route("/")
 def index() -> str:
-    """Route for index (landing page)"""
+    """Route for index (landing page)."""
     return render_template("index.html")
 
 
 @app.route("/set-menorah")
 def menorah_settings() -> Response:
-    """Route for shortcut to menorah settings page"""
+    """Route for shortcut to menorah settings page."""
     return redirect("/projects/menorah/settings")
 
 
 @app.route("/projects/menorah/settings", methods=["GET", "POST"])
 @limiter.limit("10/second", key_func=lambda: "menorah-settings")
 def project_menorah_settings() -> str:
-    """Route for creating menorah settings file"""
+    """Route for creating menorah settings file."""
     input_form = MenorahSetupForm()
     if input_form.validate_on_submit():
         zipcode = input_form.data["zipcode"]
-        with open("assets/settings.json", mode="r", encoding="utf-8") as template_file:
+        with open("assets/settings.json", encoding="utf-8") as template_file:
             template_text = template_file.read()
         template = jinja2.Template(template_text)
         rendered_temp = template.render(zipcode=zipcode)
@@ -83,7 +82,7 @@ def project_menorah_settings() -> str:
 
 @app.route("/recent", methods=["GET"])
 def recent() -> str:
-    """Route for recent GitHub activity"""
+    """Route for recent GitHub activity."""
     with open("assets/contrib/recent.json", encoding="utf-8") as respfile:
         contents = json.load(respfile)
     contributions, repos = contents["contributionsCollection"], contents["repositories"]
@@ -104,11 +103,11 @@ def recent() -> str:
 
 @app.route("/about", methods=["GET"])
 def about() -> str:
-    """Route for about me page"""
+    """Route for about me page."""
     jobs_path = pathlib.Path("assets/about/jobs")
     jobs = []
     for job_path in jobs_path.glob("*.json"):
-        with open(job_path, mode="r", encoding="utf-8") as jobfile:
+        with open(job_path, encoding="utf-8") as jobfile:
             job_obj = json.load(jobfile)
             if job_obj["endDate"] is None:
                 job_obj["endDate"] = "current"
@@ -120,7 +119,7 @@ def about() -> str:
     education_paths = pathlib.Path("assets/about/education")
     educations = []
     for education_path in education_paths.glob("*.json"):
-        with open(education_path, mode="r", encoding="utf-8") as edufile:
+        with open(education_path, encoding="utf-8") as edufile:
             edu_obj = json.load(edufile)
             if edu_obj["endYear"] is None:
                 edu_obj["endYear"] = "current"

flask_app/forms.py

@@ -1,8 +1,7 @@
 # SPDX-FileCopyrightText: 2023 Alec Delaney
 # SPDX-License-Identifier: MIT
 
-"""
-WTForms used in the Flask application
+"""WTForms used in the Flask application.
 
 Author: Alec Delaney
 """
@@ -13,7 +12,7 @@
 
 
 class MenorahSetupForm(FlaskForm):
-    """Form for menorah information"""
+    """Form for menorah information."""
 
     zipcode = StringField("Zip Code", validators=[DataRequired()])
     submit = SubmitField("Generate file...")

flask_app/helpers.py

@@ -1,8 +1,7 @@
 # SPDX-FileCopyrightText: 2023 Alec Delaney
 # SPDX-License-Identifier: MIT
 
-"""
-Helper functions used by the Flask application
+"""Helper functions used by the Flask application.
 
 Author: Alec Delaney
 """
@@ -16,7 +15,7 @@
 
 
 class JobDict(TypedDict):
-    """TypedDict representing job JSON file contents"""
+    """TypedDict representing job JSON file contents."""
 
     title: str
     employer: str
@@ -29,15 +28,15 @@ class JobDict(TypedDict):
 
 
 def generate_settings_json(zipcode: str) -> str:
-    """Generate a settings file for the CircuiyPythonukiah"""
+    """Generate a settings file for the CircuiyPythonukiah."""
     return json.dumps({"zipcode": zipcode})
 
 
 def get_repo_info(token: str) -> tuple[dict[str, Any], dict[str, Any]]:
-    """Get repository info from the GraphQL query"""
+    """Get repository info from the GraphQL query."""
     url = "https://api.github.com/graphql"
 
-    with open("assets/graphql_query.txt", mode="r", encoding="utf-8") as queryfile:
+    with open("assets/graphql_query.txt", encoding="utf-8") as queryfile:
         query_param = {"query": queryfile.read()}
 
     resp = requests.post(
@@ -55,13 +54,13 @@ def get_repo_info(token: str) -> tuple[dict[str, Any], dict[str, Any]]:
 
 
 def sort_jobs_start_date(job: JobDict) -> int:
-    """Sort the jobs by start date"""
+    """Sort the jobs by start date."""
     month_str, year_str = job["startDate"].split("/")
     return int(year_str) * 100 + int(month_str)
 
 
 def consolidate_sorted_jobs(jobs: list[JobDict]) -> list[list[JobDict]]:
-    """Consolidate jobs in instances like promotions"""
+    """Consolidate jobs in instances like promotions."""
     grouped_jobs_dict: dict[str, list[JobDict]] = {}
     grouped_jobs_list: list[list[JobDict]] = []
 
@@ -85,7 +84,8 @@ def consolidate_sorted_jobs(jobs: list[JobDict]) -> list[list[JobDict]]:
 
         # If job was not just newly added and gap is no more than 31 days apart
         # then add to existing list
-        if not newly_added and (start_role - end_role).days <= 31:
+        duration_days = 31
+        if not newly_added and (start_role - end_role).days <= duration_days:
             grouped_jobs_dict[employer].append(job)
 
         elif not newly_added:
@@ -99,5 +99,5 @@ def consolidate_sorted_jobs(jobs: list[JobDict]) -> list[list[JobDict]]:
 
 
 def sort_grouped_jobs(jobs_list: list[JobDict]) -> int:
-    """Sort the grouped lists of jobs"""
+    """Sort the grouped lists of jobs."""
     return sort_jobs_start_date(jobs_list[0])

requirements-dev.txt

@@ -2,4 +2,3 @@
 # SPDX-License-Identifier: MIT
 
 pre-commit~=3.6
-pylint~=3.0

ruff.toml

@@ -0,0 +1,5 @@
+# SPDX-FileCopyrightText: 2024 Alec Delaney
+# SPDX-License-Identifier: MIT
+
+select = ["D", "PL", "UP", "I"]
+ignore = ["D213", "D203"]

scripts/graphql.py

@@ -14,7 +14,7 @@
 with open("/etc/config.json", encoding="utf-8") as jsonfile:
     config = json.load(jsonfile)
 
-with open("assets/graphql_query.txt", mode="r", encoding="utf-8") as queryfile:
+with open("assets/graphql_query.txt", encoding="utf-8") as queryfile:
     query_param = {"query": queryfile.read()}
 
 resp = requests.post(
@@ -40,7 +40,8 @@
 for index, node in enumerate(json_resp["repositories"]["nodes"]):
     for _ in range(5):
         img_resp = requests.get(node["openGraphImageUrl"], timeout=5)
-        if img_resp.status_code == 200:
+        status_okay = 200
+        if img_resp.status_code == status_okay:
             with open(str(card_dir / f"card{index}.png"), mode="wb") as imgfile:
                 for data_chunk in img_resp:
                     imgfile.write(data_chunk)