update from main

* feat(automate_sdk): support version result reporting

* fix(automate_tests): skip test, its not working in CI

* docs(automate_sdk): describe new args

.github/workflows/pr.yml

@@ -9,8 +9,55 @@ on:
       - "main"
 
 jobs:
-  test:
-    name: test
+  test-internal: # Run integration tests against the internal server image
+    name: Test (internal)
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: "ghcr.io"
+          username: ${{ github.actor }}
+          password: ${{ github.token }}
+
+      - name: Run Speckle Server
+        run: docker compose --file docker-compose-internal.yml up --detach --wait
+
+      - name: Run tests
+        run: uv run pytest --cov --cov-report xml:reports/coverage.xml --junitxml=reports/test-results.xml
+
+      - uses: codecov/codecov-action@v5
+        if: matrix.python-version == 3.12
+        with:
+          fail_ci_if_error: true # optional (default = false)
+          files: ./reports/test-results.xml # optional
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Minimize uv cache
+        run: uv cache prune --ci
+
+  test-public: # Run integration tests against the public server image
+    name: Test (public)
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -42,17 +89,10 @@ jobs:
         run: uv run pre-commit run --all-files
 
       - name: Run Speckle Server
-        run: docker compose up --detach --wait
+        run: docker compose --file docker-compose.yml up --detach --wait
 
       - name: Run tests
         run: uv run pytest --cov --cov-report xml:reports/coverage.xml --junitxml=reports/test-results.xml
 
-      - uses: codecov/codecov-action@v5
-        if: matrix.python-version == 3.13
-        with:
-          fail_ci_if_error: true # optional (default = false)
-          files: ./reports/test-results.xml # optional
-          token: ${{ secrets.CODECOV_TOKEN }}
-
       - name: Minimize uv cache
         run: uv cache prune --ci

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "ms-python.python",
+        "charliermarsh.ruff"
+    ]
+}

README.md

@@ -11,7 +11,11 @@
     The Python SDK
 </h3>
 
-<p align="center"><a href="https://codecov.io/gh/specklesystems/specklepy"><img src="https://codecov.io/gh/specklesystems/specklepy/branch/main/graph/badge.svg?token=8KQFL5N0YF" alt="Codecov"></a></p>
+<p align="center">
+  <a href="https://pypi.org/project/specklepy/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/specklepy"></a>
+  <a href="https://codecov.io/gh/specklesystems/specklepy"><img src="https://codecov.io/gh/specklesystems/specklepy/branch/main/graph/badge.svg?token=8KQFL5N0YF" alt="Codecov"></a>
+  <a href="https://github.com/specklesystems/specklepy/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/specklesystems/specklepy"></a>
+</p>
 
 # Repo structure
 

docker-compose-internal.yml

@@ -0,0 +1,118 @@
+name: "speckle-server"
+
+services:
+  ####
+  # Speckle Server dependencies
+  #######
+  postgres:
+    image: "postgres:16.4-alpine3.20@sha256:d898b0b78a2627cb4ee63464a14efc9d296884f1b28c841b0ab7d7c42f1fffdf"
+    restart: always
+    environment:
+      POSTGRES_DB: speckle
+      POSTGRES_USER: speckle
+      POSTGRES_PASSWORD: speckle
+    volumes:
+      - ./.volumes/postgres-data:/var/lib/postgresql/data/
+    healthcheck:
+      # the -U user has to match the POSTGRES_USER value
+      test: ["CMD-SHELL", "pg_isready -U speckle"]
+      interval: 5s
+      timeout: 5s
+      retries: 30
+
+  redis:
+    image: "valkey/valkey:8.1-alpine@sha256:0d27f0bca0249f61d060029a6aaf2e16b2c417d68d02a508e1dfb763fa2948b4"
+    restart: always
+    volumes:
+      - ./.volumes/redis-data:/data
+    healthcheck:
+      test: ["CMD", "redis-cli", "--raw", "incr", "ping"]
+      interval: 5s
+      timeout: 5s
+      retries: 30
+
+  minio:
+    image: "minio/minio:RELEASE.2023-10-25T06-33-25Z"
+    command: server /data --console-address ":9001"
+    restart: always
+    volumes:
+      - ./.volumes/minio-data:/data
+    ports:
+      - '127.0.0.1:9000:9000'
+      - '127.0.0.1:9001:9001'
+    healthcheck:
+      test:
+        [
+          "CMD-SHELL",
+          "curl -s -o /dev/null http://127.0.0.1:9000/minio/index.html",
+        ]
+      interval: 5s
+      timeout: 30s
+      retries: 30
+      start_period: 10s
+
+  speckle-server:
+    image: ghcr.io/specklesystems/speckle-server:latest
+    restart: always
+    healthcheck:
+      test:
+        - CMD
+        - /nodejs/bin/node
+        - -e
+        - "try { require('node:http').request({headers: {'Content-Type': 'application/json'}, port:3000, hostname:'127.0.0.1', path:'/readiness', method: 'GET', timeout: 2000 }, (res) => { body = ''; res.on('data', (chunk) => {body += chunk;}); res.on('end', () => {process.exit(Number(res.statusCode != 200 || body.toLowerCase().includes('error')));}); }).end(); } catch { process.exit(1); }"
+      interval: 10s
+      timeout: 10s
+      retries: 3
+      start_period: 90s
+    ports:
+      - "0.0.0.0:3000:3000"
+    depends_on:
+      postgres:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+      minio:
+        condition: service_healthy
+    environment:
+      # TODO: Change this to the URL of the speckle server, as accessed from the network
+      CANONICAL_URL: "http://127.0.0.1:8080"
+      SPECKLE_AUTOMATE_URL: "http://127.0.0.1:3030"
+      FRONTEND_ORIGIN: "http://127.0.0.1:8081"
+
+      # TODO: Change thvolumes:
+      REDIS_URL: "redis://redis"
+
+      S3_ENDPOINT: "http://minio:9000"
+      S3_PUBLIC_ENDPOINT: "http://127.0.0.1:9000"
+      S3_ACCESS_KEY: "minioadmin"
+      S3_SECRET_KEY: "minioadmin"
+      S3_BUCKET: "speckle-server"
+      S3_CREATE_BUCKET: "true"
+
+      FILE_SIZE_LIMIT_MB: 100
+      MAX_PROJECT_MODELS_PER_PAGE: 500
+
+      # TODO: Change this to a unique secret for this server
+      SESSION_SECRET: "TODO:ReplaceWithLongString"
+
+      STRATEGY_LOCAL: "true"
+
+      POSTGRES_URL: "postgres"
+      POSTGRES_USER: "speckle"
+      POSTGRES_PASSWORD: "speckle"
+      POSTGRES_DB: "speckle"
+      ENABLE_MP: "false"
+
+      LOG_PRETTY: "true"
+
+      FF_NEXT_GEN_FILE_IMPORTER_ENABLED: "true"
+      FF_LARGE_FILE_IMPORTS_ENABLED: "true"
+
+networks:
+  default:
+    name: speckle-server
+
+volumes:
+  postgres-data:
+  redis-data:
+  minio-data:

docker-compose.yml

@@ -1,4 +1,3 @@
-version: "3.9"
 name: "speckle-server"
 
 services:
@@ -13,7 +12,7 @@ services:
       POSTGRES_USER: speckle
       POSTGRES_PASSWORD: speckle
     volumes:
-      - postgres-data:/var/lib/postgresql/data/
+      - ./.volumes/postgres-data:/var/lib/postgresql/data/
     healthcheck:
       # the -U user has to match the POSTGRES_USER value
       test: ["CMD-SHELL", "pg_isready -U speckle"]
@@ -22,10 +21,10 @@ services:
       retries: 30
 
   redis:
-    image: "redis:6.0-alpine"
+    image: "valkey/valkey:8.1-alpine@sha256:0d27f0bca0249f61d060029a6aaf2e16b2c417d68d02a508e1dfb763fa2948b4"
     restart: always
     volumes:
-      - redis-data:/data
+      - ./.volumes/redis-data:/data
     healthcheck:
       test: ["CMD", "redis-cli", "--raw", "incr", "ping"]
       interval: 5s
@@ -37,7 +36,10 @@ services:
     command: server /data --console-address ":9001"
     restart: always
     volumes:
