Merge pull request #89 from tharropoulos/migrate-to-uv

build: modernize CI workflow with uv and improve code quality tooling

Author: kishorenc

.github/workflows/release.yml

@@ -21,7 +21,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: "3.8"
+        python-version: "3.9"
         cache: pip
 
     - name: Install build dependencies

.github/workflows/test-and-lint.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
     services:
       typesense:
         image: typesense/typesense:28.0
@@ -31,27 +31,25 @@ jobs:
     - name: Wait for Typesense
       run: |
         timeout 20 bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:8108/health)" != "200" ]]; do sleep 1; done' || false
+
     - uses: actions/checkout@v4
 
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+    - name: Install uv and set the python version
+      uses: astral-sh/setup-uv@v5
       with:
         python-version: ${{ matrix.python-version }}
-        cache: 'pip'
 
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r requirements/dev.txt
+    - name: Install the project
+      run: uv sync --locked --all-extras --dev
 
-    - name: Lint with Flake8
+    - name: Lint with Ruff
       run: |
-        flake8 src/typesense
+        uv run ruff check src/typesense
 
     - name: Check types with mypy
       run: |
-        mypy src/typesense
+        uv run mypy src/typesense
 
     - name: Run tests and coverage (excluding OpenAI)
       run: |
-        coverage run -m pytest -m "not open_ai"
+        uv run coverage run -m pytest -m "not open_ai"

.python-version

@@ -1,17 +1,14 @@
-[build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
-
 [project]
 name = "typesense"
 description = "Python client for Typesense, an open source and typo tolerant search engine."
-authors = [
-    {"name" = "Typesense", "email" = "[email protected]"},
-]
+authors = [{ name = "Typesense", email = "[email protected]" }]
+requires-python = ">=3.9"
 readme = "README.md"
-requires-python = ">=3"
-keywords = ["search", "typesense"]
-license = {"text" = "Apache 2.0"}
+license = { text = "Apache 2.0" }
+keywords = [
+    "search",
+    "typesense",
+]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
@@ -27,6 +24,31 @@ Documentation = "https://typesense.org/"
 Source = "https://github.com/typesense/typesense-python"
 Tracker = "https://github.com/typesense/typesense-python/issues"
 
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[dependency-groups]
+dev = [
+    "mypy",
+    "pytest",
+    "coverage",
+    "pytest-mock",
+    "requests-mock",
+    "python-dotenv",
+    "types-requests",
+    "faker",
+    "ruff>=0.11.11",
+    "isort>=6.0.1",
+]
+
+[tool.uv]
+package = false
+
+[[tool.uv.index]]
+name = "pypi"
+url = "https://pypi.org/simple"
+
 [tool.setuptools.dynamic]
 version = {attr = "typesense.__version__"}
 

Pipfile

@@ -0,0 +1,48 @@
+# This file was autogenerated by uv via the following command:
+#    uv pip compile pyproject.toml --group dev -o requirements-dev.txt
+certifi==2025.4.26
+    # via requests
+charset-normalizer==3.4.2
+    # via requests
+coverage==7.8.2
+    # via typesense (pyproject.toml:dev)
+faker==37.3.0
+    # via typesense (pyproject.toml:dev)
+idna==3.10
+    # via requests
+iniconfig==2.1.0
+    # via pytest
+mypy==1.15.0
+    # via typesense (pyproject.toml:dev)
+mypy-extensions==1.1.0
+    # via mypy
+packaging==25.0
+    # via pytest
+pluggy==1.6.0
+    # via pytest
+pytest==8.3.5
+    # via
+    #   typesense (pyproject.toml:dev)
+    #   pytest-mock
+pytest-mock==3.14.1
+    # via typesense (pyproject.toml:dev)
+python-dotenv==1.1.0
+    # via typesense (pyproject.toml:dev)
+requests==2.32.3
+    # via
+    #   typesense (pyproject.toml)
+    #   requests-mock
+requests-mock==1.12.1
+    # via typesense (pyproject.toml:dev)
+ruff==0.11.11
+    # via typesense (pyproject.toml:dev)
+types-requests==2.32.0.20250515
+    # via typesense (pyproject.toml:dev)
+typing-extensions==4.13.2
+    # via mypy
+tzdata==2025.2
+    # via faker
+urllib3==2.4.0
+    # via
+    #   requests
+    #   types-requests

Pipfile.lock

@@ -1,2 +1,12 @@
--i https://pypi.org/simple
--r requirements/common.txt
+# This file was autogenerated by uv via the following command:
+#    uv pip compile pyproject.toml -o requirements.txt
+certifi==2024.8.30
+    # via requests
+charset-normalizer==3.3.2
+    # via requests
+idna==3.8
+    # via requests
+requests==2.32.3
+    # via typesense (pyproject.toml)
+urllib3==2.2.2
+    # via requests