chore: add and run linting with ruff and deptry

Author: jtroup

.pre-commit-config.yaml

@@ -1,21 +1,12 @@
-exclude_types:
-   - makefile
-   - toml
-   - yaml
-   - json
-   - markdown
-   - ini
-
 repos:
-  - repo: https://github.com/psf/black
-    rev: 22.3.0
-    hooks:
-      - id: black
-
-  - repo: https://github.com/PyCQA/flake8
-    rev: 7.3.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.6.3
     hooks:
-      - id: flake8
+      # Run the linter.
+      - id: ruff
+      # Run the formatter.
+      - id: ruff-format
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v2.3.0

justfile

@@ -5,6 +5,15 @@ install:
 	poetry install
 	poetry run pre-commit install
 
+lint:
+  poetry run ruff check
+  poetry run ruff format --check
+  poetry run deptry .
+
+format:
+  poetry run ruff format
+  poetry run ruff check --fix
+
 test *flags:
 	poetry run pytest --cov=stacklet tests {{ flags }}
 

poetry.lock

@@ -23,21 +23,30 @@ click = "^8.0.1"
 requests = "^2.32.4"
 jsonschema = "^4.9.0"
 PyYAML = "^6.0"
-pyaml = "^21.10.1"
 PyJWT = "^2.4.0"
 boto3 = "^1.39.16"
-certifi = "2024.8.30"
+charset_normalizer = "^3.4.2"
+jmespath = "^1.0.1"
 
 [tool.poetry.group.dev.dependencies]
-flake8 = "^3.9.0"
-black = "^25.1.0"
-isort = "^5.8.0"
+ruff = "^0.12.7"
 moto = { version = "^5.1.9", extras = ["cognitoidp"] }
 pytest = "^8.4"
 pytest-cov = "^6.2.1"
 requests-mock = "^1.8.0"
 pre-commit = "^2.12.0"
 Nuitka = "^2.7.12"
-zstandard = "^0.15.2"
 semver = "^2.13.0"
 toml = "^0.10.2"
+deptry = "^0.23.1"
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+# Add `line-too-long` and isort to the enforced rule set.
+extend-select = ["E501", "I", "F"]
+
+[tool.deptry]
+known_first_party = ["stacklet"]
+per_rule_ignores = { "DEP004" = ["toml", "semver"] }

pyproject.toml

@@ -4,10 +4,10 @@
 import sys
 
 import click
+import semver
 
 # in python 3.11 we should switch out to tomllib
 import toml
-import semver
 
 
 @click.group()

scripts/upgrade.py

@@ -4,8 +4,8 @@
 import json
 import os
 import pathlib
-
 from urllib.parse import urlsplit, urlunsplit
+
 import click
 import jwt
 import requests
@@ -88,9 +88,7 @@ def cli(*args, **kwargs):
 @click.option("--idp-id", prompt="(SSO) IDP ID", default="")
 @click.option("--auth-url", prompt="(SSO) Auth Url", default="")
 @click.option("--cubejs", prompt="Stacklet cube.js endpoint", default="")
-@click.option(
-    "--location", prompt="Config File Location", default="~/.stacklet/config.json"
-)  # noqa
+@click.option("--location", prompt="Config File Location", default="~/.stacklet/config.json")  # noqa
 @click.pass_context
 def configure(
     ctx,
@@ -316,12 +314,8 @@ def login(ctx, username, password):
         if not os.path.exists(
             os.path.dirname(os.path.expanduser(StackletContext.DEFAULT_CREDENTIALS))
         ):
-            os.makedirs(
-                os.path.dirname(os.path.expanduser(StackletContext.DEFAULT_CREDENTIALS))
-            )
-        with open(
-            os.path.expanduser(StackletContext.DEFAULT_CREDENTIALS), "w+"
-        ) as f:  # noqa
+            os.makedirs(os.path.dirname(os.path.expanduser(StackletContext.DEFAULT_CREDENTIALS)))
+        with open(os.path.expanduser(StackletContext.DEFAULT_CREDENTIALS), "w+") as f:  # noqa
             f.write(res)
 
 

stacklet/client/platform/cli.py

@@ -3,15 +3,15 @@
 
 # platform client using cli
 
-import jmespath
 from pathlib import Path
 
-from stacklet.client.platform.executor import StackletGraphqlExecutor
-from stacklet.client.platform.context import StackletContext
-from stacklet.client.platform.utils import get_token, _PAGINATION_OPTIONS
+import jmespath
 
 # import the commands so the registry is populated when the client is instantiated
 import stacklet.client.platform.commands  # noqa
+from stacklet.client.platform.context import StackletContext
+from stacklet.client.platform.executor import StackletGraphqlExecutor
+from stacklet.client.platform.utils import _PAGINATION_OPTIONS, get_token
 
 
 def platform_client(pager=False, expr=False):

stacklet/client/platform/client.py

@@ -61,9 +61,7 @@ def create_user(self, user, password, email, phone_number, permanent=True):
             return True
 
         # update the password so it's set permantently
-        self.log.debug(
-            "Resetting admin password to disable temporary password for %s" % user
-        )
+        self.log.debug("Resetting admin password to disable temporary password for %s" % user)
         res = self.client.admin_set_user_password(
             UserPoolId=self.user_pool_id,
             Username=user,

stacklet/client/platform/cognito.py

@@ -4,8 +4,8 @@
 from .account import account
 from .accountgroup import account_group
 from .binding import binding
-from .graphql import graphql
 from .cube import cubejs
+from .graphql import graphql
 from .policy import policy
 from .policycollection import policy_collection
 from .repository import repository

stacklet/client/platform/commands/__init__.py

@@ -1,11 +1,11 @@
 # Copyright Stacklet, Inc.
 # SPDX-License-Identifier: Apache-2.0
 
-import click
 import json
 
-from stacklet.client.platform.executor import _run_graphql
-from stacklet.client.platform.executor import StackletGraphqlExecutor, snippet_options
+import click
+
+from stacklet.client.platform.executor import StackletGraphqlExecutor, _run_graphql, snippet_options
 from stacklet.client.platform.graphql import StackletGraphqlSnippet
 from stacklet.client.platform.utils import click_group_entry, default_options