-      - minio-data:/data
+      - ./.volumes/minio-data:/data
+    ports:
+      - '127.0.0.1:9000:9000'
+      - '127.0.0.1:9001:9001'
     healthcheck:
       test:
         [
@@ -57,7 +59,7 @@ services:
         - CMD
         - /nodejs/bin/node
         - -e
-        - "try { require('node:http').request({headers: {'Content-Type': 'application/json'}, port:3000, hostname:'127.0.0.1', path:'/readiness', method: 'GET', timeout: 2000 }, (res) => { body = ''; res.on('data', (chunk) => {body += chunk;}); res.on('end', () => {process.exit(res.statusCode != 200 || body.toLowerCase().includes('error'));}); }).end(); } catch { process.exit(1); }"
+        - "try { require('node:http').request({headers: {'Content-Type': 'application/json'}, port:3000, hostname:'127.0.0.1', path:'/readiness', method: 'GET', timeout: 2000 }, (res) => { body = ''; res.on('data', (chunk) => {body += chunk;}); res.on('end', () => {process.exit(Number(res.statusCode != 200 || body.toLowerCase().includes('error')));}); }).end(); } catch { process.exit(1); }"
       interval: 10s
       timeout: 10s
       retries: 3
@@ -81,6 +83,7 @@ services:
       REDIS_URL: "redis://redis"
 
       S3_ENDPOINT: "http://minio:9000"
+      S3_PUBLIC_ENDPOINT: "http://127.0.0.1:9000"
       S3_ACCESS_KEY: "minioadmin"
       S3_SECRET_KEY: "minioadmin"
       S3_BUCKET: "speckle-server"
@@ -93,7 +96,6 @@ services:
       SESSION_SECRET: "TODO:ReplaceWithLongString"
 
       STRATEGY_LOCAL: "true"
-      DEBUG: "speckle:*"
 
       POSTGRES_URL: "postgres"
       POSTGRES_USER: "speckle"
@@ -101,6 +103,11 @@ services:
       POSTGRES_DB: "speckle"
       ENABLE_MP: "false"
 
+      LOG_PRETTY: "true"
+
+      FF_NEXT_GEN_FILE_IMPORTER_ENABLED: "true"
+      FF_LARGE_FILE_IMPORTS_ENABLED: "true"
+
 networks:
   default:
     name: speckle-server

mise.toml

@@ -0,0 +1,6 @@
+[tools]
+python = "3.13.7"
+
+[settings]
+experimental = true
+python.uv_venv_auto = true

pyproject.toml

@@ -2,7 +2,7 @@
 dynamic = ["version"]
 # version = "3.0.0a1"
 name = "specklepy"
-description = "The Python SDK for Speckle 2.0"
+description = "The Python SDK for Speckle"
 readme = "README.md"
 authors = [{ name = "Speckle Systems", email = "devops@speckle.systems" }]
 license = { text = "Apache-2.0" }
@@ -11,13 +11,20 @@ dependencies = [
     "appdirs>=1.4.4",
     "attrs>=24.3.0",
     "deprecated>=1.2.15",
-    "gql[requests,websockets]>=3.5.0",
+    "gql[requests,websockets]>=3.5.0,<4.0.0",
     "httpx>=0.28.1",
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.6.5",
+    "mkdocstrings>=0.28.1",
+    "mkdocstrings-python>=1.15.0",
     "pydantic>=2.10.5",
     "pydantic-settings>=2.7.1",
     "ujson>=5.10.0",
 ]
 
+[project.optional-dependencies]
+speckleifc = ["ifcopenshell>=0.8.3.post2"]
+
 [dependency-groups]
 dev = [
     "commitizen>=4.1.0",
@@ -48,9 +55,12 @@ build-backend = "hatchling.build"
 source = "vcs"
 
 [tool.hatch.build.targets.wheel]
-only-include = ["src"]
+only-include = ["src", "licenses"]
 sources = ["src"]
 
+[tool.hatch.build.targets.sdist]
+include = ["src", "licenses"]
+
 [tool.hatch.version.raw-options]
 local_scheme = "no-local-version"
 

src/docs/Specklepy_SDK/api/client.md

@@ -0,0 +1 @@
+::: specklepy.api.client.SpeckleClient

src/docs/Specklepy_SDK/objects/Data_Objects/DataObject.md

@@ -0,0 +1 @@
+::: specklepy.objects.data_objects.DataObject

src/docs/Specklepy_SDK/objects/Data_Objects/QgisObject.md

@@ -0,0 +1 @@
+::: specklepy.objects.data_objects.QgisObject

src/docs/Specklepy_SDK/objects/Interfaces/IBlenderObject.md

@@ -0,0 +1 @@
+::: specklepy.objects.interfaces.IBlenderObject

src/docs/Specklepy_SDK/objects/Interfaces/ICurve.md

@@ -0,0 +1 @@
+::: specklepy.objects.interfaces.ICurve

src/docs/Specklepy_SDK/objects/Interfaces/IDataObject.md

@@ -0,0 +1 @@
+::: specklepy.objects.interfaces.IDataObject

src/docs/Specklepy_SDK/objects/Interfaces/IDisplayValue.md

@@ -0,0 +1 @@
+::: specklepy.objects.interfaces.IDisplayValue

src/docs/Specklepy_SDK/objects/Interfaces/IGisObject.md

@@ -0,0 +1 @@
+::: specklepy.objects.interfaces.IBlenderObject

src/docs/Specklepy_SDK/objects/Interfaces/IHasArea.md

@@ -0,0 +1 @@
+::: specklepy.objects.interfaces.IHasArea

src/docs/Specklepy_SDK/objects/Interfaces/IHasUnits.md

@@ -0,0 +1 @@
+::: specklepy.objects.interfaces.IHasUnits

src/docs/Specklepy_SDK/objects/Interfaces/IHasVolume.md

@@ -0,0 +1 @@
+::: specklepy.objects.interfaces.IHasVolume

src/docs/Specklepy_SDK/objects/Interfaces/IProperties.md

@@ -0,0 +1 @@
+::: specklepy.objects.interfaces.IProperties

src/docs/Specklepy_SDK/objects/Other/RenderMaterial.md

@@ -0,0 +1 @@
+::: specklepy.objects.other.RenderMaterial

src/docs/Specklepy_SDK/objects/Primitve/Interval.md

@@ -0,0 +1 @@
+::: specklepy.objects.primitive.Interval

src/docs/Specklepy_SDK/objects/Proxies/ColorProxy.md

@@ -0,0 +1 @@
+::: specklepy.objects.proxies.ColorProxy

src/docs/Specklepy_SDK/objects/Proxies/GroupProxy.md

@@ -0,0 +1 @@
+::: specklepy.objects.proxies.GroupProxy

src/docs/Specklepy_SDK/objects/Proxies/InstanceDefinitionProxy.md

@@ -0,0 +1 @@
+::: specklepy.objects.proxies.InstanceDefinitionProxy

src/docs/Specklepy_SDK/objects/Proxies/InstanceProxy.md

@@ -0,0 +1 @@
+::: specklepy.objects.proxies.InstanceProxy

src/docs/Specklepy_SDK/objects/Proxies/RenderMaterialProxy.md

@@ -0,0 +1 @@
+::: specklepy.objects.proxies.RenderMaterialProxy

src/docs/Specklepy_SDK/objects/base.md

@@ -0,0 +1 @@
+::: specklepy.objects.base.Base

src/docs/Specklepy_SDK/objects/geometry/Arc.md

@@ -0,0 +1 @@
+::: specklepy.objects.geometry.arc.Arc

src/docs/Specklepy_SDK/objects/geometry/Box.md

@@ -0,0 +1 @@
+::: specklepy.objects.geometry.box.Box

src/docs/Specklepy_SDK/objects/geometry/Circle.md

@@ -0,0 +1 @@
+::: specklepy.objects.geometry.circle.Circle

src/docs/Specklepy_SDK/objects/geometry/ControlPoint.md

@@ -0,0 +1 @@
+::: specklepy.objects.geometry.control_point.ControlPoint

src/docs/Specklepy_SDK/objects/geometry/Ellipse.md

@@ -0,0 +1 @@
+::: specklepy.objects.geometry.ellipse.Ellipse

src/docs/Specklepy_SDK/objects/geometry/Line.md

@@ -0,0 +1 @@
+::: specklepy.objects.geometry.line.Line

src/docs/Specklepy_SDK/objects/geometry/Mesh.md

@@ -0,0 +1 @@
+::: specklepy.objects.geometry.mesh.Mesh

src/docs/Specklepy_SDK/objects/geometry/Plane.md

@@ -0,0 +1 @@
+::: specklepy.objects.geometry.plane.Plane

src/docs/Specklepy_SDK/objects/geometry/Point.md

@@ -0,0 +1 @@
+::: specklepy.objects.geometry.point.Point

src/docs/Specklepy_SDK/objects/geometry/Point_Cloud.md

@@ -0,0 +1 @@
+::: specklepy.objects.geometry.point_cloud.PointCloud

src/docs/Specklepy_SDK/objects/geometry/Polycurve.md

@@ -0,0 +1 @@
+::: specklepy.objects.geometry.polycurve.Polycurve

src/docs/Specklepy_SDK/objects/geometry/Polyline.md

@@ -0,0 +1 @@
+::: specklepy.objects.geometry.polyline.Polyline

src/docs/Specklepy_SDK/objects/geometry/Spiral.md

@@ -0,0 +1 @@
+::: specklepy.objects.geometry.spiral.Spiral

src/docs/Specklepy_SDK/objects/geometry/Surface.md

@@ -0,0 +1 @@
+::: specklepy.objects.geometry.surface.Surface

src/docs/Specklepy_SDK/objects/geometry/Vector.md

@@ -0,0 +1 @@
+::: specklepy.objects.geometry.vector.Vector

src/docs/index.md

@@ -0,0 +1,29 @@
+# Introduction
+
+Welcome to the Specklepy Developer Docs - a single source of documentation on everything Specklepy! If you're looking for info on how to use Speckle, check our [user guide](https://speckle.guide/).
+
+### Code Repository
+The Python SDK can be found in our [repository](//github.com/specklesystems/specklepy), its readme contains instructions on how to build it.
+
+### Installation
+You can install it using pip
+```
+pip install specklepy
+```
+
+### Key Components
+
+SpecklePy has three main parts:
+
+1. a `SpeckleClient` which allows you to interact with the server API
+2. `operations` and `transports` for sending and receiving large objects
+3. a `Base` object and accompaniying serializer for creating and customizing your own Speckle objects
+
+
+### Local Data Paths
+
+It may be helpful to know where the local accounts and object cache dbs are stored. Depending on on your OS, you can find the dbs at:
+
+- Windows: `APPDATA` or `<USER>\AppData\Roaming\Speckle`
+- Linux: `$XDG_DATA_HOME` or by default `~/.local/share/Speckle`
+- Mac: `~/.config/Speckle`

src/docs/speckle_automate/automate_context.md

@@ -0,0 +1 @@
+::: speckle_automate.automation_context.AutomationContext

src/mkdocs.yml

@@ -0,0 +1,64 @@
+site_name: Specklepy Docs
+theme:
+  name: material
+  favicon: assets/speckle_logo.png
+  logo: assets/speckle_logo.png
+  features:
+    - navigation.tabs
+  palette:
+    # Palette toggle for light mode
+    - scheme: default
+      primary: white
+      toggle:
+        icon: material/weather-night
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - scheme: slate
+      primary: black
+      logo: assets/logo_white.png
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to light mode
+
+
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+
+extra_css:
+- css/mkdocstrings.css
+
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [.]
+          options:
+            parameter_headings: false
+            members_order: source
+            separate_signature: true
+            filters: ["!^_"] #Ignore _ prefixed properties
+            docstring_options:
+              ignore_init_summary: true
+            merge_init_into_class: true
+            show_signature_annotations: true
+            signature_crossrefs: true
+            show_if_no_docstring: true
+            show_labels: true
+            show_source: true
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
+            show_bases: false
+            heading_level: 3
+
+          inventories:
+            - url: https://docs.python.org/3/objects.inv
+              domains: [py, std]

src/speckle_automate/automation_context.py

@@ -245,30 +245,30 @@ class AutomationContext:
         """
         )
         if self.run_status in [AutomationStatus.SUCCEEDED, AutomationStatus.FAILED]:
-            object_results = {
-                "version": 2,
+            results_dict = self._automation_result.model_dump(by_alias=True)
+            results = {
+                "version": 3,
                 "values": {
-                    "objectResults": self._automation_result.model_dump(by_alias=True)[
-                        "objectResults"
-                    ],
+                    "objectResults": results_dict["objectResults"],
+                    "versionResult": results_dict["versionResult"],
                     "blobIds": self._automation_result.blobs,
                 },
             }
         else:
-            object_results = None
+            results = None
 
         params = {
             "projectId": self.automation_run_data.project_id,
             "functionRunId": self.automation_run_data.function_run_id,
             "status": self.run_status.value,
             "statusMessage": self._automation_result.status_message,
-            "results": object_results,
+            "results": results,
             "contextView": self._automation_result.result_view,
         }
         print(f"Reporting run status with content: {params}")
         self.speckle_client.httpclient.execute(query, params)
 
-    def store_file_result(self, file_path: Union[Path, str]) -> None:
+    def store_file_result(self, file_path: Union[Path, str]) -> str:
         """Save a file attached to the project of this automation."""
         path_obj = (
             Path(file_path).resolve() if isinstance(file_path, str) else file_path
@@ -310,25 +310,51 @@ class AutomationContext:
             [upload_result.blob_id for upload_result in upload_response.upload_results]
         )
 
-    def mark_run_failed(self, status_message: str) -> None:
-        """Mark the current run a failure."""
-        self._mark_run(AutomationStatus.FAILED, status_message)
+        return upload_response.upload_results[0].blob_id
+
+    def mark_run_failed(
+        self, status_message: str, version_result: dict[str, Any] | None = None
+    ) -> None:
+        """
+        Mark the current run a failure.
+
+        Args:
+            status_message: Optional message to be displayed.
+            version_result: Optional data object,
+                that will be attached to the run results.
+                The dictionary should be JSON serializable
+        """
+        self._mark_run(AutomationStatus.FAILED, status_message, version_result)
 
     def mark_run_exception(self, status_message: str) -> None:
         """Mark the current run a failure."""
-        self._mark_run(AutomationStatus.EXCEPTION, status_message)
+        self._mark_run(AutomationStatus.EXCEPTION, status_message, None)
 
-    def mark_run_success(self, status_message: Optional[str]) -> None:
-        """Mark the current run a success with an optional message."""
-        self._mark_run(AutomationStatus.SUCCEEDED, status_message)
+    def mark_run_success(
+        self, status_message: str | None, version_result: dict[str, Any] | None = None
+    ) -> None:
+        """
+        Mark the current run a success with an optional message.
+
+        Args:
+            status_message: Optional message to be displayed.
+            version_result: Optional data object,
+                that will be attached to the run results.
+                The dictionary should be JSON serializable
+        """
+        self._mark_run(AutomationStatus.SUCCEEDED, status_message, version_result)
 
     def _mark_run(
-        self, status: AutomationStatus, status_message: Optional[str]
+        self,
+        status: AutomationStatus,
+        status_message: str | None,
+        version_result: dict[str, Any] | None,
     ) -> None:
         duration = self.elapsed()
         self._automation_result.status_message = status_message
         self._automation_result.run_status = status
         self._automation_result.elapsed = duration
+        self._automation_result.version_result = version_result
 
         msg = f"Automation run {status.value} after {duration:.2f} seconds."
         print("\n".join([msg, status_message]) if status_message else msg)

src/speckle_automate/fixtures.py

@@ -1,8 +1,5 @@
 """Some useful helpers for working with automation data."""
 
-import secrets
-import string
-
 import pytest
 from gql import gql
 from pydantic import Field
@@ -91,10 +88,8 @@ def create_test_automation_run(
 
     print(result)
 
-    return (
-        result.get("projectMutations")
-        .get("automationMutations")
-        .get("createTestAutomationRun")
+    return TestAutomationRunData.model_validate(
+        result["projectMutations"]["automationMutations"]["createTestAutomationRun"]
     )
 
 
@@ -126,9 +121,9 @@ def create_test_automation_run_data(
         project_id=test_automation_environment.project_id,
         speckle_server_url=test_automation_environment.server_url,
         automation_id=test_automation_environment.automation_id,
-        automation_run_id=test_automation_run_data["automationRunId"],
-        function_run_id=test_automation_run_data["functionRunId"],
-        triggers=test_automation_run_data["triggers"],
+        automation_run_id=test_automation_run_data.automation_run_id,
+        function_run_id=test_automation_run_data.function_run_id,
+        triggers=test_automation_run_data.triggers,
     )
 
 
@@ -140,12 +135,6 @@ def test_automation_run_data(
     return create_test_automation_run_data(speckle_client, test_automation_environment)
 
 
-def crypto_random_string(length: int) -> str:
-    """Generate a semi crypto random string of a given length."""
-    alphabet = string.ascii_letters + string.digits
-    return "".join(secrets.choice(alphabet) for _ in range(length)).lower()
-
-
 __all__ = [
     "test_automation_environment",
     "test_automation_token",

src/speckle_automate/schema.py

@@ -1,7 +1,7 @@
 """"""
 
 from enum import Enum
-from typing import Any, Dict, List, Literal, Optional
+from typing import Any, Literal
 
 from pydantic import BaseModel, ConfigDict, Field
 from pydantic.alias_generators import to_camel
@@ -36,7 +36,7 @@ class AutomationRunData(BaseModel):
     automation_run_id: str
     function_run_id: str
 
-    triggers: List[VersionCreationTrigger]
+    triggers: list[VersionCreationTrigger]
 
     model_config = ConfigDict(
         alias_generator=to_camel, populate_by_name=True, protected_namespaces=()
@@ -49,7 +49,7 @@ class TestAutomationRunData(BaseModel):
     automation_run_id: str
     function_run_id: str
 
-    triggers: List[VersionCreationTrigger]
+    triggers: list[VersionCreationTrigger]
 
     model_config = ConfigDict(
         alias_generator=to_camel, populate_by_name=True, protected_namespaces=()
@@ -80,19 +80,20 @@ class ResultCase(AutomateBase):
 
     category: str
     level: ObjectResultLevel
-    object_app_ids: Dict[str, Optional[str]]
-    message: Optional[str]
-    metadata: Optional[Dict[str, Any]]
-    visual_overrides: Optional[Dict[str, Any]]
+    object_app_ids: dict[str, str | None]
+    message: str | None
+    metadata: dict[str, Any] | None
+    visual_overrides: dict[str, Any] | None
 
 
 class AutomationResult(AutomateBase):
     """Schema accepted by the Speckle server as a result for an automation run."""
 
     elapsed: float = 0
-    result_view: Optional[str] = None
-    result_versions: List[str] = Field(default_factory=list)
-    blobs: List[str] = Field(default_factory=list)
+    result_view: str | None = None
+    result_versions: list[str] = Field(default_factory=list)
+    blobs: list[str] = Field(default_factory=list)
     run_status: AutomationStatus = AutomationStatus.RUNNING
-    status_message: Optional[str] = None
+    status_message: str | None = None
     object_results: list[ResultCase] = Field(default_factory=list)
+    version_result: dict[str, Any] | None = None

src/speckleifc/__main__.py

@@ -0,0 +1,61 @@
+import json
+import time
+import traceback
+from argparse import ArgumentParser
+from os import getenv
+
+from speckleifc.main import open_and_convert_file
+from specklepy.core.api.client import SpeckleClient
+from specklepy.logging import metrics
+
+
+def cmd_line_import() -> None:
+    parser = ArgumentParser(
+        prog="speckleifc",
+        description="imports a file",
+    )
+    parser.add_argument("file_path")
+    parser.add_argument("output_path")
+    parser.add_argument("project_id")
+    parser.add_argument("version_message")
+    parser.add_argument("model_id")
+    # parser.add_argument("model_name")
+    # parser.add_argument("region_name")
+
+    args = parser.parse_args()
+
+    TOKEN = getenv("USER_TOKEN")
+    assert TOKEN is not None
+    SERVER_URL = getenv("SPECKLE_SERVER_URL") or "http://127.0.0.1:3000"
+
+    metrics.set_host_app(
+        "ifc",
+    )
+
+    try:
+        client = SpeckleClient(SERVER_URL, use_ssl=not SERVER_URL.startswith("http://"))
+        client.authenticate_with_token(TOKEN)
+        project = client.project.get(args.project_id)
+
+        version = open_and_convert_file(
+            args.file_path,
+            project,
+            args.version_message,
+            args.model_id,
+            client,
+        )
+        with open(args.output_path, "w") as f:
+            json.dump({"success": True, "commitId": version.id}, f)
+    except Exception as e:
+        error_msg = f"IFC Importer failed with exception:\n{traceback.format_exc()}"
+        print(error_msg)
+
+        # Write error result
+        with open(args.output_path, "w") as f:
+            json.dump({"success": False, "error": str(e)}, f)
+
+
+if __name__ == "__main__":
+    start = time.time()
+    cmd_line_import()
+    print(f"Total time (including cleanup): {(time.time() - start) * 1000}ms")

src/speckleifc/converter/data_object_converter.py

@@ -0,0 +1,35 @@
+from typing import cast
+
+from ifcopenshell.entity_instance import entity_instance
+
+from speckleifc.property_extraction import extract_properties
+from specklepy.objects.base import Base
+from specklepy.objects.data_objects import DataObject
+
+
+def data_object_to_speckle(
+    display_value: list[Base],
+    step_element: entity_instance,
+    children: list[Base],
+    current_storey: str | None = None,
+) -> DataObject:
+    guid = cast(str, step_element.GlobalId)
+    name = cast(str, step_element.Name or guid)
+
+    properties = extract_properties(step_element)
+
+    # Add building storey information if available and not a building storey itself
+    if current_storey and not step_element.is_a("IfcBuildingStorey"):
+        properties["Building Storey"] = current_storey
+
+    data_object = DataObject(
+        applicationId=guid,
+        properties=properties,
+        name=name or guid,
+        displayValue=display_value,
+    )
+
+    data_object["@elements"] = children
+    data_object["ifcType"] = step_element.is_a()
+
+    return data_object

src/speckleifc/converter/geometry_converter.py

@@ -0,0 +1,130 @@
+from collections import defaultdict
+from collections.abc import Sequence
+from typing import cast
+
+from ifcopenshell.ifcopenshell_wrapper import (
+    Triangulation,
+    colour,
+    style,
+)
+
+from speckleifc.proxy_managers.render_material_proxy_manager import (
+    RenderMaterialProxyManager,
+)
+from specklepy.objects.base import Base
+from specklepy.objects.geometry import Mesh
+from specklepy.objects.other import RenderMaterial
+
+
+def geometry_to_speckle(
+    geometry: Triangulation, render_material_manager: RenderMaterialProxyManager
+) -> list[Base]:
+    materials = cast(Sequence[style], geometry.materials)
+    MESH_COUNT = max(len(materials), 1)
+
+    material_ids = cast(Sequence[int], geometry.material_ids)
+    faces = cast(Sequence[int], geometry.faces)
+    verts = cast(Sequence[float], geometry.verts)
+    normals = cast(Sequence[float], geometry.normals)
+
+    FACE_COUNT = len(material_ids)
+
+    if len(faces) != FACE_COUNT * 3 or FACE_COUNT == 0:
+        # Not really expected, but occasionally some meshes fail to triangulate
+        return []
+
+    mapped_meshes = _pre_alloc_mesh_lists(geometry, material_ids, MESH_COUNT)
+    for i, mesh in enumerate(mapped_meshes):
+        material = _material_to_speckle(materials[i])
+        render_material_manager.add_mesh_material_mapping(material, mesh)
+
+    mapped_faces_pointers = [0] * MESH_COUNT
+    mapped_vertices_pointers = [0] * MESH_COUNT
+    mapped_index_counters = [0] * MESH_COUNT
+
+    i = 0
+    face_index = 0
+    while i < FACE_COUNT:
+        mesh_index = material_ids[i]
+        mesh: Mesh = mapped_meshes[mesh_index]
+
+        face_ptr = mapped_faces_pointers[mesh_index]
+        vert_ptr = mapped_vertices_pointers[mesh_index]
+
+        # Add triangle
+        mesh.faces[face_ptr] = 3
+        for j in range(3):
+            # Add vert
+            mesh.faces[face_ptr + 1 + j] = mapped_index_counters[mesh_index] + j
+            vert_index = faces[face_index + j] * 3
+            mapped_vert_offset = vert_ptr + (j * 3)
+
+            mesh.vertices[mapped_vert_offset] = verts[vert_index]
+            mesh.vertices[mapped_vert_offset + 1] = verts[vert_index + 1]
+            mesh.vertices[mapped_vert_offset + 2] = verts[vert_index + 2]
+
+            mesh.vertexNormals[mapped_vert_offset] = normals[vert_index]
+            mesh.vertexNormals[mapped_vert_offset + 1] = normals[vert_index + 1]
+            mesh.vertexNormals[mapped_vert_offset + 2] = normals[vert_index + 2]
+
+        i += 1
+        face_index += 3  # number of items in the faces list we just jumped over
+
+        mapped_index_counters[mesh_index] += (
+            3  # number of verts we just added to the mesh.vertices i.e. the next index
+        )
+        mapped_faces_pointers[mesh_index] += (
+            4  # number of item's we've just added to the mesh.faces list
+        )
+        mapped_vertices_pointers[mesh_index] += (
+            9  # number of item's we've just added to the mesh.vertices list
+        )
+
+    return mapped_meshes  # type: ignore
+
+
+def _material_to_speckle(material: style) -> RenderMaterial:
+    return RenderMaterial(
+        applicationId=material.calc_hash(),
+        name=material.name,
+        diffuse=_color_to_argb(material.diffuse),
+        opacity=1 - material.transparency if material.has_transparency() else 1,
+    )
+
+
+def _color_to_argb(colour: colour) -> int:
+    # Clamp values to [0, 1] and convert to 0–255
+    a_int = 255
+    r_int = max(0, min(255, int(round(colour.r() * 255))))
+    g_int = max(0, min(255, int(round(colour.g() * 255))))
+    b_int = max(0, min(255, int(round(colour.b() * 255))))
+
+    return (a_int << 24) | (r_int << 16) | (g_int << 8) | b_int
+
+
+def _pre_alloc_mesh_lists(
+    geometry: Triangulation, material_ids: Sequence[int], MESH_COUNT: int
+) -> list[Mesh]:
+    """
+    This is a performance optimisation to pre-size the lists
+    since we're expecting potential hundreds of thousands of verts in a single model
+    This is very much in the hot path, so worth the extra bit of convoluted logic
+    """
+    appId = cast(str, geometry.id)
+
+    material_face_counts = defaultdict(int)
+    for mat_id in material_ids:
+        material_face_counts[mat_id] += 1
+
+    meshes = []
+    for mat_id in range(MESH_COUNT):
+        face_count = material_face_counts.get(mat_id, 0)
+        mesh = Mesh(
+            units="m",
+            vertices=[-1] * (face_count * 9),
+            vertexNormals=[-1] * (face_count * 9),
+            faces=[-1] * (face_count * 4),  # 1 marker + 3 vertex indices
+            applicationId=f"{appId}_mat{mat_id}",
+        )
+        meshes.append(mesh)
+    return meshes

src/speckleifc/converter/project_converter.py

@@ -0,0 +1,23 @@
+from typing import cast
+
+from ifcopenshell.entity_instance import entity_instance
+
+from specklepy.objects.base import Base
+from specklepy.objects.models.collections.collection import Collection
+
+
+def project_to_speckle(
+    step_element: entity_instance, children: list[Base]
+) -> Collection:
+    guid = cast(str, step_element.GlobalId)
+    name = cast(str, step_element.Name or step_element.LongName or guid)
+
+    project = Collection(applicationId=guid, name=name, elements=children)
+
+    project["ifcType"] = step_element.is_a()
+    project["description"] = step_element.Description
+    project["objectType"] = step_element.ObjectType
+    project["longName"] = step_element.LongName
+    project["phase"] = step_element.Phase
+
+    return project

src/speckleifc/converter/spatial_element_converter.py

@@ -0,0 +1,54 @@
+from typing import cast
+
+from ifcopenshell.entity_instance import entity_instance
+
+from speckleifc.property_extraction import extract_properties
+from specklepy.objects.base import Base
+from specklepy.objects.data_objects import DataObject
+from specklepy.objects.models.collections.collection import Collection
+
+
+def spatial_element_to_speckle(
+    display_value: list[Base],
+    step_element: entity_instance,
+    relational_children: list[Base],
+    current_storey: str | None = None,
+) -> Collection:
+    direct_geometry = _convert_as_data_object(
+        display_value, step_element, current_storey
+    )
+    all_children = [direct_geometry] + relational_children
+
+    guid = cast(str, step_element.GlobalId)
+    name = cast(str, step_element.Name or step_element.LongName or guid)
+
+    data_object = Collection(applicationId=guid, name=name, elements=all_children)
+    data_object["ifcType"] = step_element.is_a()
+
+    return data_object
+
+
+def _convert_as_data_object(
+    display_value: list[Base],
+    step_element: entity_instance,
+    current_storey: str | None = None,
+) -> DataObject:
+    guid = cast(str, step_element.GlobalId)
+    name = cast(str, step_element.Name or step_element.LongName or guid)
+
+    properties = extract_properties(step_element)
+
+    # Add building storey information if available and not a building storey itself
+    if current_storey and not step_element.is_a("IfcBuildingStorey"):
+        properties["Building Storey"] = current_storey
+
+    data_object = DataObject(
+        applicationId=guid,
+        properties=properties,
+        name=name,
+        displayValue=display_value,
+    )
+
+    data_object["ifcType"] = step_element.is_a()
+
+    return data_object

src/speckleifc/ifc_geometry_processing.py

@@ -0,0 +1,54 @@
+import multiprocessing
+
+from ifcopenshell import SchemaError, file, ifcopenshell_wrapper, open, sqlite
+from ifcopenshell.geom import iterator, settings
+
+from specklepy.logging.exceptions import SpeckleException
+
+
+def _create_iterator_settings() -> settings:
+    ifc_settings = settings()
+    # triangles for now, speckle does support n-gons, but may be less performant
+    ifc_settings.set("triangulation-type", ifcopenshell_wrapper.TRIANGLE_MESH)
+    # no need to weld verts
+    ifc_settings.set("weld-vertices", False)
+    #
+    ifc_settings.set("use-world-coords", False)
+    ifc_settings.set("permissive-shape-reuse", True)
+
+    # Tiny performance improvement,
+    ifc_settings.set("no-wire-intersection-check", True)
+    # Rendermaterials inherit the material names instead of type + unique id
+    ifc_settings.set("use-material-names", True)
+
+    # IfcOpenshell defaults to 0.001mm here, which leads to very dense meshes.
+    # lowering the mesh quality a bit here leads to meshes
+    # that are still much higher quality than webifc
+
+    # We still need to experiment with the affect on memory usage
+    # It may be desirable to lower this further, and increase the angular deflection
+    # to compensate. This would allow large meshes to be lower quality,
+    # while keeping small meshes relatively similar.
+    ifc_settings.set("mesher-linear-deflection", 0.2)
+
+    return ifc_settings
+
+
+def open_ifc(file_path: str) -> file:
+    try:
+        ifc_file = open(file_path)
+    except SchemaError:
+        raise
+    except FileNotFoundError:
+        raise
+    except Exception as ex:
+        raise SpeckleException("File could not be opened as an IFC file") from ex
+
+    if isinstance(ifc_file, file):
+        return ifc_file
+    else:
+        raise SpeckleException(f"file at {file_path} is not a compatible ifc file type")
+
+
+def create_geometry_iterator(ifc_file: file | sqlite) -> iterator:
+    return iterator(_create_iterator_settings(), ifc_file, multiprocessing.cpu_count())

src/speckleifc/ifc_openshell_helpers.py

@@ -0,0 +1,31 @@
+from collections.abc import Generator, Iterable
+from itertools import chain
+from typing import cast
+
+from ifcopenshell.entity_instance import entity_instance
+
+
+def get_children(step_element: entity_instance) -> Generator[entity_instance]:
+    yield from chain(
+        get_spatial_children(step_element), get_aggregate_children(step_element)
+    )
+
+
+def get_spatial_children(step_element: entity_instance) -> Generator[entity_instance]:
+    spatial_relations = cast(
+        Iterable[entity_instance] | None,
+        getattr(step_element, "ContainsElements", None),
+    )
+    if spatial_relations is not None:
+        for relation in spatial_relations:
+            yield from cast(Iterable[entity_instance], relation.RelatedElements)
+
+
+def get_aggregate_children(step_element: entity_instance) -> Generator[entity_instance]:
+    aggregate_relations = cast(
+        Iterable[entity_instance] | None,
+        getattr(step_element, "IsDecomposedBy", None),
+    )
+    if aggregate_relations is not None:
+        for relation in aggregate_relations:
+            yield from cast(Iterable[entity_instance], relation.RelatedObjects)

src/speckleifc/importer.py

@@ -0,0 +1,207 @@
+import time
+from dataclasses import dataclass, field
+from typing import List, cast
+
+from ifcopenshell.entity_instance import entity_instance
+from ifcopenshell.geom import file
+from ifcopenshell.ifcopenshell_wrapper import Triangulation, TriangulationElement
+
+from speckleifc.converter.data_object_converter import data_object_to_speckle
+from speckleifc.converter.geometry_converter import geometry_to_speckle
+from speckleifc.converter.project_converter import project_to_speckle
+from speckleifc.converter.spatial_element_converter import spatial_element_to_speckle
+from speckleifc.ifc_geometry_processing import create_geometry_iterator
+from speckleifc.ifc_openshell_helpers import get_children
+from speckleifc.proxy_managers.instance_proxy_manager import InstanceProxyManager
+from speckleifc.proxy_managers.level_proxy_manager import LevelProxyManager
+from speckleifc.proxy_managers.render_material_proxy_manager import (
+    RenderMaterialProxyManager,
+)
+from specklepy.logging.exceptions import SpeckleException
+from specklepy.objects import Base
+from specklepy.objects.data_objects import DataObject
+from specklepy.objects.models.collections.collection import Collection
+from specklepy.objects.proxies import InstanceProxy
+
+
+@dataclass
+class ImportJob:
+    ifc_file: file
+
+    _render_material_manager: RenderMaterialProxyManager = field(
+        default_factory=lambda: RenderMaterialProxyManager()
+    )
+    _level_proxy_manager: LevelProxyManager = field(
+        default_factory=lambda: LevelProxyManager()
+    )
+    _instance_proxy_manager: InstanceProxyManager = field(
+        default_factory=lambda: InstanceProxyManager()
+    )
+    geometries_count: int = 0
+    geometries_used: int = 0
+    _current_storey_data_object: DataObject | None = field(default=None, init=False)
+
+    _display_value_cache: dict[int, list[Base]] = field(default_factory=dict)
+    """Maps an instance step ID to a list of instances"""
+
+    def convert_element(self, step_element: entity_instance) -> Base:
+        try:
+            return self._convert_element(step_element)
+        except SpeckleException:
+            raise
+        except Exception as ex:
+            raise SpeckleException(
+                f"Failed to convert {step_element.is_a()} #{step_element.id()}"
+            ) from ex
+
+    def _convert_element(self, step_element: entity_instance) -> Base:
+        # Track current storey context and store for level proxies
+        previous_storey_data_object = self._current_storey_data_object
+        if step_element.is_a("IfcBuildingStorey"):
+            # Convert the building storey to a DataObject for the level proxy
+            storey_display_value = self._display_value_cache.get(step_element.id(), [])
+            self._current_storey_data_object = data_object_to_speckle(
+                storey_display_value, step_element, []
+            )
+
+        children = self._convert_children(step_element)
+        id = step_element.id()
+        display_value = self._display_value_cache.get(id, [])
+
+        if display_value:
+            self.geometries_used += 1
+
+        # Extract current storey name from DataObject if available
+        current_storey_name = (
+            self._current_storey_data_object.name
+            if self._current_storey_data_object
+            else None
+        )
+
+        if step_element.is_a("IfcProject"):
+            result = project_to_speckle(step_element, children)
+        elif step_element.is_a("IfcSpatialStructureElement"):
+            result = spatial_element_to_speckle(
+                display_value, step_element, children, current_storey_name
+            )
+        else:
+            result = data_object_to_speckle(
+                display_value, step_element, children, current_storey_name
+            )
+            # Associate non-spatial elements with current storey for level proxies
+            if self._current_storey_data_object is not None and result.applicationId:
+                self._level_proxy_manager.add_element_level_mapping(
+                    self._current_storey_data_object, result.applicationId
+                )
+
+        # Restore previous storey context
+        self._current_storey_data_object = previous_storey_data_object
+        return result
+
+    def _convert_children(self, step_element: entity_instance) -> list[Base]:
+        return [
+            self.convert_element(i)
+            for i in get_children(step_element)
+            if self._should_convert(i)
+        ]
+
+    @staticmethod
+    def _should_convert(step_element: entity_instance) -> bool:
+        # We only consider IfcRoot objects convertible
+        # This is the super class for root level entities that have a GUID...
+        # This will ignore some types like IfcGridAxis
+        s = step_element.is_a("IfcRoot")
+        if not s:
+            print(
+                f"Skipping #{step_element.id()} because it's type ({step_element.is_a()}) it not an IfcRoot"  # noqa: E501
+            )
+        return s
+
+    def convert(self) -> Base:
+        start = time.time()
+        self.pre_process_geometry()
+        print(f"Geometry conversion complete after {(time.time() - start) * 1000}ms")
+        print(f"Created {self.geometries_count} geometries")
+
+        start = time.time()
+        root = self._convert_project_tree()
+        print(f"Object tree conversion complete after {(time.time() - start) * 1000}ms")
+        print(f"Used {self.geometries_used} geometries")
+        return root
+
+    def pre_process_geometry(self) -> None:
+        iterator = create_geometry_iterator(self.ifc_file)
+        if not iterator.initialize():
+            raise SpeckleException("Failed to find any geometry in file")
+        self.geometries_count = 0
+        while True:
+            shape = cast(TriangulationElement, iterator.get())
+            self.geometries_count += 1
+            id = cast(int, shape.id)
+            try:
+                display_value = self._create_display_value(shape)
+                self._display_value_cache[id] = display_value
+            except Exception as ex:
+                raise SpeckleException(
+                    f"Failed to convert geometry with id: {id}"
+                ) from ex
+            if not iterator.next():
+                break
+
+    def _create_display_value(self, shape: TriangulationElement) -> List[Base]:
+        geometry = cast(Triangulation, shape.geometry)
+        display_value_geometry = geometry_to_speckle(
+            geometry, self._render_material_manager
+        )
+
+        definition_ids = self._instance_proxy_manager.add_display_value_definitions(
+            display_value_geometry
+        )
+        matrix = shape.transformation.matrix
+        transposed = [
+            matrix[0], matrix[4], matrix[8], matrix[12],
+            matrix[1], matrix[5], matrix[9], matrix[13],
+            matrix[2], matrix[6], matrix[10], matrix[14],
+            matrix[3], matrix[7], matrix[11], matrix[15],
+        ]  # fmt: skip
+
+        return [
+            cast(
+                Base,
+                InstanceProxy(
+                    units="m",
+                    definitionId=definition_id,
+                    transform=transposed,
+                    maxDepth=0,
+                    applicationId=f"{shape.guid}:{definition_id}",
+                ),
+            )
+            for definition_id in definition_ids
+        ]
+
+    def _convert_project_tree(self) -> Base:
+        projects = self.ifc_file.by_type("IfcProject", False)
+        if len(projects) != 1:
+            raise SpeckleException("Expected exactly one IfcProject in file")
+        project = projects[0]
+
+        tree = self.convert_element(project)
+        if not isinstance(tree, Collection):
+            raise TypeError("Expected root object to convert to a Collection")
+
+        tree["renderMaterialProxies"] = list(
+            self._render_material_manager.render_material_proxies.values()
+        )
+        tree["levelProxies"] = list(self._level_proxy_manager.level_proxies.values())
+        tree["instanceDefinitionProxies"] = list(
+            self._instance_proxy_manager.instance_definition_proxies.values()
+        )
+        tree.elements.append(
+            Collection(
+                name="definitionGeometry",
+                elements=list(self._instance_proxy_manager.instance_geometry.values()),
+            )
+        )
+        tree["version"] = 3
+
+        return tree

src/speckleifc/licenses/IfcOpenShell-GPL-3.0.txt

@@ -0,0 +1,621 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS

src/speckleifc/licenses/IfcOpenShell-LGPL-3.0.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

src/speckleifc/licenses/README.md

@@ -0,0 +1,30 @@
+# Third-Party Licenses
+
+This directory contains license files for third-party dependencies used by specklepy.
+
+## IfcOpenShell
+
+IfcOpenShell is an optional dependency available through the `speckleifc` extra:
+
+```bash
+pip install specklepy[speckleifc]
+```
+
+IfcOpenShell is dual-licensed under:
+
+- **LGPL-3.0** (`IfcOpenShell-LGPL-3.0.txt`) - GNU Lesser General Public License v3.0
+- **GPL-3.0** (`IfcOpenShell-GPL-3.0.txt`) - GNU General Public License v3.0
+
+### About IfcOpenShell
+
+IfcOpenShell is an open source software library for working with Industry Foundation Classes (IFC). It provides complete parsing support for IFC2x3 TC1, IFC4 Add2 TC1, IFC4x1, IFC4x2, and IFC4x3 Add2.
+
+- **Project**: https://github.com/IfcOpenShell/IfcOpenShell
+- **Documentation**: https://docs.ifcopenshell.org/
+- **License**: LGPL-3.0-or-later, GPL-3.0-or-later
+
+When using specklepy with IfcOpenShell, you must comply with the terms of these licenses.
+
+## License Compatibility
+
+specklepy is licensed under Apache-2.0, which is compatible with LGPL-3.0 for dynamic linking scenarios (which is how IfcOpenShell is used as an optional dependency).

src/speckleifc/main.py

@@ -0,0 +1,61 @@
+import time
+
+from speckleifc.ifc_geometry_processing import open_ifc
+from speckleifc.importer import ImportJob
+from specklepy.core.api.client import SpeckleClient
+from specklepy.core.api.inputs.version_inputs import CreateVersionInput
+from specklepy.core.api.models.current import Project, Version
+from specklepy.core.api.operations import send
+from specklepy.logging import metrics
+from specklepy.transports.server import ServerTransport
+
+
+def open_and_convert_file(
+    file_path: str,
+    project: Project,
+    version_message: str | None,
+    model_id: str,
+    client: SpeckleClient,
+) -> Version:
+    start = time.time()
+    very_start = start
+
+    account = client.account
+    server_url = account.serverInfo.url
+    assert server_url
+    remote_transport = ServerTransport(project.id, account=account)
+
+    ifc_file = open_ifc(file_path)  # pyright: ignore[reportUnknownVariableType]
+
+    import_job = ImportJob(ifc_file)  # pyright: ignore[reportUnknownArgumentType]
+    data = import_job.convert()
+
+    print(f"File conversion complete after {(time.time() - start) * 1000}ms")
+
+    start = time.time()
+
+    root_id = send(data, transports=[remote_transport], use_default_cache=False)
+    print(f"Sending to speckle complete after: {(time.time() - start) * 1000}ms")
+
+    start = time.time()
+
+    create_version = CreateVersionInput(
+        object_id=root_id,
+        model_id=model_id,
+        project_id=project.id,
+        message=version_message,
+        source_application="ifc",
+    )
+    version = client.version.create(create_version)
+    end = time.time()
+    print(f"Version committed after: {(end - start) * 1000}ms")
+
+    print(f"Total time (to commit): {(end - very_start) * 1000}ms")
+    del ifc_file
+
+    custom_properties = {"ui": "dui3", "actionSource": "import"}
+    if project.workspace_id:
+        custom_properties["workspace_id"] = project.workspace_id
+    metrics.track(metrics.SEND, account, custom_properties, send_sync=True)
+
+    return version

src/speckleifc/property_extraction.py

@@ -0,0 +1,197 @@
+import math
+from typing import Any, Tuple
+
+from ifcopenshell.entity_instance import entity_instance
+from ifcopenshell.util.element import get_type
+from ifcopenshell.util.unit import get_full_unit_name, get_project_unit
+
+UNIT_MAPPING = {
+    "IfcQuantityLength": "LENGTHUNIT",
+    "IfcQuantityArea": "AREAUNIT",
+    "IfcQuantityVolume": "VOLUMEUNIT",
+    "IfcQuantityCount": None,  # Count quantities have no units
+    "IfcQuantityWeight": "MASSUNIT",
+    "IfcQuantityTime": "TIMEUNIT",
+}
+
+
+def extract_properties(element: entity_instance) -> dict[str, object]:
+    (psets, qtos) = _get_ifc_object_properties(element)
+
+    properties: dict[str, object] = {
+        "Attributes": _get_attributes(element),
+        "Property Sets": psets,
+    }
+
+    if qtos:
+        properties["Quantities"] = qtos
+
+    if (ifc_type := get_type(element)) is not None:
+        properties["Element Type Property Sets"] = _get_ifc_element_type_properties(
+            ifc_type,
+        )
+        properties["Element Type Attributes"] = _get_attributes(
+            ifc_type,
+        )
+
+    return properties
+
+
+def _get_attributes(element: entity_instance) -> dict[str, object]:
+    return element.get_info(True, False, scalar_only=True)
+
+
+def _get_ifc_element_type_properties(element: entity_instance) -> dict[str, object]:
+    result: dict[str, object] = {}
+    for definition in element.HasPropertySets or []:
+        if not definition.is_a("IfcPropertySet"):
+            continue
+
+        result[definition.Name] = _get_properties(definition.HasProperties)
+    return result
+
+
+def _get_ifc_object_properties(
+    element: entity_instance,
+) -> Tuple[dict[str, object], dict[str, object]]:
+    psets: dict[str, object] = {}
+    qtos: dict[str, object] = {}
+
+    for rel in getattr(element, "IsDefinedBy", []):
+        if not rel.is_a("IfcRelDefinesByProperties"):
+            continue
+
+        definition: entity_instance | None = rel.RelatingPropertyDefinition
+        if not definition:
+            continue
+
+        try:
+            if definition.is_a("IfcPropertySet"):
+                set_name = definition.Name
+                properties = _get_properties(definition.HasProperties)
+
+                if properties:
+                    psets[set_name] = properties
+
+            elif definition.is_a("IfcElementQuantity"):
+                quantities_data = _get_quantities(definition.Quantities, element)
+                if not quantities_data:
+                    continue
+                quantities_data["id"] = definition.id()
+                qtos[definition.Name] = quantities_data
+
+        except (KeyError, AttributeError):
+            # If entity access fails, skip this quantity set
+            print(f"Skipping {definition}")
+            continue
+
+    return (psets, qtos)
+
+
+def _get_properties(properties: entity_instance) -> dict[str, Any]:
+    """
+    There already exists a canonical way to get properties
+    `ifcopenshell.util.element.get_properties` but it's very verbose
+    and we don't want to bloat our selves with supporting complex property types
+
+    This is a slimmed down version, only supporting a couple of property types
+    """
+    result: dict[str, Any] = {}
+
+    for prop in properties:
+        name = prop.Name
+        if prop.is_a("IfcPropertySingleValue"):
+            val = prop.NominalValue
+            if val is not None:
+                result[name] = val.wrappedValue if hasattr(val, "wrappedValue") else val
+        elif prop.is_a("IfcPropertyListValue"):
+            values = getattr(prop, "ListValues", None)
+            if values:
+                result[name] = [
+                    v.wrappedValue if hasattr(v, "wrappedValue") else v for v in values
+                ]
+        elif prop.is_a("IfcPropertyEnumeratedValue"):
+            values = getattr(prop, "EnumerationValues", None)
+            if values:
+                result[name] = [
+                    v.wrappedValue if hasattr(v, "wrappedValue") else v for v in values
+                ]
+
+        # elif prop.is_a("IfcPropertyTableValue"):
+        #     properties[name] = #not sure if we want to support these...
+    return result
+
+
+def _get_quantities(
+    quantities: list[entity_instance], element: entity_instance
+) -> dict[str, Any]:
+    """Extract quantity values from IfcPhysicalQuantity entities."""
+    results: dict[str, Any] = {}
+    for quantity in quantities or []:
+        quantity_name = quantity.Name
+
+        if quantity.is_a("IfcPhysicalSimpleQuantity"):
+            # Get the quantity value (3rd attribute for simple quantities)
+            value = getattr(quantity, quantity.attribute_name(3))
+            unit_info = _get_unit_info(element, quantity)
+
+            # Server does not consider `NaN` valid json
+            if math.isnan(value):
+                value = None
+
+            if unit_info:
+                # Create structured quantity object with units
+                results[quantity_name] = {
+                    "name": quantity_name,
+                    "value": value,
+                    **unit_info,
+                }
+            else:
+                # No unit info available, keep as simple value with name
+                results[quantity_name] = {"name": quantity_name, "value": value}
+
+        elif quantity.is_a("IfcPhysicalComplexQuantity"):
+            # Handle complex quantities
+            data = {
+                k: v
+                for k, v in quantity.get_info().items()
+                if v is not None and k != "Name"
+            }
+            data["properties"] = _get_quantities(quantity.HasQuantities, element)
+            del data["HasQuantities"]
+            results[quantity_name] = data
+    return results
+
+
+def _get_unit_info(
+    element: entity_instance, quantity: entity_instance
+) -> dict[str, str]:
+    """Get unit information for a quantity."""
+    # Early return for count quantities - they don't have units
+    quantity_type = quantity.is_a()
+    if quantity_type == "IfcQuantityCount":
+        return {}
+
+    unit = getattr(element, "Unit", None)
+    if unit:
+        # Quantity has its own unit
+        unit_name = get_full_unit_name(unit)
+        formatted_unit_name = unit_name.replace("_", " ").title() if unit_name else ""
+        return {"units": formatted_unit_name}
+
+    else:
+        # Fall back to project unit based on quantity type
+        unit_type = UNIT_MAPPING.get(quantity_type)
+        if not unit_type:
+            return {}
+
+        # Get the project unit for this unit type
+        project_unit = get_project_unit(element.file, unit_type, use_cache=True)
+        if not project_unit:
+            return {}
+
+        # Get unit name and format
+        unit_name = get_full_unit_name(project_unit)
+        formatted_unit_name = unit_name.replace("_", " ").title() if unit_name else ""
+
+        return {"units": formatted_unit_name}

src/speckleifc/proxy_managers/instance_proxy_manager.py

@@ -0,0 +1,43 @@
+from typing import Sequence
+
+from specklepy.objects.base import Base
+from specklepy.objects.proxies import InstanceDefinitionProxy
+
+
+class InstanceProxyManager:
+    def __init__(self):
+        self._instance_definition_proxies: dict[str, InstanceDefinitionProxy] = {}
+        """definition proxies to be added directly to the root"""
+        self._instance_geometry: dict[str, Base] = {}
+        """The geometry that will be added in it's own collection under the root"""
+
+    @property
+    def instance_definition_proxies(self) -> dict[str, InstanceDefinitionProxy]:
+        return self._instance_definition_proxies
+
+    @property
+    def instance_geometry(self) -> dict[str, Base]:
+        return self._instance_geometry
+
+    def add_display_value_definitions(self, geometry: Sequence[Base]) -> list[str]:
+        result: list[str] = []
+        for m in geometry:
+            if not m.applicationId:
+                raise ValueError("geometry with no applicationId cannot be proxied ")
+            definition_id = f"DEFINITION:{m.applicationId}"
+            result.append(definition_id)
+            self._add_definition(definition_id, [m.applicationId], 0)
+            self._instance_geometry[m.applicationId] = m
+
+        return result
+
+    def _add_definition(
+        self, definition_id: str, objects: list[str], max_depth: int
+    ) -> None:
+        proxy = InstanceDefinitionProxy(
+            applicationId=definition_id,
+            name=definition_id,
+            objects=objects,
+            maxDepth=max_depth,
+        )
+        self._instance_definition_proxies[definition_id] = proxy

src/speckleifc/proxy_managers/level_proxy_manager.py

@@ -0,0 +1,27 @@
+from specklepy.objects.data_objects import DataObject
+from specklepy.objects.proxies import LevelProxy
+
+
+class LevelProxyManager:
+    def __init__(self):
+        self._level_proxies: dict[str, LevelProxy] = {}
+
+    @property
+    def level_proxies(self):
+        return self._level_proxies
+
+    def add_element_level_mapping(
+        self, level_data_object: DataObject, element_application_id: str
+    ) -> None:
+        level_id = level_data_object.applicationId
+        assert level_id is not None
+
+        proxy = self._level_proxies.get(level_id, None)
+        if proxy is not None:
+            proxy.objects.append(element_application_id)
+        else:
+            self._level_proxies[level_id] = LevelProxy(
+                objects=[element_application_id],
+                value=level_data_object,
+                applicationId=level_id,
+            )

src/speckleifc/proxy_managers/render_material_proxy_manager.py

@@ -0,0 +1,28 @@
+from specklepy.objects.geometry import Mesh
+from specklepy.objects.other import RenderMaterial
+from specklepy.objects.proxies import RenderMaterialProxy
+
+
+class RenderMaterialProxyManager:
+    def __init__(self):
+        self._render_material_proxies: dict[str, RenderMaterialProxy] = {}
+
+    @property
+    def render_material_proxies(self):
+        return self._render_material_proxies
+
+    def add_mesh_material_mapping(
+        self, render_material: RenderMaterial, mesh: Mesh
+    ) -> None:
+        material_id = render_material.applicationId
+        assert material_id is not None
+        mesh_id = mesh.applicationId
+        assert mesh_id is not None
+
+        proxy = self._render_material_proxies.get(material_id, None)
+        if proxy is not None:
+            proxy.objects.append(mesh_id)
+        else:
+            self._render_material_proxies[material_id] = RenderMaterialProxy(
+                objects=[mesh_id], value=render_material
+            )

src/specklepy/api/client.py

@@ -3,6 +3,7 @@ import contextlib
 from specklepy.api.credentials import Account
 from specklepy.api.resources import (
     ActiveUserResource,
+    FileImportResource,
     ModelResource,
     OtherUserResource,
     ProjectInviteResource,
@@ -118,6 +119,12 @@ class SpeckleClient(CoreSpeckleClient):
             client=self.httpclient,
             server_version=server_version,
         )
+        self.file_import = FileImportResource(
+            account=self.account,
+            basepath=self.url,
+            client=self.httpclient,
+            server_version=server_version,
+        )
         self.subscription = SubscriptionResource(
             account=self.account,
             basepath=self.ws_url,

src/specklepy/api/credentials.py

@@ -1,5 +1,3 @@
-from typing import List, Optional
-
 # following imports seem to be unnecessary, but they need to stay
 # to not break the scripts using these functions as non-core
 from specklepy.core.api.credentials import (  # noqa: F401
@@ -14,7 +12,7 @@ from specklepy.core.api.credentials import get_local_accounts as core_get_local_
 from specklepy.logging import metrics
 
 
-def get_local_accounts(base_path: Optional[str] = None) -> List[Account]:
+def get_local_accounts(base_path: str | None = None) -> list[Account]:
     """Gets all the accounts present in this environment
 
     Arguments:
@@ -38,7 +36,7 @@ def get_local_accounts(base_path: Optional[str] = None) -> List[Account]:
     return accounts
 
 
-def get_default_account(base_path: Optional[str] = None) -> Optional[Account]:
+def get_default_account(base_path: str | None = None) -> Account | None:
     """
     Gets this environment's default account if any. If there is no default,
     the first found will be returned and set as default.
@@ -61,7 +59,7 @@ def get_default_account(base_path: Optional[str] = None) -> Optional[Account]:
     return default
 
 
-def get_account_from_token(token: str, server_url: str = None) -> Account:
+def get_account_from_token(token: str, server_url: str | None = None) -> Account:
     """Gets the local account for the token if it exists
     Arguments:
         token {str} -- the api token

src/specklepy/api/resources/__init__.py

@@ -1,4 +1,5 @@
 from specklepy.api.resources.current.active_user_resource import ActiveUserResource
+from specklepy.api.resources.current.file_import_resource import FileImportResource
 from specklepy.api.resources.current.model_resource import ModelResource
 from specklepy.api.resources.current.other_user_resource import OtherUserResource
 from specklepy.api.resources.current.project_invite_resource import (
@@ -11,6 +12,7 @@ from specklepy.api.resources.current.version_resource import VersionResource
 from specklepy.api.resources.current.workspace_resource import WorkspaceResource
 
 __all__ = [
+    "FileImportResource",
     "ActiveUserResource",
     "ModelResource",
     "OtherUserResource",

src/specklepy/api/resources/current/active_user_resource.py

@@ -11,7 +11,12 @@ from specklepy.core.api.models import (
     ResourceCollection,
     User,
 )
-from specklepy.core.api.models.current import PermissionCheckResult, Workspace
+from specklepy.core.api.models.current import (
+    LimitedWorkspace,
+    PermissionCheckResult,
+    ProjectWithPermissions,
+    Workspace,
+)
 from specklepy.core.api.resources import ActiveUserResource as CoreResource
 from specklepy.logging import metrics
 
@@ -51,6 +56,22 @@ class ActiveUserResource(CoreResource):
         metrics.track(metrics.SDK, self.account, {"name": "Active User Get Projects"})
         return super().get_projects(limit=limit, cursor=cursor, filter=filter)
 
+    def get_projects_with_permissions(
+        self,
+        *,
+        limit: int = 25,
+        cursor: Optional[str] = None,
+        filter: Optional[UserProjectsFilter] = None,
+    ) -> ResourceCollection[ProjectWithPermissions]:
+        metrics.track(
+            metrics.SDK,
+            self.account,
+            {"name": "Active User Get Projects With Permissions"},
+        )
+        return super().get_projects_with_permissions(
+            limit=limit, cursor=cursor, filter=filter
+        )
+
     def get_project_invites(self) -> List[PendingStreamCollaborator]:
         metrics.track(
             metrics.SDK, self.account, {"name": "Active User Get Project Invites"}
@@ -74,7 +95,7 @@ class ActiveUserResource(CoreResource):
         metrics.track(metrics.SDK, self.account, {"name": "Active User Get Workspaces"})
         return super().get_workspaces(limit, cursor, filter)
 
-    def get_active_workspace(self) -> Optional[Workspace]:
+    def get_active_workspace(self) -> Optional[LimitedWorkspace]:
         metrics.track(
             metrics.SDK, self.account, {"name": "Active User Get Active Workspace"}
         )

src/specklepy/api/resources/current/file_import_resource.py

@@ -0,0 +1,87 @@
+from pathlib import Path
+
+from typing_extensions import override
+
+from specklepy.core.api.inputs import (
+    FinishFileImportInput,
+    GenerateFileUploadUrlInput,
+    StartFileImportInput,
+)
+from specklepy.core.api.models import FileImport, FileUploadUrl
+from specklepy.core.api.models.current import ResourceCollection
+from specklepy.core.api.resources import FileImportResource as CoreResource
+from specklepy.core.api.resources.current.file_import_resource import UploadFileResponse
+from specklepy.logging import metrics
+
+
+class FileImportResource(CoreResource):
+    """API Access class for projects"""
+
+    def __init__(self, account, basepath, client, server_version) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            server_version=server_version,
+        )
+
+    @override
+    def start_file_import(self, input: StartFileImportInput) -> FileImport:
+        metrics.track(metrics.SDK, self.account, {"name": "File Import Start"})
+        return super().start_file_import(input)
+
+    @override
+    def generate_upload_url(self, input: GenerateFileUploadUrlInput) -> FileUploadUrl:
+        """
+        Get a file upload url from the Speckle server.
+
+        This method asks the server to create a pre-signed S3 url,
+        which can be used as a short term authenticated route,
+        to put a file to the server.
+        """
+        metrics.track(
+            metrics.SDK, self.account, {"name": "File Import Generate Upload Url"}
+        )
+        return super().generate_upload_url(input)
+
+    @override
+    def upload_file(self, file: Path, url: str) -> UploadFileResponse:
+        """
+        Uploads a file to the given S3 url.
+
+        This method should be used together with the generate_upload_url method,
+        which generates a pre-signed S3 url, that can be used to upload the file to.
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "File Import Upload File"})
+        return super().upload_file(file, url)
+
+    @override
+    def download_file(self, project_id: str, file_id: str, target_file: Path) -> Path:
+        """Download a file blob attached to the project, to the target path."""
+        metrics.track(metrics.SDK, self.account, {"name": "File Import Download File"})
+        return super().download_file(project_id, file_id, target_file)
+
+    @override
+    def finish_file_import_job(self, input: FinishFileImportInput) -> bool:
+        """
+        This is mostly an internal api, that marks a file import job finished.
+
+        Only use this if you are writing a file importer, that is responsible for
+        processing file import jobs.
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "File Import Finish Job"})
+        return super().finish_file_import_job(input)
+
+    @override
+    def get_model_file_import_jobs(
+        self,
+        *,
+        project_id: str,
+        model_id: str,
+        limit: int = 25,
+        cursor: str | None = None,
+    ) -> ResourceCollection[FileImport]:
+        metrics.track(metrics.SDK, self.account, {"name": "File Import Get Model Jobs"})
+        return super().get_model_file_import_jobs(
+            project_id=project_id, model_id=model_id, limit=limit, cursor=cursor
+        )

src/specklepy/api/resources/current/project_resource.py

@@ -7,7 +7,11 @@ from specklepy.core.api.inputs.project_inputs import (
     ProjectUpdateRoleInput,
     WorkspaceProjectCreateInput,
 )
-from specklepy.core.api.models import Project, ProjectWithModels, ProjectWithTeam
+from specklepy.core.api.models import (
+    Project,
+    ProjectWithModels,
+    ProjectWithTeam,
+)
 from specklepy.core.api.models.current import ProjectPermissionChecks
 from specklepy.core.api.resources import ProjectResource as CoreResource
 from specklepy.logging import metrics

src/specklepy/api/resources/current/workspace_resource.py

@@ -1,7 +1,12 @@
 from typing import Optional
 
 from specklepy.core.api.inputs.project_inputs import WorksaceProjectsFilter
-from specklepy.core.api.models.current import Project, ResourceCollection, Workspace
+from specklepy.core.api.models.current import (
+    Project,
+    ProjectWithPermissions,
+    ResourceCollection,
+    Workspace,
+)
 from specklepy.core.api.resources import WorkspaceResource as CoreResource
 from specklepy.logging import metrics
 
@@ -30,3 +35,19 @@ class WorkspaceResource(CoreResource):
     ) -> ResourceCollection[Project]:
         metrics.track(metrics.SDK, self.account, {"name": "Workspace Get Projects"})
         return super().get_projects(workspace_id, limit, cursor, filter)
+
+    def get_projects_with_permissions(
+        self,
+        workspace_id: str,
+        limit: int = 25,
+        cursor: Optional[str] = None,
+        filter: Optional[WorksaceProjectsFilter] = None,
+    ) -> ResourceCollection[ProjectWithPermissions]:
+        metrics.track(
+            metrics.SDK,
+            self.account,
+            {"name": "Workspace Get Projects With Permissions"},
+        )
+        return super().get_projects_with_permissions(
+            workspace_id, limit, cursor, filter
+        )

src/specklepy/core/api/client.py

@@ -11,6 +11,7 @@ from gql.transport.websockets import WebsocketsTransport
 from specklepy.core.api.credentials import Account
 from specklepy.core.api.resources import (
     ActiveUserResource,
+    FileImportResource,
     ModelResource,
     OtherUserResource,
     ProjectInviteResource,
@@ -130,6 +131,19 @@ class SpeckleClient:
         self.account = Account.from_token(token, self.url)
         self._set_up_client()
 
+        userData = self.active_user.get()
+
+        # None if the token lacked the profile:read scope or if it was None
+        if userData:
+            self.account.userInfo.id = userData.id
+            self.account.userInfo.email = userData.email
+            self.account.userInfo.name = userData.name
+            self.account.userInfo.company = userData.company
+            self.account.userInfo.avatar = userData.avatar
+
+        self.account.serverInfo = self.server.get()
+        self.account.serverInfo.url = self.url
+
     def authenticate_with_account(self, account: Account) -> None:
         """Authenticate the client using an Account object
         The account is saved in the client object and a synchronous GraphQL
@@ -142,6 +156,21 @@ class SpeckleClient:
         self.account = account
         self._set_up_client()
 
+        try:
+            _ = self.active_user.get()
+        except SpeckleException as ex:
+            if isinstance(ex.exception, TransportServerError):
+                if ex.exception.code == 403:
+                    warn(
+                        SpeckleWarning(
+                            "Possibly invalid token - could not authenticate "
+                            f"Speckle Client for server {self.url}"
+                        ),
+                        stacklevel=2,
+                    )
+                else:
+                    raise ex
+
     def _set_up_client(self) -> None:
         headers = {
             "Authorization": f"Bearer {self.account.token}",
@@ -161,21 +190,6 @@ class SpeckleClient:
 
         self._init_resources()
 
-        try:
-            _ = self.active_user.get()
-        except SpeckleException as ex:
-            if isinstance(ex.exception, TransportServerError):
-                if ex.exception.code == 403:
-                    warn(
-                        SpeckleWarning(
-                            "Possibly invalid token - could not authenticate "
-                            f"Speckle Client for server {self.url}"
-                        ),
-                        stacklevel=2,
-                    )
-                else:
-                    raise ex
-
     def execute_query(self, query: str) -> Dict:
         return self.httpclient.execute(query)
 
@@ -230,6 +244,12 @@ class SpeckleClient:
             client=self.httpclient,
             server_version=server_version,
         )
+        self.file_import = FileImportResource(
+            account=self.account,
+            basepath=self.url,
+            client=self.httpclient,
+            server_version=server_version,
+        )
         self.subscription = SubscriptionResource(
             account=self.account,
             basepath=self.ws_url,

src/specklepy/core/api/connector_versions.py

@@ -0,0 +1,70 @@
+from datetime import datetime
+from typing import List
+
+import httpx
+from pydantic import AliasGenerator, BaseModel, ConfigDict, HttpUrl
+from pydantic.alias_generators import to_pascal
+
+
+class ConnectorFeedBaseModel(BaseModel):
+    """
+    Parent class for all Connector Feed Object Model classes
+    Sets-up a pydantic config to serialize properties using a pascal case alias
+    """
+
+    model_config = ConfigDict(
+        alias_generator=AliasGenerator(
+            validation_alias=to_pascal,
+        ),
+        populate_by_name=True,
+    )
+
+
+class ConnectorVersion(ConnectorFeedBaseModel):
+    number: str
+    url: HttpUrl
+    os: int  # this is an enum, it's properly defined in the old v2 SDK (used by Speckle.Manager.Feed)  # noqa: E501
+    architecture: int  # These are enums, they are properly defined in the old v2 SDK (used by Speckle.Manager.Feed) # noqa: E501
+    date: datetime
+    prerelease: bool
+
+
+class ConnectorVersions(ConnectorFeedBaseModel):
+    versions: List[ConnectorVersion]
+
+
+def get_latest_version(host_app_slug: str, allow_pre_release: bool) -> ConnectorVersion:
+    """
+    Fetches the JSON feed for the given connector slug and
+    Returns the latest version by date - Note, it does not consider semvers!
+
+    Arguments:
+        host_app_slug {str} -- the host app slug to query for
+        allow_pre_release {bool} -- if false, only stable releases will be considered
+    Raises:
+        HTTPStatusError: if http request failed
+        ValidationError: response was not valid json
+        ValueError: The feed contained no connector versions
+    """
+    connector_versions = get_connector_versions(host_app_slug).versions
+    filtered_versions = [
+        v for v in connector_versions if allow_pre_release or not v.prerelease
+    ]
+
+    return max(filtered_versions, key=lambda x: x.date)
+
+
+def get_connector_versions(host_app_slug: str) -> ConnectorVersions:
+    """
+    Fetches the JSON feed for the given slug (v3 feeds only)
+    Raises:
+        HTTPStatusError: if http request failed
+        ValidationError: response was not valid json
+    """
+    url = f"https://releases.speckle.dev/manager2/feeds/{host_app_slug.lower()}-v3.json"
+
+    res = httpx.get(url).raise_for_status()
+
+    feed_data = ConnectorVersions.model_validate_json(res.text)
+
+    return feed_data

src/specklepy/core/api/credentials.py

@@ -1,6 +1,6 @@
 import os
 from pathlib import Path
-from typing import List, Optional
+from typing import List
 from urllib.parse import urlparse
 
 from pydantic import BaseModel, Field  # pylint: disable=no-name-in-module
@@ -12,20 +12,20 @@ from specklepy.transports.sqlite import SQLiteTransport
 
 
 class UserInfo(BaseModel):
-    id: Optional[str] = None
-    name: Optional[str] = None
-    email: Optional[str] = None
-    company: Optional[str] = None
-    avatar: Optional[str] = None
+    id: str | None = None
+    name: str | None = None
+    email: str | None = None
+    company: str | None = None
+    avatar: str | None = None
 
 
 class Account(BaseModel):
     isDefault: bool = False
-    token: Optional[str] = None
-    refreshToken: Optional[str] = None
+    token: str | None = None
+    refreshToken: str | None = None
     serverInfo: ServerInfo = Field(default_factory=ServerInfo)
     userInfo: UserInfo = Field(default_factory=UserInfo)
-    id: Optional[str] = None
+    id: str | None = None
 
     def __repr__(self) -> str:
         return (
@@ -37,13 +37,13 @@ class Account(BaseModel):
         return self.__repr__()
 
     @classmethod
-    def from_token(cls, token: str, server_url: str = None):
+    def from_token(cls, token: str, server_url: str | None = None):
         acct = cls(token=token)
         acct.serverInfo.url = server_url
         return acct
 
 
-def get_local_accounts(base_path: Optional[str] = None) -> List[Account]:
+def get_local_accounts(base_path: str | None = None) -> List[Account]:
     """Gets all the accounts present in this environment
 
     Arguments:
@@ -93,7 +93,7 @@ def get_local_accounts(base_path: Optional[str] = None) -> List[Account]:
     return accounts
 
 
-def get_default_account(base_path: Optional[str] = None) -> Optional[Account]:
+def get_default_account(base_path: str | None = None) -> Account | None:
     """
     Gets this environment's default account if any. If there is no default,
     the first found will be returned and set as default.
@@ -116,7 +116,7 @@ def get_default_account(base_path: Optional[str] = None) -> Optional[Account]:
     return default
 
 
-def get_account_from_token(token: str, server_url: str = None) -> Account:
+def get_account_from_token(token: str, server_url: str | None = None) -> Account:
     """Gets the local account for the token if it exists
     Arguments:
         token {str} -- the api token

src/specklepy/core/api/inputs/__init__.py

@@ -1,3 +1,10 @@
+from specklepy.core.api.inputs.file_import_inputs import (
+    FileImportErrorInput,
+    FileImportSuccessInput,
+    FinishFileImportInput,
+    GenerateFileUploadUrlInput,
+    StartFileImportInput,
+)
 from specklepy.core.api.inputs.model_inputs import (
     CreateModelInput,
     DeleteModelInput,
@@ -22,6 +29,11 @@ from specklepy.core.api.inputs.version_inputs import (
 )
 
 __all__ = [
+    "FileImportErrorInput",
+    "FileImportSuccessInput",
+    "FinishFileImportInput",
+    "StartFileImportInput",
+    "GenerateFileUploadUrlInput",
     "CreateModelInput",
     "DeleteModelInput",
     "UpdateModelInput",

src/specklepy/core/api/inputs/file_import_inputs.py

@@ -0,0 +1,44 @@
+from typing import Literal
+
+from pydantic import Field
+
+from specklepy.core.api.models.graphql_base_model import GraphQLBaseModel
+
+
+class GenerateFileUploadUrlInput(GraphQLBaseModel):
+    project_id: str
+    file_name: str
+
+
+class StartFileImportInput(GraphQLBaseModel):
+    project_id: str
+    model_id: str
+    file_id: str
+    etag: str
+
+
+class FileImportResult(GraphQLBaseModel):
+    duration_seconds: float
+    download_duration_seconds: float
+    parse_duration_seconds: float
+    parser: str
+    version_id: str | None
+
+
+class FileImportInputBase(GraphQLBaseModel):
+    project_id: str
+    job_id: str
+    warnings: list[str] = Field(default_factory=list)
+    result: FileImportResult
+
+
+class FileImportSuccessInput(FileImportInputBase):
+    status: Literal["success"] = "success"
+
+
+class FileImportErrorInput(FileImportInputBase):
+    status: Literal["error"] = "error"
+    reason: str
+
+
+FinishFileImportInput = FileImportSuccessInput | FileImportErrorInput

src/specklepy/core/api/models/__init__.py

@@ -1,5 +1,7 @@
 from specklepy.core.api.models.current import (
     AuthStrategy,
+    FileImport,
+    FileUploadUrl,
     LimitedUser,
     Model,
     ModelWithVersions,
@@ -8,6 +10,7 @@ from specklepy.core.api.models.current import (
     ProjectCollaborator,
     ProjectCommentCollection,
     ProjectWithModels,
+    ProjectWithPermissions,
     ProjectWithTeam,
     ResourceCollection,
     ServerConfiguration,
@@ -39,6 +42,7 @@ __all__ = [
     "ModelWithVersions",
     "Project",
     "ProjectWithModels",
+    "ProjectWithPermissions",
     "ProjectWithTeam",
     "ProjectCommentCollection",
     "UserSearchResultCollection",
@@ -46,4 +50,6 @@ __all__ = [
     "ProjectModelsUpdatedMessage",
     "ProjectUpdatedMessage",
     "ProjectVersionsUpdatedMessage",
+    "FileImport",
+    "FileUploadUrl",
 ]

src/specklepy/core/api/models/current.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Generic, List, Optional, TypeVar
+from typing import Generic, List, TypeVar
 
 from specklepy.core.api.enums import ProjectVisibility
 from specklepy.core.api.models.graphql_base_model import GraphQLBaseModel
@@ -10,13 +10,13 @@ T = TypeVar("T")
 
 class User(GraphQLBaseModel):
     id: str
-    email: Optional[str] = None
+    email: str | None = None
     name: str
-    bio: Optional[str] = None
-    company: Optional[str] = None
-    avatar: Optional[str] = None
-    verified: Optional[bool] = None
-    role: Optional[str] = None
+    bio: str | None = None
+    company: str | None = None
+    avatar: str | None = None
+    verified: bool | None = None
+    role: str | None = None
 
     def __repr__(self):
         return (
@@ -31,16 +31,16 @@ class User(GraphQLBaseModel):
 class ResourceCollection(GraphQLBaseModel, Generic[T]):
     total_count: int
     items: List[T]
-    cursor: Optional[str] = None
+    cursor: str | None = None
 
 
 class ServerMigration(GraphQLBaseModel):
-    moved_from: Optional[str]
-    moved_to: Optional[str]
+    moved_from: str | None
+    moved_to: str | None
 
 
 class AuthStrategy(GraphQLBaseModel):
-    color: Optional[str]
+    color: str | None
     icon: str
     id: str
     name: str
@@ -60,17 +60,17 @@ class ServerWorkspacesInfo(GraphQLBaseModel):
 # Keeping this one all Optionals at the minute,
 #  because its used both as a deserialization model for GQL and Account Management
 class ServerInfo(GraphQLBaseModel):
-    name: Optional[str] = None
-    company: Optional[str] = None
-    url: Optional[str] = None
-    admin_contact: Optional[str] = None
-    description: Optional[str] = None
-    canonical_url: Optional[str] = None
-    scopes: Optional[List[dict]] = None
-    auth_strategies: Optional[List[dict]] = None
-    version: Optional[str] = None
-    migration: Optional[ServerMigration] = None
-    workspaces: Optional[ServerWorkspacesInfo] = None
+    name: str | None = None
+    company: str | None = None
+    url: str | None = None
+    admin_contact: str | None = None
+    description: str | None = None
+    canonical_url: str | None = None
+    scopes: List[dict] | None = None
+    auth_strategies: List[dict] | None = None
+    version: str | None = None
+    migration: ServerMigration | None = None
+    workspaces: ServerWorkspacesInfo | None = None
     # TODO separate gql model from account management model
 
 
@@ -79,11 +79,11 @@ class LimitedUser(GraphQLBaseModel):
 
     id: str
     name: str
-    bio: Optional[str]
-    company: Optional[str]
-    avatar: Optional[str]
-    verified: Optional[bool]
-    role: Optional[str]
+    bio: str | None
+    company: str | None
+    avatar: str | None
+    verified: bool | None
+    role: str | None
 
     def __repr__(self):
         return (
@@ -99,15 +99,15 @@ class LimitedUser(GraphQLBaseModel):
 class PendingStreamCollaborator(GraphQLBaseModel):
     id: str
     invite_id: str
-    stream_id: Optional[str] = None
+    stream_id: str | None = None
     projectId: str
-    stream_name: Optional[str] = None
+    stream_name: str | None = None
     project_name: str
     title: str
     role: str
     invited_by: LimitedUser
-    user: Optional[LimitedUser] = None
-    token: Optional[str]
+    user: LimitedUser | None = None
+    token: str | None
 
     def __repr__(self):
         return (
@@ -127,24 +127,24 @@ class ProjectCollaborator(GraphQLBaseModel):
 
 
 class Version(GraphQLBaseModel):
-    author_user: Optional[LimitedUser]
+    author_user: LimitedUser | None
     created_at: datetime
     id: str
-    message: Optional[str]
+    message: str | None
     preview_url: str
-    referenced_object: Optional[str]
+    referenced_object: str | None
     """Maybe null if workspaces version history limit has been exceeded"""
-    source_application: Optional[str]
+    source_application: str | None
 
 
 class Model(GraphQLBaseModel):
-    author: Optional[LimitedUser]
+    author: LimitedUser | None
     created_at: datetime
-    description: Optional[str]
+    description: str | None
     display_name: str
     id: str
     name: str
-    preview_url: Optional[str]
+    preview_url: str | None
     updated_at: datetime
 
 
@@ -162,20 +162,24 @@ class ProjectPermissionChecks(GraphQLBaseModel):
 class Project(GraphQLBaseModel):
     allow_public_comments: bool
     created_at: datetime
-    description: Optional[str]
+    description: str | None
     id: str
     name: str
-    role: Optional[str]
+    role: str | None
     source_apps: List[str]
     updated_at: datetime
     visibility: ProjectVisibility
-    workspace_id: Optional[str]
+    workspace_id: str | None
 
 
 class ProjectWithModels(Project):
     models: ResourceCollection[Model]
 
 
+class ProjectWithPermissions(Project):
+    permissions: ProjectPermissionChecks
+
+
 class ProjectWithTeam(Project):
     invited_team: List[PendingStreamCollaborator]
     team: List[ProjectCollaborator]
@@ -187,7 +191,7 @@ class ProjectCommentCollection(ResourceCollection[T], Generic[T]):
 
 class UserSearchResultCollection(GraphQLBaseModel):
     items: List[LimitedUser]
-    cursor: Optional[str] = None
+    cursor: str | None = None
 
 
 class PermissionCheckResult(GraphQLBaseModel):
@@ -209,15 +213,34 @@ class WorkspaceCreationState(GraphQLBaseModel):
     completed: bool
 
 
-class Workspace(GraphQLBaseModel):
+class LimitedWorkspace(GraphQLBaseModel):
     id: str
     name: str
-    role: Optional[str]
+    role: str | None
     slug: str
-    logo: Optional[str]
+    logo: str | None
+    description: str | None
+
+
+class Workspace(LimitedWorkspace):
     created_at: datetime
     updated_at: datetime
     read_only: bool
-    description: Optional[str]
-    creation_state: Optional[WorkspaceCreationState]
+    creation_state: WorkspaceCreationState | None
     permissions: WorkspacePermissionChecks
+
+
+class FileImport(GraphQLBaseModel):
+    id: str
+    project_id: str
+    converted_version_id: str | None
+    user_id: str
+    converted_status: int
+    converted_message: str | None
+    model_id: str | None
+    updated_at: datetime
+
+
+class FileUploadUrl(GraphQLBaseModel):
+    url: str
+    file_id: str

src/specklepy/core/api/resources/__init__.py

@@ -1,4 +1,5 @@
 from specklepy.core.api.resources.current.active_user_resource import ActiveUserResource
+from specklepy.core.api.resources.current.file_import_resource import FileImportResource
 from specklepy.core.api.resources.current.model_resource import ModelResource
 from specklepy.core.api.resources.current.other_user_resource import OtherUserResource
 from specklepy.core.api.resources.current.project_invite_resource import (
@@ -13,6 +14,7 @@ from specklepy.core.api.resources.current.version_resource import VersionResourc
 from specklepy.core.api.resources.current.workspace_resource import WorkspaceResource
 
 __all__ = [
+    "FileImportResource",
     "ActiveUserResource",
     "ModelResource",
     "OtherUserResource",

src/specklepy/core/api/resources/current/active_user_resource.py

@@ -13,7 +13,12 @@ from specklepy.core.api.models import (
     ResourceCollection,
     User,
 )
-from specklepy.core.api.models.current import PermissionCheckResult, Workspace
+from specklepy.core.api.models.current import (
+    LimitedWorkspace,
+    PermissionCheckResult,
+    ProjectWithPermissions,
+    Workspace,
+)
 from specklepy.core.api.resource import ResourceBase
 from specklepy.core.api.responses import DataResponse
 from specklepy.logging.exceptions import GraphQLException
@@ -291,7 +296,7 @@ class ActiveUserResource(ResourceBase):
 
         return response.data.data
 
-    def get_active_workspace(self) -> Optional[Workspace]:
+    def get_active_workspace(self) -> Optional[LimitedWorkspace]:
         """
         This feature is only available on Workspace enabled servers  (server versions
         >=2.23.17) e.g. app.speckle.systems
@@ -306,29 +311,15 @@ class ActiveUserResource(ResourceBase):
                   role
                   slug
                   logo
-                  createdAt
-                  updatedAt
-                  readOnly
                   description
-                  creationState
-                  {
-                    completed
-                  }
-                  permissions {
-                    canCreateProject {
-                      authorized
-                      code
-                      message
-                    }
-                  }
                 }
               }
             }
-            """  # noqa: E501
+            """
         )
 
         response = self.make_request_and_parse_response(
-            DataResponse[Optional[DataResponse[Optional[Workspace]]]],
+            DataResponse[Optional[DataResponse[Optional[LimitedWorkspace]]]],
             QUERY,
         )
 
@@ -338,3 +329,84 @@ class ActiveUserResource(ResourceBase):
             )
 
         return response.data.data
