Add Backend abstraction around SG (#37)

Building out a shotgrid providor and the abstractions needed. A providor
for SG was added and pydantic models for different entitiy types. You
can test the API by connecting the the AWSF site Sam setup by copying
sg_example.docker-compose.local.yml, renaming to
docker-compose.local.yml and updating the variables. Once you update you
can run make build and make start-local. Once up, you can test out the
API with http://0.0.0.0:8000/docs

---------

Signed-off-by: James Spadafora <spadjv@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: jspada200

.cursor/rules/always-update-tests.mdc

@@ -0,0 +1,10 @@
+---
+name: always-update-tests
+description: Always run tests when making changes to the code.
+globs:
+alwaysApply: true
+---
+
+# Overview
+
+Always run tests when making changes to the code. For the Frontend, use npm run test. For the Backend, use make test.

.cursor/rules/apply-comments-only-when-needed.mdc

@@ -0,0 +1,10 @@
+---
+name: apply-comments-only-when-needed
+description: Only apply comments when needed.
+globs:
+alwaysApply: true
+---
+
+# Overview
+
+Only apply comments when needed. Do not apply comments to the code unless it is absolutely necessary to communicate the intent of the code. Do not apply comments to describe changes you made to the code based on the prompt.

.cursor/rules/run-formatting.mdc

@@ -0,0 +1,10 @@
+---
+name: run-formatting
+description: Run formatting when making changes to the code.
+globs:
+alwaysApply: true
+---
+
+# Overview
+
+When making changes to the backend, run `make format-python` to format the code after you are done making changes as a final step.

.github/workflows/backend-tests.yml

@@ -0,0 +1,38 @@
+name: Backend Tests
+
+on:
+  push:
+    branches: [ main, develop ]
+    paths:
+      - 'backend/**'
+  pull_request:
+    branches: [ main, develop ]
+    paths:
+      - 'backend/**'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+        
+    - name: Install dependencies
+      run: |
+        pip install -r requirements.txt
+      working-directory: backend
+        
+    - name: Run tests with coverage
+      run: |
+        python -m pytest --cov-fail-under=90
+      working-directory: backend
+      env:
+        SHOTGRID_URL: https://mock-shotgrid.example.com
+        SHOTGRID_SCRIPT_NAME: mock_script
+        SHOTGRID_API_KEY: mock_api_key

backend/.gitignore

@@ -35,3 +35,6 @@ coverage.xml
 dmypy.json
 *.log
 .DS_Store
+
+# Local environment files
+docker-compose.local.yml

backend/Dockerfile

@@ -17,6 +17,9 @@ RUN pip install --no-cache-dir -r requirements.txt
 # Copy application code
 COPY src/ ./src/
 
+# Add src to Python path so 'dna' package is importable
+ENV PYTHONPATH="/app/src:${PYTHONPATH}"
+
 # Expose port
 EXPOSE 8000
 

backend/README.md

@@ -40,6 +40,22 @@ To setup the backend, you need to have the following:
 - An LLM provider (OpenAI, Anthropic, Google, etc.)
 - A transcription provider (Vexa, etc.)
 
+### ShotGrid Configuration
+
+To configure ShotGrid credentials, create a local docker-compose override file:
+
+1. Copy the example file:
+   ```bash
+   cp sg_example.docker-compose.local.yml docker-compose.local.yml
+   ```
+
+2. Edit `docker-compose.local.yml` and update the environment variables with your ShotGrid credentials:
+   - `SHOTGRID_URL`: Your ShotGrid site URL (e.g., `https://your-studio.shotgrid.autodesk.com`)
+   - `SHOTGRID_API_KEY`: Your ShotGrid API key
+   - `SHOTGRID_SCRIPT_NAME`: Your ShotGrid script name
+
+3. The `docker-compose.local.yml` file is gitignored, so your credentials will not be committed to the repository.
+
 ### Running the Backend
 
 To run the backend, you need to have the following:

backend/docker-compose.yml

@@ -14,6 +14,10 @@ services:
       - ./coverage.xml:/app/coverage.xml
     environment:
       - PYTHONUNBUFFERED=1
+      - SHOTGRID_URL=https://your-shotgrid-url.com
+      - SHOTGRID_API_KEY=your-shotgrid-api-key
+      - SHOTGRID_SCRIPT_NAME=your-shotgrid-script-name
+      - PRODTRACK_PROVIDER=shotgrid
     restart: unless-stopped
     healthcheck:
       test: ["CMD", "curl", "-f", "http://localhost:8000/health"]

backend/makefile

@@ -1,30 +1,30 @@
 build:
-	docker-compose build --no-cache
+	docker-compose -f docker-compose.yml -f docker-compose.local.yml build --no-cache
 
 start-local:
-	docker-compose up --build
+	docker-compose -f docker-compose.yml -f docker-compose.local.yml up --build
 
 stop-local:
-	docker-compose down
+	docker-compose -f docker-compose.yml -f docker-compose.local.yml down
 
 logs-local:
-	docker-compose logs -f
+	docker-compose -f docker-compose.yml -f docker-compose.local.yml logs -f
 
 restart-local:
 	make stop-local
 	make start-local
 
 shell:
-	docker-compose run --rm api bash
+	docker-compose -f docker-compose.yml -f docker-compose.local.yml run --rm api bash
 
 test:
-	docker-compose run --rm api python -m pytest
+	docker-compose -f docker-compose.yml -f docker-compose.local.yml run --rm api python -m pytest
 
 test-cov:
-	docker-compose run --rm api python -m pytest
+	docker-compose -f docker-compose.yml -f docker-compose.local.yml run --rm api python -m pytest
 
 test-cov-html:
-	docker-compose run --rm api python -m pytest
+	docker-compose -f docker-compose.yml -f docker-compose.local.yml run --rm api python -m pytest
 	@echo "Coverage report available at htmlcov/index.html"
 
 venv-lint:

backend/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.isort]
 profile = "black"
-src_paths = ["src", "tests"]
-known_first_party = ["src", "dna"]
+src_paths = ["dna", "tests"]
+known_first_party = ["dna"]
 
 [tool.black]
 line-length = 88