Adding uv and improving docs (M2-9744) (#1941)

* uv started

* docker

* ruff and mypy fixes

* Docker tweaks

* More docker tweaks

* Build works

* compose tweaks

* Dockerfile tweak

* uv lock

* More docker cleanup

* Readme work

* Separate docs

* More docs

* Doc cleanup

* Document links

* removing internal sqlalchemy immutable dict

* docker

* removing pipenv from github actions

* curl in final image

* fixed test pipeline

* removed test ref

* Correct migrate make target

* Minor readme changes

* Minor readme changes and other tweaks

* Version bump to match upstream

* Fixing Make commands

* Makefile updates

Author: aweiland

.dockerignore

@@ -12,4 +12,12 @@ allure-results
 .github
 Jenkinsfile.groovy
 Makefile
-buildspec.yaml
+buildspec.yaml
+.venv
+.env.default
+copilot
+.idea
+docs
+
+htmlcov
+.coverage

.github/dependabot.yml

@@ -1,13 +1,11 @@
 version: 2
 updates:
-  - package-ecosystem: "pip"
+  - package-ecosystem: "uv"
     directory: "/"
     schedule:
       interval: "weekly"
     allow:
       - dependency-type: "all"
-    ignore:
-      - dependency-name: "pipenv"
     commit-message:
       prefix: "[pip] Dependabot:"
       prefix-development: "[pip-dev] Dependabot:"

.github/workflows/code_quality.yaml

@@ -20,11 +20,11 @@ jobs:
         run: git secrets --register-aws
       - name: Scan aws secrets
         run: git secrets --scan
-      - name: Install pipenv
-        run: python -m pip install --upgrade pip && pip install pipenv
-      - name: Install deps
-        run: pipenv sync --system --dev
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Install dependencies
+        run: uv sync --locked
       - name: Check formatting
-        run: ruff check . && ruff format --check .
+        run: uv run ruff check . && uv run ruff format --check .
       - name: Check types
-        run: mypy ./
+        run: uv run mypy ./

.github/workflows/tests.yaml

@@ -14,11 +14,23 @@ jobs:
       - uses: KengoTODA/actions-setup-docker-compose@v1
         with:
           version: '2.23.3'
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.13'  # or your preferred version
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: |
+          uv sync --locked
+
       - name: "Running tests"
         run: |
           cp .env.default .env
           echo -e "\nRABBITMQ__USE_SSL=False" >> .env
-          docker compose up -d postgres rabbitmq redis
+          docker compose up -d rabbitmq postgres redis mailhog
           make test
 
       - name: Collect artifacts

.gitignore

@@ -23,6 +23,7 @@ __pycache__/
 # Unit test / coverage reports
 .coverage
 .coverage.*
+htmlcov
 
 # Hypothesis
 .hypothesis/
@@ -41,13 +42,10 @@ data/
 ## Logs
 *.log
 
-
-
 ## Docker stuff
 docker-compose.local.yaml
 
 
-
 ## Project configurations
 *.env
 

Makefile

@@ -1,14 +1,14 @@
 PORT = 8000
 HOST = localhost
 
-TEST_COMMAND = pytest -s -vv --alluredir=allure-results
+TEST_COMMAND = PYTHONPATH=src uv run pytest -s -vv --alluredir=allure-results
 COVERAGE_COMMAND = coverage run --branch --concurrency=thread,gevent -m pytest  
 REPORT_COVERAGE_COMMAND = coverage html --show-contexts --title "Coverage for ${SHA}"
 
 EXPORT_COMMAND = python src/export_spec.py
 
-RUFF_COMMAND = ruff
-MYPY_COMMAND = mypy
+RUFF_COMMAND = uv run ruff
+MYPY_COMMAND = uv run mypy
 
 DOCKER_COMPOSE_EXISTS := $(shell command -v docker-compose 2> /dev/null)
 
@@ -28,7 +28,7 @@ COVERAGE_DOCKER_EXEC = ${DOCKER_COMPOSE_CMD} run --rm -u root app
 # NOTE: Make sure that Redis server is running
 .PHONY: run
 run:
-	uvicorn src.main:app --proxy-headers --host ${HOST} --port ${PORT} --reload
+	PYTHONPATH=src uv run uvicorn src.main:app --proxy-headers --host ${HOST} --port ${PORT} --reload
 
 .PHONY: run_local
 run_local:
@@ -40,11 +40,7 @@ test:
 
 .PHONY: migrate
 migrate:
-	./compose/fastapi/migrate
-
-.PHONY: migrate-arbitrary
-migrate-arbitrary:
-	./compose/fastapi/migrate arbitrary
+	uv run alembic upgrade head
 
 # NOTE: cq == "Code quality"
 .PHONY: cq