+
+    def get_projects_with_permissions(
+        self,
+        *,
+        limit: int = 25,
+        cursor: Optional[str] = None,
+        filter: Optional[UserProjectsFilter] = None,
+    ) -> ResourceCollection[ProjectWithPermissions]:
+        """
+        Gets the currently active user's projects with their permissions.
+        This is useful for checking what actions can be performed on each project.
+        """
+        QUERY = gql(
+            """
+          query User($limit : Int!, $cursor: String, $filter: UserProjectsFilter) {
+            data:activeUser {
+              data:projects(limit: $limit, cursor: $cursor, filter: $filter) {
+                totalCount
+                cursor
+                items {
+                    id
+                    name
+                    description
+                    visibility
+                    allowPublicComments
+                    role
+                    createdAt
+                    updatedAt
+                    sourceApps
+                    workspaceId
+                    permissions {
+                      canCreateModel {
+                        code
+                        authorized
+                        message
+                      }
+                      canDelete {
+                        code
+                        authorized
+                        message
+                      }
+                      canLoad {
+                        code
+                        authorized
+                        message
+                      }
+                      canPublish {
+                        code
+                        authorized
+                        message
+                      }
+                    }
+                }
+              }
+            }
+          }
+          """
+        )
+
+        variables = {
+            "limit": limit,
+            "cursor": cursor,
+            "filter": filter.model_dump(warnings="error", by_alias=True)
+            if filter
+            else None,
+        }
+
+        response = self.make_request_and_parse_response(
+            DataResponse[
+                Optional[DataResponse[ResourceCollection[ProjectWithPermissions]]]
+            ],
+            QUERY,
+            variables,
+        )
+
+        if response.data is None:
+            raise GraphQLException(
+                "GraphQL response indicated that the ActiveUser could not be found"
+            )
+
+        return response.data.data

