Merge pull request #36 from EO-DataHub/migrate-to-uv

Migrate to uv with modern QA tooling

Author: figi44

.dockerignore

@@ -27,7 +27,6 @@ htmlcov
 Makefile
 .pre-commit-config.yaml
 CHANGELOG.md
-README.md
 
 # IDE and editor files
 .vscode

.github/workflows/actions.yaml

@@ -1,6 +1,5 @@
 name: All checks
 on:
-  workflow_call:
   push:
     tags:
       - 'v[0-9]+'
@@ -11,22 +10,11 @@ on:
       - 'v[0-9]+.[0-9]+.[0-9]+-*'
     branches:
       - '**'
+  pull_request: ~
 
 jobs:
-  pre-commit-preparation:
-    name: Pre-commit
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v3
-
-      - name: Copy config
-        run: |
-          if [ ! -f .pre-commit-config.yaml ]; then
-            curl -o .pre-commit-config.yaml https://raw.githubusercontent.com/EO-DataHub/github-actions/main/.pre-commit-config-python.yaml
-          fi          
-
-      - uses: pre-commit/action@v3.0.1
+  qa:
+    uses: EO-DataHub/github-actions/.github/workflows/qa-python.yaml@main
 
   security-scan:
     name: Call Security Scan
@@ -36,25 +24,11 @@ jobs:
     name: Run unit tests
     uses: EO-DataHub/github-actions/.github/workflows/unit-tests-python-uv.yaml@main
 
