Feature/149 feature restructure qa as a uv project with package locks #114

jacksonjacobs1 · 2025-09-25T20:29:36Z

[#149] FEATURE: restructure qa as a uv project with package locks

https://jacksonjjacobs.com/openproject/work_packages/149

… environment

…ocker context

- note, this facilitates live development with a ray cluster. However, note that it's not perfect. If you add new files, make sure to set the ownership to user 1013, or else only add files from the host machine to control ownership.

…tainer configuration; add interactive terminal options to devcontainer service in docker-compose.

…ion instructions and adjust file mount settings.

jacksonjacobs1 · 2025-09-25T20:30:39Z

This PR makes the following changes

Use ray for base docker image: rayproject/ray-ml:2.49.1.3fe06a-py310-cu121

This base image already includes CUDA and pytorch python packages
Includes packages and configuration required for ray's autoscaler

uv manages base environment

All packages in pyproject.toml are versioned.
a uv.lock file contains the exact environment state for additional precision
adding packages with uv add automatically updates the above files.

Adds three distinct installation methods

quickstart: deploys quickannotator reliably in 1 command
multi-node: deploys quickannotator on a configurable multi-node cluster
for developers: installs quickannotator on local machine.

…as an environment variable.

Copilot

Pull Request Overview

This PR restructures QuickAnnotator as a UV project with package locks, focusing on containerized deployment and dependency management. The changes include migrating from a single Dockerfile to a Docker Compose setup, updating the build system to use UV for Python package management, and integrating Grafana for monitoring.

Replaced single Dockerfile with multi-service Docker Compose setup including PostgreSQL and Grafana
Updated pyproject.toml to use UV with locked dependency versions and removed dynamic versioning
Added Grafana integration with automatic dashboard and datasource setup

Reviewed Changes

Copilot reviewed 16 out of 19 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
pyproject.toml	Updated to use UV with fixed version and reorganized dependencies
quickannotator/config/init.py	Added PostgreSQL and Grafana configuration functions
quickannotator/config/config.ini	Updated database configuration to use PostgreSQL with separate parameters
quickannotator/grafana/utils.py	Added Grafana client for automatic datasource and dashboard setup
quickannotator/main.py	Added Grafana initialization call
deployment/	New deployment configuration files for Docker Compose and Ray cluster
.devcontainer/devcontainer.json	Updated to use Docker Compose instead of single Dockerfile

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-01T16:55:50Z

quickannotator/grafana/utils.py

+
+    def add_postgres_datasource(self, host, port, db, username, password) -> str:
+        name = "PostgreSQL"
+        try:    # NOTE: api client does not have a datasource search method, so we just have to try getting the datasource by name.


Remove the extra spaces before the comment. There should be only one space after the colon.

Copilot · 2025-10-01T16:55:51Z

quickannotator/grafana/utils.py

+            self.logger.info(f"Grafana datasource '{name}' already exists. Skipping creation.")
+            return existing_datasource["uid"]
+        except Exception as e:
+            self.logger.error(f"Datasource does not exist. Creating datasource...")


The error message is misleading. This is not an error condition but expected behavior when the datasource doesn't exist. Consider changing to info level and rephrasing as 'Datasource not found. Creating new datasource...'

Suggested change

self.logger.error(f"Datasource does not exist. Creating datasource...")

self.logger.info("Datasource not found. Creating new datasource...")

this suggestion seems...corret?

choosehappy

looks great - nice job- 1 or 2 minor questions

choosehappy · 2025-10-01T20:49:43Z

README.md

-        ```
-    - **Pre-existing cluster**: If you would like QA to connect to an existing Ray cluster, use the `--cluster_address` argument.
+2. Configure the `deployment/multi_node_cluster_config.yaml` file to specify the head and worker nodes of your ray cluster. See the [ray cluster launcher documentation](https://docs.ray.io/en/latest/cluster/vms/user-guides/launching.html) for more details. 
+    > All lines with the comment `CHANGE ME` should be configured.


should or must?

choosehappy · 2025-10-01T20:53:58Z

deployment/Dockerfile

+# --chown is needed because USER ray only affects run commands, not copy commands.
+# --mount is a feature that allows caching of pip downloads between builds.
+COPY --chown=ray:users ../pyproject.toml /opt/QuickAnnotator/
+RUN --mount=type=cache,target=/root/.cache/uv \


wow- super cool. didn't know that this was a feature!

choosehappy · 2025-10-01T20:59:49Z

quickannotator/config/config.ini


 ; NOTE: Use this URI for PostgreSQL. Replace with your credentials
-database_uri = postgresql+psycopg2://admin:admin@postgis:5432/gisdb 
+postgres_username = admin


so these values need to match the ones which are in docker-compose?

choosehappy · 2025-10-01T21:01:16Z

quickannotator/grafana/utils.py

+            self.logger.info(f"Grafana datasource '{name}' already exists. Skipping creation.")
+            return existing_datasource["uid"]
+        except Exception as e:
+            self.logger.error(f"Datasource does not exist. Creating datasource...")


this suggestion seems...corret?

jacksonjacobs1 added 20 commits September 16, 2025 15:20

[#149] FEATURE: restructure qa as a uv project with package locks

50010e8

https://jacksonjjacobs.com/openproject/work_packages/149

start migrating project to uv

61a94ef

Add GDAL dependency to project configuration

3bef2b9

Update .gitignore to include .venv directory

05e52e3

update base image in dockerfile

a55dba5

create qa dependencies in uv project

f385f9e

use environment variable for postgres uri

200ed0c

change base image to specific release

9a78f72

refactor Dockerfile to support mount caches, and make uv manage conda…

877f346

… environment

add .dockerignore to exclude unnecessary files and directories from D…

e0b579e

…ocker context

use pip interface for uv in dockerfile

444d029

Add deployment work.

709167e

- note, this facilitates live development with a ray cluster. However, note that it's not perfect. If you add new files, make sure to set the ownership to user 1013, or else only add files from the host machine to control ownership.

Add segmentation-models-pytorch dependency and set pycache directory

555e2ee

separate development and deployment workflows

c1e42e3

Remove remote user setting and simplify post-create command in devcon…

e2cf64c

…tainer configuration; add interactive terminal options to devcontainer service in docker-compose.

update mounts

ee8b7e4

support nvidia ctk

7652982

Refactor README and local cluster configuration; streamline installat…

1ee7141

…ion instructions and adjust file mount settings.

finalized 3 installation approaches and updated readme

903976c

fix small error in devcontainer.json

ee5564a

jacksonjacobs1 added 9 commits September 25, 2025 16:46

trim down cluster config file and update readme

c73ae39

fix: update POSTGRES_URI to use service name instead of IP address

2438ecb

add nas_read and nas_write instructions

02aa6a1

move postgres arguments to config.ini. Only the postgres host is set …

d9a95a9

…as an environment variable.

no longer need full postgres URI in config.ini

6011f97

automatically configure grafana log dashboard

8f0cda8

Correctly set datasource password and handle existing datasource

c82fdbb

add todo

3e4b9e7

typo fix

c8e20c4

remove redundant requirements.txt file

18740e9

This was referenced Sep 30, 2025

Feature/155 feature increase polygon close proximity radius #115

Open

Feature/154 feature rename title bar to quickannotator #116

Open

jacksonjacobs1 requested review from Copilot and choosehappy October 1, 2025 16:55

Copilot AI reviewed Oct 1, 2025

View reviewed changes

choosehappy approved these changes Oct 1, 2025

View reviewed changes

jacksonjacobs1 mentioned this pull request Oct 1, 2025

Feature/156-feature-add-tooltips-when-hovering-over-toolbar #117

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Feature/149 feature restructure qa as a uv project with package locks #114

Feature/149 feature restructure qa as a uv project with package locks #114

Uh oh!

jacksonjacobs1 commented Sep 25, 2025 •

edited

Loading

Uh oh!

jacksonjacobs1 commented Sep 25, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Oct 1, 2025

Uh oh!

Copilot AI Oct 1, 2025

Uh oh!

choosehappy Oct 1, 2025

Uh oh!

choosehappy left a comment

Uh oh!

choosehappy Oct 1, 2025

Uh oh!

choosehappy Oct 1, 2025

Uh oh!

choosehappy Oct 1, 2025

Uh oh!

choosehappy Oct 1, 2025

Uh oh!

Uh oh!

	self.logger.error(f"Datasource does not exist. Creating datasource...")
	self.logger.info("Datasource not found. Creating new datasource...")

Feature/149 feature restructure qa as a uv project with package locks #114

Are you sure you want to change the base?

Feature/149 feature restructure qa as a uv project with package locks #114

Uh oh!

Conversation

jacksonjacobs1 commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jacksonjacobs1 commented Sep 25, 2025

This PR makes the following changes

Use ray for base docker image: rayproject/ray-ml:2.49.1.3fe06a-py310-cu121

uv manages base environment

Adds three distinct installation methods

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

choosehappy Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

choosehappy left a comment

Choose a reason for hiding this comment

Uh oh!

choosehappy Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

choosehappy Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

choosehappy Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

choosehappy Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jacksonjacobs1 commented Sep 25, 2025 •

edited

Loading