src/specklepy/core/api/resources/current/file_import_resource.py

@@ -0,0 +1,212 @@
+from pathlib import Path
+from typing import Any
+
+import httpx
+from gql import Client, gql
+
+from specklepy.core.api.credentials import Account
+from specklepy.core.api.inputs.file_import_inputs import (
+    FinishFileImportInput,
+    GenerateFileUploadUrlInput,
+    StartFileImportInput,
+)
+from specklepy.core.api.models import FileImport, FileUploadUrl, ResourceCollection
+from specklepy.core.api.models.graphql_base_model import GraphQLBaseModel
+from specklepy.core.api.resource import ResourceBase
+from specklepy.core.api.responses import DataResponse
+from specklepy.logging.exceptions import SpeckleException
+
+
+class UploadFileResponse(GraphQLBaseModel):
+    etag: str
+
+
+class FileImportResource(ResourceBase):
+    """API Access class for project invites"""
+
+    def __init__(
+        self,
+        account: Account,
+        basepath: str,
+        client: Client,
+        server_version: tuple[Any, ...] | None,  # pyright: ignore[reportExplicitAny]
+    ) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            server_version=server_version,
+            name="file-import",
+        )
+
+    def finish_file_import_job(self, input: FinishFileImportInput) -> bool:
+        """
+        This is mostly an internal api, that marks a file import job finished.
+
+        Only use this if you are writing a file importer, that is responsible for
+        processing file import jobs.
+        """
+        QUERY = gql(
+            """
+                mutation FinishFileImport($input: FinishFileImportInput!) {
+                    data:fileUploadMutations {
+                        data:finishFileImport(input: $input)
+                    }
+                }
+            """
+        )
+
+        variables = {
+            "input": input.model_dump(warnings="error", by_alias=True),
+        }
+
+        return self.make_request_and_parse_response(
+            DataResponse[DataResponse[bool]], QUERY, variables
+        ).data.data
+
+    def start_file_import(self, input: StartFileImportInput) -> FileImport:
+        QUERY = gql(
+            """
+            mutation StartFileImport($input: StartFileImportInput!) {
+                data:fileUploadMutations {
+                    data:startFileImport(input: $input) {
+                        id
+                        projectId
+                        convertedVersionId
+                        userId
+                        convertedStatus
+                        convertedMessage
+                        modelId
+                        updatedAt
+                    }
+                }
+            }
+        """
+        )
+
+        variables = {
+            "input": input.model_dump(warnings="error", by_alias=True),
+        }
+
+        return self.make_request_and_parse_response(
+            DataResponse[DataResponse[FileImport]], QUERY, variables
+        ).data.data
+
+    def generate_upload_url(self, input: GenerateFileUploadUrlInput) -> FileUploadUrl:
+        """
+        Get a file upload url from the Speckle server.
+
+        This method asks the server to create a pre-signed S3 url,
+        which can be used as a short term authenticated route,
+        to put a file to the server.
+        """
+        QUERY = gql(
+            """
+            mutation GenerateUploadUrl($input: GenerateFileUploadUrlInput!) {
+                data:fileUploadMutations {
+                    data:generateUploadUrl(input: $input) {
+                        fileId
+                        url
+                    }
+                }
+            }
+        """
+        )
+
+        variables = {
+            "input": input.model_dump(warnings="error", by_alias=True),
+        }
+
+        return self.make_request_and_parse_response(
+            DataResponse[DataResponse[FileUploadUrl]], QUERY, variables
+        ).data.data
+
+    def upload_file(self, file: Path, url: str) -> UploadFileResponse:
+        """
+        Uploads a file to the given S3 url.
+
+        This method should be used together with the generate_upload_url method,
+        which generates a pre-signed S3 url, that can be used to upload the file to.
+        """
+        with open(file, "rb") as content:
+            response = httpx.put(
+                url,
+                content=content,  # Pass file object directly for streaming
+                headers={
+                    "Content-Type": "application/octet-stream",
+                    "Content-Length": str(file.stat().st_size),
+                },
+            ).raise_for_status()
+            etag = response.headers.get("ETag", None)  # pyright: ignore[reportAny]
+            if not etag:
+                raise SpeckleException(
+                    "Response does not have an ETag attached to it,"
+                    + " cannot use this as an upload"
+                )
+            return UploadFileResponse(etag=str(etag))  # pyright: ignore[reportAny]
+
+    def download_file(self, project_id: str, file_id: str, target_file: Path) -> Path:
+        """Download a file blob attached to the project, to the target path."""
+        if not target_file.parent.exists():
+            target_file.parent.mkdir(parents=True)
+        url = f"{self.basepath}/api/stream/{project_id}/blob/{file_id}"
+        with httpx.stream(
+            "GET", url, headers={"Authorization": f"Bearer {self.account.token}"}
+        ) as response:
+            _ = response.raise_for_status()
+            with target_file.open("wb") as f:
+                for chunk in response.iter_bytes(chunk_size=8192):
+                    _ = f.write(chunk)
+        return target_file
+
+    def get_model_file_import_jobs(
+        self,
+        *,
+        project_id: str,
+        model_id: str,
+        limit: int = 25,
+        cursor: str | None = None,
+    ) -> ResourceCollection[FileImport]:
+        QUERY = gql(
+            """
+            query ModelFileImportJobs(
+                $projectId: String!,
+                $modelId: String!,
+                $input: GetModelUploadsInput
+            ) {
+              data:project(id: $projectId) {
+                data:model(id: $modelId) {
+                    data:uploads(input: $input) {
+                        totalCount
+                        cursor
+                        items {
+                            id
+                            projectId
+                            convertedVersionId
+                            userId
+                            convertedStatus
+                            convertedMessage
+                            modelId
+                            updatedAt
+                        }
+                    }
+                }
+              }
+            }
+            """
+        )
+
+        variables = {
+            "projectId": project_id,
+            "modelId": model_id,
+            "input": {
+                "limit": limit,
+                "cursor": cursor,
+            },
+        }
+
+        return self.make_request_and_parse_response(
+            DataResponse[DataResponse[DataResponse[ResourceCollection[FileImport]]]],
+            QUERY,
+            variables,
+        ).data.data.data

