Merge branch 'main' into fix/predict-numpy-images

Author: hansent

.github/workflows/publish.yml

@@ -30,3 +30,35 @@ jobs:
           PYPI_TEST_PASSWORD: ${{ secrets.PYPI_TEST_PASSWORD }}
         run: |
           make publish -e PYPI_USERNAME=$PYPI_USERNAME -e PYPI_PASSWORD=$PYPI_PASSWORD -e PYPI_TEST_PASSWORD=$PYPI_TEST_PASSWORD
+
+  deploy-docs:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: 🛎️ Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: 🐍 Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.8'
+
+      - name: 📚 Install MkDocs and dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs-material mkdocstrings mkdocstrings[python]
+          pip install ".[dev]"
+
+      - name: 🏗️ Build documentation
+        run: |
+          mkdocs build
+
+      - name: 🚀 Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site

.github/workflows/test.yml

@@ -8,10 +8,13 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        os: ["ubuntu-latest", "windows-latest"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+    runs-on: ${{ matrix.os }}
+    env:
+      PYTHONUTF8: 1
 
     steps:
       - name: 🛎️ Checkout

.gitignore

@@ -154,3 +154,4 @@ tests/manual/data
 README.roboflow.txt
 *.zip
 .DS_Store
+.claude

.pre-commit-config.yaml

@@ -6,7 +6,7 @@ ci:
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict
@@ -24,14 +24,14 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/PyCQA/bandit
-    rev: 1.7.9
+    rev: 1.8.3
     hooks:
       - id: bandit
         args: ["-c", "pyproject.toml"]
         additional_dependencies: ["bandit[toml]"]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.4
+    rev: v0.11.12
     hooks:
       - id: ruff-format
       - id: ruff

CLAUDE.md

@@ -0,0 +1,115 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Development Commands
+
+### Running Tests
+```bash
+python -m unittest
+```
+
+### Linting and Code Quality
+```bash
+# Format code with ruff
+make style
+
+# Check code quality (includes ruff and mypy)
+make check_code_quality
+
+# Individual commands
+ruff format roboflow
+ruff check roboflow --fix
+mypy roboflow
+```
+
+### Building Documentation
+```bash
+# Install documentation dependencies
+python -m pip install mkdocs mkdocs-material mkdocstrings mkdocstrings[python]
+
+# Serve documentation locally
+mkdocs serve
+```
+
+### Installing Development Environment
+```bash
+# Create virtual environment
+python3 -m venv env
+source env/bin/activate
+
+# Install in editable mode with dev dependencies
+pip install -e ".[dev]"
+
+# Install pre-commit hooks
+pip install pre-commit
+pre-commit install
+```
+
+## Architecture Overview
+
+The Roboflow Python SDK follows a hierarchical object model that mirrors the Roboflow platform structure:
+
+### Core Components
+
+1. **Roboflow** (`roboflow/__init__.py`) - Entry point and authentication
+   - Handles API key management and workspace initialization
+   - Provides `login()` for CLI authentication
+   - Creates workspace connections
+
+2. **Workspace** (`roboflow/core/workspace.py`) - Manages Roboflow workspaces
+   - Lists and accesses projects
+   - Handles dataset uploads and model deployments
+   - Manages workspace-level operations
+
+3. **Project** (`roboflow/core/project.py`) - Represents a computer vision project
+   - Manages project metadata and versions
+   - Handles image/annotation uploads
+   - Supports different project types (object-detection, classification, etc.)
+
+4. **Version** (`roboflow/core/version.py`) - Dataset version management
+   - Downloads datasets in various formats
+   - Deploys models
+   - Provides access to trained models for inference
+
+5. **Model Classes** (`roboflow/models/`) - Type-specific inference models
+   - `ObjectDetectionModel` - Bounding box predictions
+   - `ClassificationModel` - Image classification
+   - `InstanceSegmentationModel` - Pixel-level segmentation
+   - `SemanticSegmentationModel` - Class-based segmentation
+   - `KeypointDetectionModel` - Keypoint predictions
+
+### API Adapters
+
+- **rfapi** (`roboflow/adapters/rfapi.py`) - Low-level API communication
+- **deploymentapi** (`roboflow/adapters/deploymentapi.py`) - Model deployment operations
+
+### CLI Interface
+
+The `roboflow` command line tool (`roboflow/roboflowpy.py`) provides:
+- Authentication: `roboflow login`
+- Dataset operations: `roboflow download`, `roboflow upload`, `roboflow import`
+- Inference: `roboflow infer`
+- Project/workspace management: `roboflow project`, `roboflow workspace`
+
+### Key Design Patterns
+
+1. **Hierarchical Access**: Always access objects through their parent (Workspace → Project → Version → Model)
+2. **API Key Flow**: API key is passed down through the object hierarchy
+3. **Format Flexibility**: Supports multiple dataset formats (YOLO, COCO, Pascal VOC, etc.)
+4. **Batch Operations**: Upload and download operations support concurrent processing
+
+## Project Configuration
+
+- **Python Version**: 3.8+
+- **Main Dependencies**: See `requirements.txt`
+- **Entry Point**: `roboflow=roboflow.roboflowpy:main`
+- **Code Style**: Enforced by ruff with Google docstring convention
+- **Type Checking**: mypy configured for Python 3.8
+
+## Important Notes
+
+- API keys are stored in `~/.config/roboflow/config.json` (Unix) or `~/roboflow/config.json` (Windows)
+- The SDK supports both hosted inference (Roboflow platform) and local inference (via Roboflow Inference)
+- Pre-commit hooks automatically run formatting and linting checks
+- Test files intentionally excluded from linting: `tests/manual/debugme.py`

Dockerfile.dev

@@ -1,9 +1,17 @@
-FROM python:3.8
-RUN apt-get update && apt-get install -y make libgl1-mesa-glx && rm -rf /var/lib/apt/lists/*
+FROM python:3.10
+RUN apt-get update && apt-get install -y make curl libgl1-mesa-glx && rm -rf /var/lib/apt/lists/*
+RUN curl -LsSf https://astral.sh/uv/install.sh | sh
+ENV PATH="/root/.local/bin:${PATH}"
+
 WORKDIR /roboflow-python
 COPY .devcontainer/bashrc_ext /root/bashrc_ext
 RUN echo "source /root/bashrc_ext" >> ~/.bashrc
-COPY ./setup.py ./pyproject.toml ./README.md ./requirements.txt ./
+
+COPY ./requirements.txt ./
+RUN uv pip install --system -r requirements.txt
+
+COPY ./setup.py ./pyproject.toml ./README.md ./
 COPY roboflow/__init__.py ./roboflow/__init__.py
-RUN pip install -e ".[dev]"
+RUN uv pip install --system -e ".[dev]"
+
 COPY . .

requirements.txt

@@ -6,6 +6,7 @@ matplotlib
 numpy>=1.18.5
 opencv-python-headless==4.10.0.84
 Pillow>=7.1.2
+pillow-heif>=0.18.0
 python-dateutil
 python-dotenv
 requests

roboflow/__init__.py

@@ -15,7 +15,7 @@
 from roboflow.models import CLIPModel, GazeModel  # noqa: F401
 from roboflow.util.general import write_line
 
-__version__ = "1.1.50"
+__version__ = "1.1.65"
 
 
 def check_key(api_key, model, notebook, num_retries=0):
@@ -43,7 +43,7 @@ def check_key(api_key, model, notebook, num_retries=0):
                     num_retries += 1
                     return check_key(api_key, model, notebook, num_retries)
                 else:
-                    raise RuntimeError("There was an error validating the api key with Roboflow" " server.")
+                    raise RuntimeError("There was an error validating the api key with Roboflow server.")
             else:
                 r = response.json()
                 return r
@@ -71,7 +71,7 @@ def login(workspace=None, force=False):
     # default configuration location
     conf_location = os.getenv("ROBOFLOW_CONFIG_DIR", default=default_path)
     if os.path.isfile(conf_location) and not force:
-        write_line("You are already logged into Roboflow. To make a different login," "run roboflow.login(force=True).")
+        write_line("You are already logged into Roboflow. To make a different login,run roboflow.login(force=True).")
         return None
         # we could eventually return the workspace object here
         # return Roboflow().workspace()
@@ -131,17 +131,12 @@ def initialize_roboflow(the_workspace=None):
 
     global active_workspace
 
-    conf_location = os.getenv("ROBOFLOW_CONFIG_DIR", default=str(Path.home() / ".config" / "roboflow" / "config.json"))
-
-    if not os.path.isfile(conf_location):
-        raise RuntimeError("To use this method, you must first login - run roboflow.login()")
+    if the_workspace is None:
+        active_workspace = Roboflow().workspace()
     else:
-        if the_workspace is None:
-            active_workspace = Roboflow().workspace()
-        else:
-            active_workspace = Roboflow().workspace(the_workspace)
+        active_workspace = Roboflow().workspace(the_workspace)
 
-        return active_workspace
+    return active_workspace
 
 
 def load_model(model_url):

roboflow/adapters/deploymentapi.py

@@ -9,10 +9,13 @@ class DeploymentApiError(Exception):
     pass
 
 
-def add_deployment(api_key, machine_type, duration, delete_on_expiration, deployment_name, inference_version):
+def add_deployment(
+    api_key, creator_email, machine_type, duration, delete_on_expiration, deployment_name, inference_version
+):
     url = f"{DEDICATED_DEPLOYMENT_URL}/add"
     params = {
         "api_key": api_key,
+        "creator_email": creator_email,
         # "security_level": security_level,
         "duration": duration,
         "delete_on_expiration": delete_on_expiration,
@@ -69,6 +72,22 @@ def get_deployment_usage(api_key, deployment_name, from_timestamp, to_timestamp)
     return response.status_code, response.json()
 
 
+def pause_deployment(api_key, deployment_name):
+    url = f"{DEDICATED_DEPLOYMENT_URL}/pause"
+    response = requests.post(url, json={"api_key": api_key, "deployment_name": deployment_name})
+    if response.status_code != 200:
+        return response.status_code, response.text
+    return response.status_code, response.json()
+
+
+def resume_deployment(api_key, deployment_name):
+    url = f"{DEDICATED_DEPLOYMENT_URL}/resume"
+    response = requests.post(url, json={"api_key": api_key, "deployment_name": deployment_name})
+    if response.status_code != 200:
+        return response.status_code, response.text
+    return response.status_code, response.json()
+
+
 def delete_deployment(api_key, deployment_name):
     url = f"{DEDICATED_DEPLOYMENT_URL}/delete"
     response = requests.post(url, json={"api_key": api_key, "deployment_name": deployment_name})