-  get-tag-name:
-    runs-on: ubuntu-latest
-    outputs:
-      image_tag: ${{ steps.get-image-tag.outputs.IMAGE_TAG }}
-    steps:
-      - name: Get image tag
-        id: get-image-tag
-        run: |
-          IMAGE_TAG=$(if [[ "${GITHUB_REF##refs/tags/}" =~ ^v ]]; then echo ${GITHUB_REF##refs/tags/v}; elif [[ "${GITHUB_REF}" == "refs/heads/main" ]]; then echo "latest"; else echo "${GITHUB_REF##refs/heads/}-latest" | sed "s/[^a-zA-Z0-9]/-/g" ; fi) >> "$GITHUB_ENV"
-          echo $IMAGE_TAG
-          echo "IMAGE_TAG=$IMAGE_TAG" >> "$GITHUB_OUTPUT"
-
   publish:
     name: Build and push Docker image
-    needs: [get-tag-name]
     uses: EO-DataHub/github-actions/.github/workflows/ecr-publish.yaml@main
     with:
       image_name: ${{ vars.IMAGE_NAME }}
-      image_tag: ${{ needs.get-tag-name.outputs.image_tag }}
       aws_role_arn: ${{ vars.AWS_ROLE_ARN }}
       aws_ecr_alias: ${{ vars.AWS_ECR_ALIAS }}
     permissions:

Makefile

@@ -1,41 +1,56 @@
-.PHONY: dockerbuild dockerpush test testonce ruff black lint isort pre-commit-check requirements-update requirements setup
 VERSION ?= latest
 IMAGENAME = resource-catalogue-fastapi
 DOCKERREPO ?= public.ecr.aws/eodh
 uv-run ?= uv run --no-sync
 
+.PHONY: dockerbuild
 dockerbuild:
 	DOCKER_BUILDKIT=1 docker build -t ${IMAGENAME}:${VERSION} .
 
+.PHONY: dockerpush
 dockerpush: dockerbuild
 	docker tag ${IMAGENAME}:${VERSION} ${DOCKERREPO}/${IMAGENAME}:${VERSION}
 	docker push ${DOCKERREPO}/${IMAGENAME}:${VERSION}
 
+.PHONY: test
 test:
-	${uv-run} ptw resource_catalogue_fastapi
+	${uv-run} ptw .
 
+.PHONY: testonce
 testonce:
 	${uv-run} pytest
 
-ruff:
-	${uv-run} ruff check .
+.git/hooks/pre-commit:
+	${uv-run} pre-commit install
+	curl -o .pre-commit-config.yaml https://raw.githubusercontent.com/EO-DataHub/github-actions/main/.pre-commit-config-python.yaml
 
-black:
-	${uv-run} black .
+.PHONY: setup
+setup: update .git/hooks/pre-commit
 
-isort:
-	${uv-run} isort . --profile black
+.PHONY: pre-commit
+pre-commit:
+	${uv-run} pre-commit
 
-validate-pyproject:
-	${uv-run} validate-pyproject pyproject.toml
+.PHONY: pre-commit-all
+pre-commit-all:
+	${uv-run} pre-commit run --all-files
 
-lint: ruff black isort validate-pyproject
+.PHONY: check
+check:
+	${uv-run} ruff check
+	${uv-run} ruff format --check --diff
+	${uv-run} pyright
+	${uv-run} validate-pyproject pyproject.toml
 
-uv-sync:
-	${uv-run} sync --frozen
+.PHONY: format
+format:
+	${uv-run} ruff check --fix
+	${uv-run} ruff format
 
-.git/hooks/pre-commit:
-	${uv-run} pre-commit install
-	curl -o .pre-commit-config.yaml https://raw.githubusercontent.com/EO-DataHub/github-actions/main/.pre-commit-config-python.yaml
+.PHONY: install
+install:
+	uv sync --frozen
 
-setup: uv-sync .git/hooks/pre-commit
+.PHONY: update
+update:
+	uv sync

pyproject.toml

@@ -24,55 +24,26 @@
 
 [project]
 name = "resource-catalogue-fastapi"
-dynamic = ["version"]
+version = "0.0.0"
 description = "A FastApi deployment to handle requests to update the resource catalogue"
 readme = "README.md"
-
-# Our target version is Python 3.13.
 requires-python = ">=3.13,<3.14"
-
 license = {file = "LICENSE"}
-
-# This should be your name or the name of the organization who originally
-# authored the project, and a valid email address corresponding to the name
-# listed.
 authors = [
   {name = "Telespazio UK Ltd", email = "alex.palmer@telespazio.com" }
 ]
-
 maintainers = [
   {name = "Telespazio UK Ltd", email = "alex.palmer@telespazio.com" }
 ]
-
-# Classifiers help users find your project by categorizing it.
-#
-# For a list of valid classifiers, see https://pypi.org/classifiers/
 classifiers = [
-  # How mature is this project? Common values are
-  #   3 - Alpha
-  #   4 - Beta
-  #   5 - Production/Stable
   "Development Status :: 3 - Alpha",
-
-  # Indicate who your project is intended for
   "Intended Audience :: Science/Research",
   "Intended Audience :: Developers",
-
-  # CHANGEME Pick your license as you wish
   "License :: OSI Approved :: Apache Software License",
-  # "License :: Other/Proprietary License",
-
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: 3 :: Only",
 ]
-
-# This field lists other packages that your project depends on to run.
-# Any package you put here will be installed by pip when your project is
-# installed, so they must be valid existing projects.
-#
-# For an analysis of this field vs pip's requirements files see:
-# https://packaging.python.org/discussions/install-requires-vs-requirements/
 dependencies = [
   "fastapi",
   "uvicorn",
@@ -86,95 +57,61 @@ dependencies = [
   "kubernetes",
 ]
 
-[dependency-groups] # Optional
+[dependency-groups]
 dev = [
+    "pre-commit",
+    "pyright",
     "pytest",
-    "pytest-xdist",
     "pytest-mock",
     "pytest-watcher",
-    "black",
+    "pytest-xdist",
     "ruff",
-    "isort",
-    "pre-commit",
+    "validate-pyproject",
     "httpx",
     "requests-mock",
-    "validate-pyproject>=0.24.1",
 ]
 
 [tool.uv]
-  constraint-dependencies = ["urllib3>=2.6.0"]
+package = true
 
-# List URLs that are relevant to your project
-#
-# This field corresponds to the "Project-URL" and "Home-Page" metadata fields:
-# https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use
-# https://packaging.python.org/specifications/core-metadata/#home-page-optional
-#
-# Examples listed include a pattern for specifying where the package tracks
-# issues, where the source is hosted, where to say thanks to the package
-# maintainers, and where to support the project financially. The key is
-# what's used to render the link text on PyPI.
-[project.urls]  # Optional
-homepage = "https://github.com/UKEODHP/"
-repository = "CHANGEME-https://github.com/UKEODHP/..."
-changelog = "CHANGEME-https://github.com/UKEODHP/.../master/CHANGELOG.md"
+[project.urls]
+homepage = "https://github.com/EO-DataHub/resource-catalogue-fastapi"
+repository = "https://github.com/EO-DataHub/resource-catalogue-fastapi"
 
 [build-system]
-# These are the assumed default build requirements from pip:
-# https://pip.pypa.io/en/stable/reference/pip/#pep-517-and-518-support
-requires = ["setuptools>=69.0.0", "wheel", "setuptools-git-versioning>=2.0,<3"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 
 [tool.pytest.ini_options]
-pythonpath = ["."]
+addopts = ["--import-mode=importlib"]
 markers = [
   "integrationtest: Integration test"
 ]
 
-[tool.setuptools]
-packages = []
-
-[tool.setuptools-git-versioning]
-enabled = true
-
-[tool.black]
-line-length = 100
-target-version = ['py311']
-
 [tool.ruff]
-line-length = 110
-target-version = "py311"
-select = ["E", "F", "B", "W"]
-
-exclude = [
-    ".bzr",
-    ".direnv",
-    ".eggs",
-    ".git",
-    ".git-rewrite",
-    ".hg",
-    ".mypy_cache",
-    ".nox",
-    ".pants.d",
-    ".pytype",
-    ".ruff_cache",
-    ".svn",
-    ".tox",
-    ".venv",
-    "__pypackages__",
-    "_build",
-    "buck-out",
-    "build",
-    "dist",
-    "node_modules",
-    "venv",
+line-length = 119
+
+[tool.ruff.lint]
+select = [
+    "E",    # Pycodestyle errors
+    "W",    # Pycodestyle warnings
+    "F",    # Pyflakes
+    "I",    # isort
+    "FAST", # FastAPI
+    "RUF",  # RUF-specific rules
+    "SIM",  # Simplifications
+    "B",    # Bugbear
+    "ANN",  # Annotations
+    "PLC",  # Pylint convention
+    "PLE",  # Pylint errors
+    "UP",   # pyupgrade
+    "FURB", # refurb
+    "PT",   # pytest
+]
+ignore = [
+    "E501",   # line too long
+    "SIM108", # ternary operator
+    "SIM103", # return bool directly
+    "B008",   # function call in default argument (incompatible with FastAPI)
+    "ANN401", # dynamically typed Any (needed for FastAPI Depends)
 ]
-
-[tool.pylint.'MESSAGES CONTROL']
-disable = '''
-    line-too-long,
-    missing-class-docstring, 
-    too-many-locals, 
-    too-many-instance-attributes,
-    logging-fstring-interpolation,
-'''