src/specklepy/core/api/resources/current/project_resource.py

@@ -9,7 +9,11 @@ from specklepy.core.api.inputs.project_inputs import (
     ProjectUpdateRoleInput,
     WorkspaceProjectCreateInput,
 )
-from specklepy.core.api.models import Project, ProjectWithModels, ProjectWithTeam
+from specklepy.core.api.models import (
+    Project,
+    ProjectWithModels,
+    ProjectWithTeam,
+)
 from specklepy.core.api.models.current import ProjectPermissionChecks
 from specklepy.core.api.resource import ResourceBase
 from specklepy.core.api.responses import DataResponse

src/specklepy/core/api/resources/current/workspace_resource.py

@@ -3,7 +3,12 @@ from typing import Optional
 from gql import gql
 
 from specklepy.core.api.inputs.project_inputs import WorksaceProjectsFilter
-from specklepy.core.api.models.current import Project, ResourceCollection, Workspace
+from specklepy.core.api.models.current import (
+    Project,
+    ProjectWithPermissions,
+    ResourceCollection,
+    Workspace,
+)
 from specklepy.core.api.resource import ResourceBase
 from specklepy.core.api.responses import DataResponse
 
@@ -104,3 +109,72 @@ class WorkspaceResource(ResourceBase):
         return self.make_request_and_parse_response(
             DataResponse[DataResponse[ResourceCollection[Project]]], QUERY, variables
         ).data.data
