Merge pull request #238 from stac-utils/feature/switch-to-uv

switch to UV

Author: vincentsarago

.github/workflows/ci.yml

@@ -22,35 +22,32 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version:
-        - '3.10'
-        - '3.11'
-        - '3.12'
-        - '3.13'
+        python-version: ['3.11', '3.12', '3.13']
 
     steps:
       - uses: actions/checkout@v5
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v6
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
         with:
+          version: "0.9.*" 
+          enable-cache: true
           python-version: ${{ matrix.python-version }}
 
       - name: install lib postgres
         uses: nyurik/action-setup-postgis@v2
 
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install -e .["test,psycopg"]
+          uv sync --extra psycopg 
 
       - name: Run pre-commit
         if: ${{ matrix.python-version == env.LATEST_PY_VERSION }}
         run: |
-          python -m pip install pre-commit
-          pre-commit run --all-files
+          uv run pre-commit run --all-files
 
       - name: Run tests
-        run: python -m pytest --cov titiler.pgstac --cov-report xml --cov-report term-missing --asyncio-mode=strict -s -vv
+        run: uv run pytest --cov titiler.pgstac --cov-report xml --cov-report term-missing --asyncio-mode=strict -s -vv
 
       - name: Upload Results
         if: ${{ matrix.python-version == env.LATEST_PY_VERSION }}
@@ -65,14 +62,21 @@ jobs:
     needs: [tests]
     runs-on: ubuntu-latest
     env:
-      PGSTAC_VERSION: '0.9.2'
+      PGSTAC_VERSION: '0.9.8'
     steps:
       - uses: actions/checkout@v5
 
-      - name: Set up Python 3.12
-        uses: actions/setup-python@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
         with:
-          python-version: '3.12'
+          version: "0.9.*" 
+          enable-cache: true
+          python-version: ${{ env.LATEST_PY_VERSION }}
+     
+      - name: Install dependencies
+        run: |
+          uv sync --extra psycopg
+          uv pip install pypgstac==${{ env.PGSTAC_VERSION }}
 
       - name: Launch services
         run: docker compose up -d tiler-uvicorn
@@ -82,23 +86,19 @@ jobs:
       - name: install lib postgres
         uses: nyurik/action-setup-postgis@v2
 
-      - name: Install python dependencies
-        run: |
-          python -m pip install pypgstac==${{ env.PGSTAC_VERSION }} psycopg[pool] httpx pytest pytest-benchmark rasterio
-
       - name: Ingest Stac Items/Collection
         run: |
-          pypgstac pgready --dsn postgresql://username:[email protected]:5439/postgis
-          pypgstac load collections benchmark/stac/collection.json --dsn postgresql://username:[email protected]:5439/postgis --method insert_ignore
-          pypgstac load items benchmark/stac/items.json --dsn postgresql://username:[email protected]:5439/postgis --method insert_ignore
+          uv run pypgstac pgready --dsn postgresql://username:[email protected]:5439/postgis
+          uv run pypgstac load collections benchmark/stac/collection.json --dsn postgresql://username:[email protected]:5439/postgis --method insert_ignore
+          uv run pypgstac load items benchmark/stac/items.json --dsn postgresql://username:[email protected]:5439/postgis --method insert_ignore
 
       - name: Sleep for 10 seconds
         run: sleep 10s
         shell: bash
 
       - name: Run Benchmark
         run: |
-          python -m pytest .github/workflows/tests/benchmarks.py --benchmark-only --benchmark-columns 'min, max, mean, median' --benchmark-json output.json
+          uv run --group benchmark pytest .github/workflows/tests/benchmarks.py --benchmark-only --benchmark-columns 'min, max, mean, median' --benchmark-json output.json
 
       - name: Store and benchmark result
         uses: benchmark-action/github-action-benchmark@v1
@@ -124,17 +124,14 @@ jobs:
     if: startsWith(github.event.ref, 'refs/tags') || github.event_name == 'release'
     steps:
       - uses: actions/checkout@v5
-      - name: Set up Python
-        uses: actions/setup-python@v6
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
         with:
+          version: "0.9.*" 
+          enable-cache: true
           python-version: ${{ env.LATEST_PY_VERSION }}
 
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          python -m pip install wheel twine build
-          python -m pip install .
-
       - name: Set tag version
         id: tag
         run: |
@@ -144,17 +141,17 @@ jobs:
       - name: Set module version
         id: module
         run: |
-          echo version=$(python -c'import titiler.pgstac; print(titiler.pgstac.__version__)') >> $GITHUB_OUTPUT
-
+          echo version=$(uv run python -c'import titiler.pgstac; print(titiler.pgstac.__version__)') >> $GITHUB_OUTPUT
+      
       - name: Build and publish
         if: ${{ steps.tag.outputs.version }} == ${{ steps.module.outputs.version}}
         env:
-          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+          UV_PUBLISH_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          UV_PUBLISH_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
         run: |
           rm -rf dist
