Merge pull request #86 from bretterer/ruff

Add ruff formatting and update devcontainer

Author: natekspencer

.devcontainer/Dockerfile

@@ -1,11 +1,7 @@
-# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster
+# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon)
 ARG VARIANT=3-bullseye
 FROM mcr.microsoft.com/vscode/devcontainers/python:${VARIANT}
 
-# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
-ARG NODE_VERSION="none"
-RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
-
 # Poetry
 ARG POETRY_VERSION="none"
 RUN if [ "${POETRY_VERSION}" != "none" ]; then su vscode -c "umask 0002 && pip3 install poetry==${POETRY_VERSION}"; fi

.devcontainer/devcontainer.json

@@ -3,53 +3,40 @@
 {
 	"name": "Python 3",
 	"build": {
-	  "dockerfile": "Dockerfile",
-	  "context": "..",
-	  "args": {
-		// Update 'VARIANT' to pick a Python version: 3, 3.10, 3.9, 3.8, 3.7, 3.6
-		// Append -bullseye or -buster to pin to an OS version.
-		// Use -bullseye variants on local on arm64/Apple Silicon.
-		"VARIANT": "3.10-bullseye",
-		// Options
-		"NODE_VERSION": "lts/*",
-		"POETRY_VERSION": "1.5.1",
-	  }
+		"dockerfile": "Dockerfile",
+		"context": "..",
+		"args": {
+			// Update 'VARIANT' to pick a Python version
+			// Append -bullseye or -buster to pin to an OS version.
+			// Use -bullseye variants on local on arm64/Apple Silicon.
+			"VARIANT": "3.12-bullseye",
+			// Options
+			"POETRY_VERSION": "1.8.2"
+		}
 	},
-
 	// Configure tool-specific properties.
 	"customizations": {
 		// Configure properties specific to VS Code.
 		"vscode": {
-	// Set *default* container specific settings.json values on container create.
-	"settings": {
-	  "python.defaultInterpreterPath": "/usr/local/bin/python",
-	  "python.linting.enabled": true,
-	  "python.linting.pylintEnabled": true,
-	  "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
-	  "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
-	  "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
-	  "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
-	  "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
-	  "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
-	  "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
-	  "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
-	  "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
-	},
-			
-	// Add the IDs of extensions you want installed when the container is created.
-	"extensions": [
-	  "ms-python.python",
-				"ms-python.vscode-pylance"
+			// Set *default* container specific settings.json values on container create.
+			"settings": {
+				"python.defaultInterpreterPath": "./.venv/bin/python",
+				"[python]": {
+					"editor.defaultFormatter": "charliermarsh.ruff"
+				}
+			},
+			// Add the IDs of extensions you want installed when the container is created.
+			"extensions": [
+				"ms-python.python",
+				"ms-python.vscode-pylance",
+				"charliermarsh.ruff"
 			]
 		}
 	},
-
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 	// "forwardPorts": [],
-
 	// Use 'postCreateCommand' to run commands after the container is created.
 	"postCreateCommand": "bash ./.devcontainer/post-install.sh",
-
 	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
 	"remoteUser": "vscode"
-  }
+}

.devcontainer/post-install.sh

@@ -1,3 +1,4 @@
 #!/bin/sh
 
-poetry install
+poetry config virtualenvs.in-project true
+poetry install --all-extras

.github/workflows/ci.yaml

@@ -25,6 +25,10 @@ jobs:
       - name: Install dependencies
         run: |
           poetry install
+      - name: Run linting
+        run: |
+          poetry run ruff check .
+          poetry run ruff format . --check
       - name: Run mypy
         run: poetry run mypy src/rivian
       - name: Run tests with poetry and pytest

poetry.lock

@@ -23,6 +23,7 @@ pytest-asyncio = ">=0.18.3,<0.24.0"
 python-dotenv = ">=0.20,<1.1"
 aresponses = ">=2.1.5,<4.0.0"
 mypy = ">=1.7.0,<2.0.0"
+ruff = "^0.4"
 
 [tool.poetry.extras]
 ble = ["bleak", "dbus-fast"]
@@ -33,6 +34,10 @@ vcs = "git"
 style = "semver"
 pattern = "default-unprefixed"
 
+[tool.ruff.lint.isort]
+combine-as-imports = true
+split-on-trailing-comma = false
+
 [build-system]
 requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"]
 build-backend = "poetry_dynamic_versioning.backend"

pyproject.toml

@@ -1,4 +1,5 @@
 """Rivian BLE handler."""
+
 from __future__ import annotations
 
 import asyncio

src/rivian/ble.py

@@ -1,4 +1,5 @@
 """Rivian constants."""
+
 from __future__ import annotations
 
 import sys

src/rivian/const.py

@@ -1,4 +1,5 @@
 """Asynchronous Python client for the Rivian API."""
+
 from __future__ import annotations
 
 import asyncio
@@ -33,7 +34,7 @@
     import asyncio as async_timeout
 else:
     import async_timeout
-    
+
 _LOGGER = logging.getLogger(__name__)
 
 GRAPHQL_BASEPATH = "https://rivian.com/api/gql"

src/rivian/rivian.py

@@ -1,4 +1,5 @@
 """Utilities."""
+
 from __future__ import annotations
 
 import hashlib