+
+    def get_projects_with_permissions(
+        self,
+        workspace_id: str,
+        limit: int = 25,
+        cursor: Optional[str] = None,
+        filter: Optional[WorksaceProjectsFilter] = None,
+    ) -> ResourceCollection[ProjectWithPermissions]:
+        QUERY = gql(
+            """
+            query Workspace($workspaceId: String!, $limit: Int!, $cursor: String, $filter: WorkspaceProjectsFilter) {
+              data:workspace(id: $workspaceId) {
+                data:projects(limit: $limit, cursor: $cursor, filter: $filter) {
+                  cursor
+                  items {
+                    allowPublicComments
+                    createdAt
+                    description
+                    id
+                    name
+                    role
+                    sourceApps
+                    updatedAt
+                    visibility
+                    workspaceId
+                    permissions {
+                      canCreateModel {
+                        code
+                        authorized
+                        message
+                      }
+                      canDelete {
+                        code
+                        authorized
+                        message
+                      }
+                      canLoad {
+                        code
+                        authorized
+                        message
+                      }
+                      canPublish {
+                        code
+                        authorized
+                        message
+                      }
+                    }
+                  }
+                  totalCount
+                }
+              }
+            }
+            """  # noqa: E501
+        )
+
+        variables = {
+            "workspaceId": workspace_id,
+            "limit": limit,
+            "cursor": cursor,
+            "filter": filter.model_dump(warnings="error", by_alias=True)
+            if filter
+            else None,
+        }
+
+        return self.make_request_and_parse_response(
+            DataResponse[DataResponse[ResourceCollection[ProjectWithPermissions]]],
+            QUERY,
+            variables,
+        ).data.data