-          python -m build
-          twine upload dist/*
+          uv build
+          uv publish dist/*
 
   publish-docker:
     needs: [tests]

.github/workflows/deploy_mkdocs.yml

@@ -16,10 +16,11 @@ jobs:
       - name: Checkout main
         uses: actions/checkout@v5
 
-      - name: Set up Python 3.12
-        uses: actions/setup-python@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
         with:
-          python-version: 3.12
+          version: "0.9.*" 
+          enable-cache: true
 
       - name: Install dependencies
         run: |
@@ -43,3 +44,6 @@ jobs:
       - name: Deploy documentation and update alias for latest
         run: |
           mike deploy ${{ steps.module.outputs.version}} latest --push --update-aliases --config-file docs/mkdocs.yml
+     
+      - name: Deploy docs
+        run: uv run --group docs --extra psycopg mike deploy ${{ steps.module.outputs.version}} latest --push --update-aliases --config-file docs/mkdocs.yml

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.12.1
+    rev: v0.24
     hooks:
       - id: validate-pyproject
 

CONTRIBUTING.md

@@ -2,22 +2,27 @@
 
 Issues and pull requests are more than welcome: https://github.com/stac-utils/titiler-pgstac/issues
 
+We recommand using [`uv`](https://docs.astral.sh/uv) as project manager for development.
+
+See https://docs.astral.sh/uv/getting-started/installation/ for installation 
+
 **dev install**
 
 ```bash
-$ git clone https://github.com/stac-utils/titiler-pgstac.git
-$ cd titiler-pgstac
-$ python -m pip install -e ".[dev,test,psycopg]"
+git clone https://github.com/stac-utils/titiler-pgstac.git
+cd titiler-pgstac
+
+uv sync --extra psycopg
 ```
 
 You can then run the tests with the following command:
 
 ```sh
-python -m pytest --cov titiler.pgstac --cov-report term-missing
+uv run pytest --cov titiler.pgstac --cov-report term-missing
 ```
 
 This repo is set to use `pre-commit` to run *isort*, *flake8*, *pydocstring*, *black* ("uncompromising Python code formatter") and mypy when committing new code.
 
 ```bash
-$ pre-commit install
+uv run pre-commit run --all-files
 ```

README.md

@@ -34,20 +34,25 @@ To install from PyPI and run:
 
 ```bash
 # Make sure to have pip up to date
-$ python -m pip install -U pip
+python -m pip install -U pip
 
 # Install `psycopg` or `psycopg["binary"]` or `psycopg["c"]`
-$ python -m pip install psycopg["binary"]
+python -m pip install psycopg["binary"]
 
-$ python -m pip install titiler.pgstac
+python -m pip install titiler.pgstac
 ```
 
 To install from sources and run for development:
 
+We recommand using [`uv`](https://docs.astral.sh/uv) as project manager for development.
+
+See https://docs.astral.sh/uv/getting-started/installation/ for installation 
+
 ```
-$ git clone https://github.com/stac-utils/titiler-pgstac.git
-$ cd titiler-pgstac
-$ python -m pip install -e .
+git clone https://github.com/stac-utils/titiler-pgstac.git
+cd titiler-pgstac
+
+uv sync --extra psycopg 
 ```
 
 ### `PgSTAC` version

docker-compose.yml

@@ -77,7 +77,7 @@ services:
 
   database:
     container_name: stac-db
-    image: ghcr.io/stac-utils/pgstac:v${PGSTAC_VERSION-0.9.2}
+    image: ghcr.io/stac-utils/pgstac:v${PGSTAC_VERSION-0.9.8}
     environment:
       - POSTGRES_USER=username
       - POSTGRES_PASSWORD=password

pyproject.toml

@@ -2,7 +2,7 @@
 name = "titiler-pgstac"
 description = "Connect PgSTAC and TiTiler."
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 license = {file = "LICENSE"}
 authors = [
     {name = "Vincent Sarago", email = "[email protected]"},
@@ -20,7 +20,6 @@ classifiers = [
     "Intended Audience :: Information Technology",
     "Intended Audience :: Science/Research",
     "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
@@ -54,17 +53,20 @@ telemetry = [
     "opentelemetry-instrumentation-logging",
     "opentelemetry-exporter-otlp",
 ]
+
+[dependency-groups]
 dev = [
-    "pre-commit",
-    "bump-my-version",
-]
-test = [
     "pytest",
     "pytest-cov",
     "pytest-asyncio",
     "httpx",
     "pypgstac>=0.7,<=0.10",
     "pytest-postgresql",
+    "pre-commit",
+    "bump-my-version",
+]
+benchmark = [
+    "pytest-benchmark",
 ]
 docs = [
     "mkdocs>=1.4.3",
@@ -82,17 +84,18 @@ Issues = "https://github.com/stac-utils/titiler-pgstac/issues"
 Source = "https://github.com/stac-utils/titiler-pgstac"
 Changelog = "https://stac-utils.github.io/titiler-pgstac/release-notes/"
 
-[build-system]
-requires = ["pdm-backend"]
-build-backend = "pdm.backend"
-
-[tool.pdm.version]
-source = "file"
+[tool.hatch.version]
 path = "titiler/pgstac/__init__.py"
 
-[tool.pdm.build]
-includes = ["titiler/pgstac"]
-excludes = ["tests/", "**/.mypy_cache", "**/.DS_Store"]
+[tool.hatch.build.targets.sdist]
+only-include = ["titiler"]
+
+[tool.hatch.build.targets.wheel]
+only-include = ["titiler"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 
 [tool.coverage.run]
 branch = true