feat(py-client): Set up testing, formatters, linters, CI (#152)

Author: lcian

.github/workflows/ci.yml

@@ -47,6 +47,27 @@ jobs:
         env:
           RUSTDOCFLAGS: -Dwarnings
 
+  lint-python:
+    name: Lint Python
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@85856786d1ce8acfbcc2f13a5f3fbd6b938f9f41 # v7.1.2
+
+      - name: Install dependencies
+        run: uv sync --all-packages --all-groups
+
+      - name: Format
+        run: uv run ruff format
+
+      - name: Lint
+        run: uv run ruff check
+
+      - name: Run mypy
+        run: uv run mypy .
+
   test_all:
     name: Test (all features)
     runs-on: ubuntu-latest
@@ -89,6 +110,21 @@ jobs:
       - name: Run Tests
         run: cargo test --workspace --all-features
 
+  test-python:
+    name: Test Python
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@85856786d1ce8acfbcc2f13a5f3fbd6b938f9f41 # v7.1.2
+
+      - name: Install dependencies
+        run: uv sync --all-packages --all-groups
+
+      - name: Run tests
+        run: uv run pytest python-objectstore-client
+
   docs:
     name: Cargo Docs
     runs-on: ubuntu-latest

.gitignore

@@ -11,3 +11,4 @@ profile.json.gz
 .*.sw*
 
 **/__pycache__
+/dist

.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+# This pre-commit config is mainly aimed at formatting and linting the Python files in python-objectstore-client.
+# However, pre-commit requires this file to be placed at the root of the repository.
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-merge-conflict
+
+  - repo: local
+    hooks:
+      - id: ruff-check
+        name: ruff check
+        entry: ruff check
+        language: system
+        types_or: [python, pyi]
+      - id: ruff-format
+        name: ruff format
+        entry: ruff format
+        language: system
+        types_or: [python, pyi]
+      - id: mypy
+        name: mypy
+        entry: .venv/bin/mypy
+        language: system
+        types: [python]

devenv/sync.py

@@ -1,6 +1,7 @@
-from devenv import constants
 from devenv.lib import config, uv
 
+from devenv import constants
+
 
 def main(context: dict[str, str]) -> int:
     reporoot = context["reporoot"]

pyproject.toml

@@ -1,16 +1,33 @@
 [project]
 name = "objectstore"
 version = "0.1.0"
-requires-python = ">=3.13"
+requires-python = ">=3.13.1"
 
-[[tool.uv.index]]
-url = "https://pypi.devinfra.sentry.io/simple"
-default = true
+[tool.uv]
+required-version = "==0.9.3" # keep in sync with devenv/config.ini
 
 [tool.uv.workspace]
 members = [
     "python-objectstore-client",
 ]
 
 [dependency-groups]
-dev = ["devservices>=1.2.2"]
+dev = [
+    "devservices>=1.2.2",
+    "pytest>=8.3.3",
+    "mypy>=1.17.1",
+    "ruff>=0.14.2",
+    "pre-commit>=4.2.0",
+]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"] # pycodestyle, pyflakes, isort, pyupgrade
+
+[tool.mypy]
+no_implicit_reexport = true
+warn_unreachable = true
+warn_redundant_casts = true
+local_partial_types = true
+disallow_any_generics = true
+disallow_untyped_defs = true
+warn_unused_configs = true

python-objectstore-client/.gitignore

@@ -1 +1,22 @@
-# objectstore-client
+# Objectstore Client
+
+## Usage
+
+TODO
+
+## Development
+
+### Environment Setup
+
+The considerations for setting up the development environment that can be found in the main [README](../README.md) apply for this package as well.
+
+### Pre-commit hook
+
+A configuration to set up a git pre-commit hook using [pre-commit](https://github.com/pre-commit/pre-commit) is available at the root of the repository.
+
+To install it, run
+```sh
+pre-commit install
+```
+
+The hook will automatically run some checks before every commit, including the linters and formatters we run in CI.

python-objectstore-client/README.md

@@ -3,9 +3,9 @@ name = "objectstore-client"
 version = "0.1.0"
 description = "Python client for the Sentry Objectstore service"
 readme = "README.md"
-requires-python = ">=3.11.11"
+requires-python = ">=3.13.1"
 dependencies = []
 
 [build-system]
-requires = ["uv_build==0.9.3"] # must match the version specified in devenv/config.ini
+requires = ["uv_build"]
 build-backend = "uv_build"

python-objectstore-client/pyproject.toml

@@ -0,0 +1,4 @@
+def test_imports() -> None:
+    import objectstore_client
+
+    _ = objectstore_client