src/specklepy/core/api/wrapper.py

@@ -1,8 +1,6 @@
 from urllib.parse import quote, unquote, urlparse
 from warnings import warn
 
-from gql import gql
-
 from specklepy.core.api.client import SpeckleClient
 from specklepy.core.api.credentials import (
     Account,
@@ -139,27 +137,11 @@ class StreamWrapper:
 
         if use_fe2 is True and self.branch_name is not None:
             self.model_id = self.branch_name
-            # get branch name
-            query = gql(
-                """
-                query Project($project_id: String!, $model_id: String!) {
-                    project(id: $project_id) {
-                        id
-                        model(id: $model_id) {
-                            name
-                        }
-                    }
-                }
-            """
-            )
-            self._client = self.get_client()
-            params = {"project_id": self.stream_id, "model_id": self.model_id}
-            project = self._client.httpclient.execute(query, params)
 
-            try:
-                self.branch_name = project["project"]["model"]["name"]
-            except KeyError as ke:
-                raise SpeckleException("Project model name is not found", ke) from ke
+            self._client = self.get_client()
+            model = self._client.model.get(self.model_id, self.stream_id)
+
+            self.branch_name = model.name
 
         if not self.stream_id:
             raise SpeckleException(
@@ -175,6 +157,10 @@ class StreamWrapper:
         """
         Gets an account object for this server from the local accounts db
         (added via Speckle Manager or a json file)
+
+        WARNING: this function will return ANY account for the server,
+          just because you pass a token in doesn't guarantee it will be used.
+          This whole class could do with a re-design...
         """
         if self._account and self._account.token:
             return self._account

src/specklepy/core/helpers/__init__.py

@@ -1 +1,5 @@
 """Common helpers module for Core."""
+
+from specklepy.core.helpers.random import crypto_random_string
+
+__all__ = ["crypto_random_string"]

src/specklepy/core/helpers/random.py

@@ -0,0 +1,8 @@
+import secrets
+import string
+
+
+def crypto_random_string(length: int) -> str:
+    """Generate a semi crypto random string of a given length."""
+    alphabet = string.ascii_letters + string.digits
+    return "".join(secrets.choice(alphabet) for _ in range(length)).lower()

src/specklepy/core/helpers/speckle_path_provider.py

@@ -88,6 +88,8 @@ def user_application_data_path() -> Path:
                     message="Cannot get appdata path from environment."
                 )
             return Path(app_data_path)
+        if sys.platform.startswith("darwin"):  # macOS
+            return _ensure_folder_exists(Path.home() / "Library", "Application Support")
         else:
             # try getting the standard XDG_DATA_HOME value
             # as that is used as an override
@@ -98,7 +100,7 @@ def user_application_data_path() -> Path:
                 return _ensure_folder_exists(Path.home(), ".config")
     except Exception as ex:
         raise SpeckleException(
-            message="Failed to initialize user application data path.", exception=ex
+            message="Failed to initialize user application data path."
         ) from ex
 
 

src/specklepy/logging/metrics.py

@@ -6,10 +6,12 @@ import platform
 import queue
 import sys
 import threading
-from typing import Optional
+from typing import Any
 
 import requests
 
+from specklepy.core.api.credentials import Account
+
 """
 Anonymous telemetry to help us understand how to make a better Speckle.
 This really helps us to deliver a better open source project and product!
@@ -28,21 +30,6 @@ CONNECTOR = "Connector Action"
 RECEIVE = "Receive"
 SEND = "Send"
 
-# not in use since 2.15
-ACCOUNTS = "Get Local Accounts"
-BRANCH = "Branch Action"
-CLIENT = "Speckle Client"
-COMMIT = "Commit Action"
-DESERIALIZE = "serialization/deserialize"
-INVITE = "Invite Action"
-OTHER_USER = "Other User Action"
-PERMISSION = "Permission Action"
-SERIALIZE = "serialization/serialize"
-SERVER = "Server Action"
-STREAM = "Stream Action"
-STREAM_WRAPPER = "Stream Wrapper"
-USER = "User Action"
-
 
 def disable():
     global TRACK
@@ -54,7 +41,7 @@ def enable():
     TRACK = True
 
 
-def set_host_app(host_app: str, host_app_version: Optional[str] = None):
+def set_host_app(host_app: str, host_app_version: str | None = None):
     global HOST_APP, HOST_APP_VERSION
     HOST_APP = host_app
     HOST_APP_VERSION = host_app_version or HOST_APP_VERSION
@@ -62,45 +49,46 @@ def set_host_app(host_app: str, host_app_version: Optional[str] = None):
 
 def track(
     action: str,
-    account=None,
-    custom_props: Optional[dict] = None,
+    account: Account | None = None,
+    custom_props: dict | None = None,
+    send_sync: bool = False,
 ):
     if not TRACK:
         return
-    try:
-        initialise_tracker(account)
-        event_params = {
-            "event": action,
-            "properties": {
-                "distinct_id": METRICS_TRACKER.last_user,
-                "server_id": METRICS_TRACKER.last_server,
-                "token": METRICS_TRACKER.analytics_token,
-                "hostApp": HOST_APP,
-                "hostAppVersion": HOST_APP_VERSION,
-                "$os": METRICS_TRACKER.platform,
-                "type": "action",
-            },
-        }
-        if custom_props:
-            event_params["properties"].update(custom_props)
 
-        METRICS_TRACKER.queue.put_nowait(event_params)
-    except Exception as ex:
-        # wrapping this whole thing in a try except as we never want a failure here
-        # to annoy users!
-        LOG.debug(f"Error queueing metrics request: {str(ex)}")
+    tracker = initialise_tracker(account)
+    event_params: dict[str, Any] = {
+        "event": action,
+        "properties": {
+            "distinct_id": tracker.last_user,
+            "server_id": tracker.last_server,
+            "token": tracker.analytics_token,
+            "hostApp": HOST_APP,
+            "hostAppVersion": HOST_APP_VERSION,
+            "$os": tracker.platform,
+            "type": "action",
+        },
+    }
+    if custom_props:
+        event_params["properties"].update(custom_props)
+
+    if send_sync:
+        tracker.send_event(event_params)
+    else:
+        tracker.queue_event(event_params)
 
 
-def initialise_tracker(account=None):
+def initialise_tracker(account: Account | None = None) -> "MetricsTracker":
     global METRICS_TRACKER
     if not METRICS_TRACKER:
         METRICS_TRACKER = MetricsTracker()
 
-    if account and account.userInfo.email:
+    if account:
         METRICS_TRACKER.set_last_user(account.userInfo.email)
-    if account and account.serverInfo.url:
         METRICS_TRACKER.set_last_server(account.serverInfo.url)
 
+    return METRICS_TRACKER
+
 
 class Singleton(type):
     _instances = {}
@@ -112,48 +100,62 @@ class Singleton(type):
 
 
 class MetricsTracker(metaclass=Singleton):
-    analytics_url = "https://analytics.speckle.systems/track?ip=1"
-    analytics_token = "acd87c5a50b56df91a795e999812a3a4"
-    last_user = ""
-    last_server = None
-    platform = None
-    sending_thread = None
-    queue = queue.Queue(1000)
+    analytics_url: str = "https://analytics.speckle.systems/track?ip=1"
+    analytics_token: str = "acd87c5a50b56df91a795e999812a3a4"
+    last_user: str = ""
+    last_server: str | None = None
+    platform: str
+
+    _sending_thread: threading.Thread
+    _queue: queue.Queue[dict[str, Any]] = queue.Queue(1000)
+    _session = requests.Session()
 
     def __init__(self) -> None:
-        self.sending_thread = threading.Thread(
+        self._sending_thread = threading.Thread(
             target=self._send_tracking_requests, daemon=True
         )
         self.platform = PLATFORMS.get(sys.platform, "linux")
-        self.sending_thread.start()
+        self._sending_thread.start()
         with contextlib.suppress(Exception):
             node, user = platform.node(), getpass.getuser()
             if node and user:
                 self.last_user = f"@{self.hash(f'{node}-{user}')}"
 
-    def set_last_user(self, email: str):
+    def set_last_user(self, email: str | None) -> None:
         if not email:
             return
         self.last_user = f"@{self.hash(email)}"
 
-    def set_last_server(self, server: str):
+    def set_last_server(self, server: str | None) -> None:
         if not server:
             return
         self.last_server = self.hash(server)
 
-    def hash(self, value: str):
+    def hash(self, value: str) -> str:
         inputList = value.lower().split("://")
         input = inputList[len(inputList) - 1].split("/")[0].split("?")[0]
         return hashlib.md5(input.encode("utf-8")).hexdigest().upper()
 
-    def _send_tracking_requests(self):
-        session = requests.Session()
+    def queue_event(self, event_params: dict[str, Any]) -> None:
+        try:
+            self._queue.put_nowait(event_params)
+        except queue.Full:
+            LOG.warning(
+                "Metrics event was skipped because the metrics queue was was full",
+                exc_info=True,
+            )
+
+    def send_event(self, event_params: dict[str, Any]) -> None:
+        response = self._session.post(self.analytics_url, json=[event_params])
+        response.raise_for_status()
+
+    def _send_tracking_requests(self) -> None:
         while True:
-            event_params = [self.queue.get()]
+            event_params = self._queue.get()
 
             try:
-                session.post(self.analytics_url, json=event_params)
-            except Exception as ex:
-                LOG.debug(f"Error sending metrics request: {str(ex)}")
+                self.send_event(event_params)
+            except Exception:
+                LOG.warning("Error sending metrics request", exc_info=True)
 
-            self.queue.task_done()
+            self._queue.task_done()

src/specklepy/objects/base.py

@@ -323,6 +323,30 @@ def _validate_type(t: Optional[type], value: Any) -> Tuple[bool, Any]:
 
 @dataclass(kw_only=True)
 class Base(_RegisteringBase, speckle_type="Base"):
+    """Base class for all Speckle objects.
+
+    The base object class is the foundation of all data being
+    transferred with Speckle. Any custom data structure that you want to transfer via
+    Speckle should inherit from it.
+
+    Objects in Speckle are immutable for storage purposes. When any property changes,
+    the object gets a new identity (hash). This hash is stored in the `id` property
+    after serialization.
+
+    Attributes:
+        id: Unique identifier (hash) for the object. This is typically
+        set automatically during serialization and depends on the object's properties.
+        applicationId: Optional identifier for the application that created
+            this object, can store the host application's native object ID.
+
+    ```py title="Example"
+    from specklepy.objects.base import Base
+    obj = Base(id="some-id", applicationId="my-app")
+    obj["custom_prop"] = 42  # Add a dynamic property
+    obj["@detached_prop"] = another_object  # Add a detached property
+    ```
+    """
+
     id: Union[str, None] = None
     # totalChildrenCount: Union[int, None] = None
     applicationId: Union[str, None] = None

src/specklepy/objects/data_objects.py

@@ -18,6 +18,10 @@ class DataObject(
     speckle_type="Objects.Data.DataObject",
     detachable={"displayValue"},
 ):
+    """
+    A generic data object that can hold arbitrary properties and display values.
+    """
+
     name: str
     properties: Dict[str, object]
     displayValue: List[Base]

src/specklepy/objects/geometry/arc.py

@@ -9,6 +9,30 @@ from specklepy.objects.interfaces import ICurve, IHasUnits
 
 @dataclass(kw_only=True)
 class Arc(Base, IHasUnits, ICurve, speckle_type="Objects.Geometry.Arc"):
+    """
+    An arc defined by a plane, start point, mid point and end point.
+
+    This class represents a circular arc in 3D space, defined by three points
+    and a plane. The arc is a portion of a circle that lies on the specified plane.
+
+    Attributes:
+        plane: The plane on which the arc lies
+        startPoint: The starting point of the arc
+        midPoint: A point on the arc between the start and end points
+        endPoint: The ending point of the arc.
+
+
+    ```py title="Example"
+    from specklepy.objects.geometry.plane import Plane
+    from specklepy.objects.geometry.point import Point
+    plane = Plane(origin=Point(0, 0, 0), normal=Point(0, 0, 1))
+    start = Point(1, 0, 0)
+    mid = Point(0.7071, 0.7071, 0)
+    end = Point(0, 1, 0)
+    arc = Arc(plane=plane, startPoint=start, midPoint=mid, endPoint=end)
+    ```
+    """
+
     plane: Plane
     startPoint: Point
     midPoint: Point
@@ -16,10 +40,20 @@ class Arc(Base, IHasUnits, ICurve, speckle_type="Objects.Geometry.Arc"):
 
     @property
     def radius(self) -> float:
+        """Calculates the radius of the arc.
+
+        Returns:
+            The radius of the arc, as the distance from the start point to the origin.
+        """
         return self.startPoint.distance_to(self.plane.origin)
 
     @property
     def length(self) -> float:
+        """Calculates the length of the arc.
+
+        Returns:
+            The length of the arc.
+        """
         start_to_mid = self.startPoint.distance_to(self.midPoint)
         mid_to_end = self.midPoint.distance_to(self.endPoint)
         r = self.radius
@@ -30,6 +64,11 @@ class Arc(Base, IHasUnits, ICurve, speckle_type="Objects.Geometry.Arc"):
 
     @property
     def measure(self) -> float:
+        """Calculates the angular measure of the arc in radians.
+
+        Returns:
+            The angular measure of the arc in radians.
+        """
         start_to_mid = self.startPoint.distance_to(self.midPoint)
         mid_to_end = self.midPoint.distance_to(self.endPoint)
         r = self.radius

src/specklepy/objects/geometry/box.py

@@ -9,7 +9,29 @@ from specklepy.objects.primitive import Interval
 @dataclass(kw_only=True)
 class Box(Base, IHasUnits, IHasArea, IHasVolume, speckle_type="Objects.Geometry.Box"):
     """
-    a 3-dimensional box oriented on a plane
+    A 3-dimensional box oriented on a plane.
+
+    This class represents a rectangular prism in 3D space, defined by a base plane and
+    three intervals specifying its dimensions along the x, y, and z axes.
+
+    Attributes:
+        basePlane: The plane on which the box is oriented
+        xSize: The interval defining the box's size along the x-axis
+        ySize: The interval defining the box's size along the y-axis
+        zSize: The interval defining the box's size along the z-axis
+
+    ```py title="Example"
+    from specklepy.objects.geometry.plane import Plane
+    from specklepy.objects.geometry.point import Point
+    from specklepy.objects.primitive import Interval
+
+    base_plane = Plane(origin=Point(0, 0, 0), normal=Point(0, 0, 1))
+    x_size = Interval(start=0, end=10)
+    y_size = Interval(start=0, end=5)
+    z_size = Interval(start=0, end=3)
+
+    box = Box(basePlane=base_plane, xSize=x_size, ySize=y_size, zSize=z_size)
+    ```
     """
 
     basePlane: Plane
@@ -29,6 +51,11 @@ class Box(Base, IHasUnits, IHasArea, IHasVolume, speckle_type="Objects.Geometry.
 
     @property
     def area(self) -> float:
+        """Calculates the surface area of the box.
+
+        Returns:
+            The total surface area of the box.
+        """
         return 2 * (
             self.xSize.length * self.ySize.length
             + self.xSize.length * self.zSize.length
@@ -37,4 +64,9 @@ class Box(Base, IHasUnits, IHasArea, IHasVolume, speckle_type="Objects.Geometry.
 
     @property
     def volume(self) -> float:
+        """Calculates the volume of the box.
+
+        Returns:
+            The volume of the box.
+        """
         return self.xSize.length * self.ySize.length * self.zSize.length

src/specklepy/objects/proxies.py

@@ -33,9 +33,9 @@ class InstanceProxy(
     IHasUnits,
     speckle_type="Speckle.Core.Models.Instances.InstanceProxy",
 ):
-    definition_id: str
+    definitionId: str
     transform: List[float]
-    max_depth: int
+    maxDepth: int
 
 
 @dataclass(kw_only=True)
@@ -45,10 +45,30 @@ class InstanceDefinitionProxy(
     detachable={"objects"},
 ):
     objects: List[str]
-    max_depth: int
+    maxDepth: int
     name: str
 
 
+@dataclass(kw_only=True)
+class LevelProxy(
+    Base,
+    speckle_type="Objects.Other.LevelProxy",
+    detachable={"objects"},
+):
+    """
+    used to store building storey to object relationships in root collections
+
+    Args:
+        objects (list): the list of application ids of objects in this building storey
+        value (DataObject): the building storey data object with all properties
+        applicationId (str): the GUID of the building storey
+    """
+
+    objects: List[str]
+    value: Base
+    applicationId: str
+
+
 @dataclass(kw_only=True)
 class RenderMaterialProxy(
     Base,

src/specklepy/serialization/base_object_serializer.py

@@ -199,8 +199,9 @@ class BaseObjectSerializer:
 
         # write detached or root objects to transports
         if detached and self.write_transports:
+            serialized_data = ujson.dumps(object_builder)
             for t in self.write_transports:
-                t.save_object(id=obj_id, serialized_object=ujson.dumps(object_builder))
+                t.save_object(id=obj_id, serialized_object=serialized_data)
 
         del self.lineage[-1]
 

src/specklepy/transports/server/batch_sender.py

@@ -7,6 +7,7 @@ import threading
 import requests
 
 from specklepy.logging.exceptions import SpeckleException
+from specklepy.transports.server.retry_policy import setup_session
 
 LOG = logging.getLogger(__name__)
 
@@ -72,10 +73,7 @@ class BatchSender:
 
     def _sending_thread_main(self):
         try:
-            session = requests.Session()
-            session.headers.update(
-                {"Authorization": f"Bearer {self._token}", "Accept": "text/plain"}
-            )
+            session = setup_session(self._token)
 
             while True:
                 batch = self._batches.get()
@@ -123,8 +121,8 @@ class BatchSender:
         upload_data = "[" + ",".join(new_objects) + "]"
         upload_data_gzip = gzip.compress(upload_data.encode())
         LOG.info(
-            "Uploading batch of {batch_size} objects {new_object_count}: ",
-            "(size: {upload_size}, compressed size: {upload_data_size})",
+            "Uploading batch of {batch_size} objects {new_object_count}: "
+            + "(size: {upload_size}, compressed size: {upload_data_size})",
             {
                 "batch_size": len(batch),
                 "new_object_count": len(new_objects),

src/specklepy/transports/server/retry_policy.py

@@ -0,0 +1,46 @@
+import requests
+from requests.adapters import HTTPAdapter
+from urllib3 import Retry
+
+
+def setup_session(auth_token: str | None) -> requests.Session:
+    """
+    Sets up a requests.Session with a basic retry policy
+    to retry on all the usual retryable status codes, with a back off policy:
+        1st: 0ms,
+        2nd: 500ms,
+        3rd: 1500ms.
+
+    Also sets "Accept": "text/plain" header (because this is what ServerTransport needs)
+    and (if a auth_token is provided) the Authorization header
+    """
+
+    session = requests.Session()
+    retry_policy = Retry(
+        total=3,
+        read=3,
+        connect=3,
+        backoff_factor=0.5,
+        status_forcelist=(500, 502, 503, 504, 520, 408, 429),
+        allowed_methods=["HEAD", "GET", "OPTIONS", "POST", "PUT", "DELETE"],
+        raise_on_status=False,
+    )
+
+    adapter = HTTPAdapter(max_retries=retry_policy)
+    session.mount("https://", adapter)
+    session.mount("http://", adapter)
+
+    session.headers.update(
+        {
+            "Accept": "text/plain",
+        }
+    )
+
+    if auth_token is not None:
+        session.headers.update(
+            {
+                "Authorization": f"Bearer {auth_token}",
+            }
+        )
+
+    return session