fix(serializer): wrap traverse_base

moving `begin` and `end_write` to the seriazlier due to the new sqlite transport with batched writes necessitates a wrapper around `traverse_base` so end/begin write can be called once at the top level. just adding begin/end write to the original traversal method would make tons of calls to `end_write` since the traversal is recursive
fix(client): don't parse obj create response
2022-06-20 11:48:45 +01:00 · 2022-06-20 11:42:18 +01:00 · 2022-06-20 11:21:09 +01:00 · 2022-06-20 11:17:32 +01:00 · 2022-06-20 07:52:58 +01:00 · 2022-06-20 07:52:27 +01:00
317 changed files with 8574 additions and 22937 deletions
@@ -1,17 +1,79 @@
 version: 2.1

-# Define the jobs we want to run for this project
-jobs:
-  build:
-    docker:
-      - image: cimg/base:2023.03
-    steps:
-      - run: echo "so long and thanks for all the fish"
+orbs:
+  python: circleci/python@2.0.3
+  codecov: codecov/codecov@3.2.2
+
+jobs:
+  test:
+    docker:
+      - image: "cimg/python:<<parameters.tag>>"
+      - image: "cimg/node:16.15"
+      - image: "cimg/redis:6.2"
+      - image: "cimg/postgres:14.2"
+        environment:
+          POSTGRES_DB: speckle2_test
+          POSTGRES_PASSWORD: speckle
+          POSTGRES_USER: speckle
+      - image: "speckle/speckle-server"
+        command: ["bash", "-c", "/wait && node bin/www"]
+        environment:
+          POSTGRES_URL: "localhost"
+          POSTGRES_USER: "speckle"
+          POSTGRES_PASSWORD: "speckle"
+          POSTGRES_DB: "speckle2_test"
+          REDIS_URL: "redis://localhost"
+          SESSION_SECRET: "keyboard cat"
+          STRATEGY_LOCAL: "true"
+          CANONICAL_URL: "http://localhost:3000"
+          WAIT_HOSTS: localhost:5432, localhost:6379
+          DISABLE_FILE_UPLOADS: "true"
+    parameters:
+      tag:
+        default: "3.8"
+        type: string
+    steps:
+      - checkout
+      - run: python --version
+      - run:
+          command: python -m pip install --upgrade pip
+          name: upgrade pip
+      - python/install-packages:
+          pkg-manager: poetry
+      - run: poetry run pytest --cov --cov-report xml:reports/coverage.xml --junitxml=reports/test-results.xml
+
+      - store_test_results:
+          path: reports
+
+      - store_artifacts:
+          path: reports
+
+      - codecov/upload
+
+  deploy:
+    docker:
+      - image: "cimg/python:3.8"
+    steps:
+      - checkout
+      - run: python patch_version.py $CIRCLE_TAG
+      - run: poetry build
+      - run: poetry publish -u specklesystems -p $PYPI_PASSWORD

-# Orchestrate our job run sequence
 workflows:
-  build_and_test:
-    when:
-      false
+  main:
    jobs:
-      - build
+      - test:
+          matrix:
+            parameters:
+              tag: ["3.6", "3.7", "3.8", "3.9"]
+          filters:
+            tags:
+              only: /.*/
+      - deploy:
+          requires:
+            - test
+          filters:
+            tags:
+              only: /[0-9]+(\.[0-9]+)*/
+            branches:
+              ignore: /.*/ # For testing only! /ci\/.*/
@@ -0,0 +1,27 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.191.1/containers/python-3/.devcontainer/base.Dockerfile
+
+# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6
+ARG VARIANT="3.9"
+FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image.
+# COPY requirements.txt /tmp/pip-tmp/
+# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \
+#    && rm -rf /tmp/pip-tmp
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1
+
+USER vscode
+
+RUN curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
+
+ENV PATH=$PATH:$HOME/.poetry/env
@@ -0,0 +1,52 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.191.1/containers/python-3
+{
+	"name": "Python 3",
+	// "build": {
+	// 	"dockerfile": "Dockerfile",
+	// 	"context": "..",
+	// 	"args": {
+	// 		// Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9
+	// 		"VARIANT": "3.6",
+	// 		// Options
+	// 		"NODE_VERSION": "lts/*"
+	// 	}
+	// },
+	"dockerComposeFile": "./docker-compose.yaml",
+	"service": "specklepy",
+	"workspaceFolder": "/workspaces/specklepy",
+	"shutdownAction": "stopCompose",
+	// Set *default* container specific settings.json values on container create.
+	"settings": {
+		"python.pythonPath": "/usr/local/bin/python",
+		"python.languageServer": "Pylance",
+		"python.linting.enabled": true,
+		"python.linting.pylintEnabled": true,
+		"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+		"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+		"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+		"python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+		"python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+		"python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+		"python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+		"python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+		"python.linting.pylintPath": "/usr/local/py-utils/bin/pylint",
+		"python.testing.pytestArgs": [
+			"tests/",
+			"-s"
+		],
+		"python.testing.pytestEnabled": true,
+		"editor.formatOnSave": true,
+	},
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"ms-python.python",
+		"ms-python.vscode-pylance"
+	],
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "poetry config virtualenvs.create false && poetry install",
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+}
@@ -0,0 +1,50 @@
+version: "3.3"  # optional since v1.27.0
+services:
+  postgres:
+    image: cimg/postgres:14.2
+    environment:
+      POSTGRES_DB: speckle2_test
+      POSTGRES_PASSWORD: speckle
+      POSTGRES_USER: speckle
+      # ports:
+      #   - "5432:5432"
+    network_mode: host
+  redis:
+    image: cimg/redis:6.2
+    # ports:
+    #   - "6379:6379"
+    network_mode: host
+  speckle-server:
+    image: speckle/speckle-server
+    command: ["bash", "-c", "/wait && node bin/www"]
+    environment:
+      POSTGRES_URL: "localhost"
+      POSTGRES_USER: "speckle"
+      POSTGRES_PASSWORD: "speckle"
+      POSTGRES_DB: "speckle2_test"
+      REDIS_URL: "redis://localhost"
+      SESSION_SECRET: "keyboard cat"
+      STRATEGY_LOCAL: "true"
+      CANONICAL_URL: "http://localhost:3000"
+      WAIT_HOSTS: localhost:5432, localhost:6379
+      DISABLE_FILE_UPLOADS: "true"
+    # ports:
+    #   - "3000:3000"
+    network_mode: host
+
+  specklepy:
+    build:
+      dockerfile: Dockerfile
+      context: .
+      args:
+        VARIANT: 3.9
+        NODE_VERSION: lts/*
+    volumes:
+      # Mounts the project folder to '/workspace'. While this file is in .devcontainer,
+      # mounts are relative to the first file in the list, which is a level up.
+      - ..:/workspaces/specklepy:cached
+    # Overrides default command so things don't shut down after the process ends.
+    command: /bin/sh -c "while sleep 1000; do :; done"
+    network_mode: host
+# networks:
+#     default:
@@ -1,3 +1,3 @@
 * text=auto eol=lf
 *.{cmd,[cC][mM][dD]} text eol=crlf
-*.{bat,[bB][aA][tT]} text eol=crlf
+*.{bat,[bB][aA][tT]} text eol=crlf
@@ -0,0 +1,25 @@
+---
+name: New issue
+about: Create a report to help us improve
+title:
+labels:
+assignees:
+---
+
+If it's your first time here - or you forgot about them - make sure you read the [contribution guidelines](CONTRIBUTING.md), and then feel free to delete this line!
+
+### Expected vs. Actual Behavior
+
+Describe the problem here.
+
+### Reproduction Steps & System Config (win, osx, web, etc.)
+
+Let us know how we can reproduce this, and attach relevant files (if any).
+
+### Proposed Solution (if any)
+
+Let us know what how you would solve this.
+
+#### Optional: Affected Projects
+
+Does this issue propagate to other dependencies or dependents? If so, list them here!
@@ -1,113 +0,0 @@
---
-name: Bug report
-about: Help improve Speckle!
-title: ''
-labels: bug
-assignees: ''
---
-
-<!---
-
-Provide a short summary in the Title above. Examples of good Issue titles:
-
-* "Bug: Error from server when reticulating splines"
-* "Bug: Revit crashes when installing connector"
-
-->
-
-## Prerequisites
-
-<!---
-
-Please answer the following questions before submitting an issue.
-
-->
-
- [ ] I read the [contribution guidelines](https://github.com/specklesystems/speckle-server/blob/main/CONTRIBUTING.md)
- [ ] I checked the [documentation](https://speckle.guide/) and found no answer.
- [ ] I checked [existing issues](../issues?q=is%3Aissue) and found no similar issue. <!-- If you do find an existing issue, please show your support by liking it :+1: instead of creating a new issue -->
- [ ] I checked the [community forum](https://speckle.community/) for related discussions and found no answer.
- [ ] I'm reporting the issue to the correct repository (see also [speckle-server](https://github.com/specklesystems/speckle-server), [speckle-sharp](https://github.com/specklesystems/speckle-sharp), [specklepy](https://github.com/specklesystems/specklepy), [speckle-docs](https://github.com/specklesystems/speckle-docs), and [others](https://github.com/orgs/specklesystems/repositories))
-
-## What package are you referring to?
-
-<!---
-Is it related to the server (backend) only, or does this bug relate to the frontend, viewer, objectloader or any other package?
-->
-
-## Describe the bug
-
-<!---
-A clear and concise description of what the bug is.
-->
-
-## To Reproduce
-
-<!---
-Steps to reproduce the behavior:
-
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-->
-
-## Expected behavior
-
-<!---
-A clear and concise description of what you expected to happen.
-->
-
-## Screenshots
-
-<!---
-If applicable, add screenshots to help explain your problem.
-->
-
-## System Info
-
-If applicable, please fill in the below details - they help a lot!
-
-### Desktop (please complete the following information):
-
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
-
-### Smartphone (please complete the following information):
-
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
-
-## Failure Logs
-
-<!---
-Please include any relevant log snippets or files here, or upload as a file.
-
-If including inline, please use markdown code block syntax. https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks
-For example:
-
-```
-your log output here
-```
-->
-
-## Additional context
-
-<!---
-Add any other context about the problem here.
-->
-
-## Proposed Solution (if any)
-
-<!---
-Let us know what how you would solve this.
-->
-
-#### Optional: Affected Projects
-
-<!---
-Does this issue propagate to other dependencies or dependents? If so, list them here with links!
-->
@@ -1,71 +0,0 @@
---
-name: Feature request
-about: Suggest an idea for Speckle!
-title: ''
-labels: enhancement, question
-assignees: ''
---
-
-<!---
-
-Provide a short summary in the Title above. Examples of good Issue titles:
-
-* "Enhancement: Connector for Minecraft"
-* "Enhancement: Web viewer should support tesseracts"
-
-->
-
-## Prerequisites
-
-<!---
-
-Please answer the following questions before submitting an issue.
-
-->
-
- [ ] I read the [contribution guidelines](https://github.com/specklesystems/speckle-server/blob/main/CONTRIBUTING.md)
- [ ] I checked the [documentation](https://speckle.guide/) and found no answer.
- [ ] I checked [existing issues](../issues?q=is%3Aissue) and found no similar issue. <!-- If you do find an existing issue, please show your support by liking it :+1: instead of creating a new issue -->
- [ ] I checked the [community forum](https://speckle.community/) for related discussions and found no answer.
- [ ] I'm requesting the feature to the correct repository (see also [speckle-server](https://github.com/specklesystems/speckle-server), [speckle-sharp](https://github.com/specklesystems/speckle-sharp), [specklepy](https://github.com/specklesystems/specklepy), [speckle-docs](https://github.com/specklesystems/speckle-docs), and [others](https://github.com/orgs/specklesystems/repositories))
-
-## What package are you referring to?
-
-<!---
-Is it related to the server (backend) only, or does this feature request relate to the frontend, viewer, objectloader or any other package?
-->
-
-## Is your feature request related to a problem? Please describe.
-
-<!---
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-->
-
-## Describe the solution you'd like
-
-<!---
-A clear and concise description of what you want to happen.
-->
-
-## Describe alternatives you've considered
-
-<!---
-A clear and concise description of any alternative solutions or features you've considered.
-->
-
-## Additional context
-
-<!---
-Add any other context or screenshots about the feature request here.
-
-Have you seen this feature implemented in any other software?  Can you provide screenshots or links to video or documentation?
-What works well about these existing features in other software?  What doesn't work well?
-->
-
-## Related issues or community discussions
-
-<!---
-Is this feature request related to (but sufficiently distinct from) any existing issues?
-Does this feature request require other features to be available beforehand?
-Has this feature been discussed in the community forum, please link here? https://speckle.community/
-->
@@ -0,0 +1,25 @@
+Description of PR...
+
+## Changes
+
+- Item 1
+- Item 2
+
+## Checklist
+
+- [ ] Unit tests
+- [ ] Documentation
+
+## References
+
+(optional)
+
+Include **important** links regarding the implementation of this PR.
+This usually includes and RFC or an aggregation of issues and/or individual conversations
+that helped put this solution together. This helps ensure there is a good aggregation
+of resources regarding the implementation.
+
+```text
+Fixes #85, Fixes #22, Fixes username/repo#123
+Connects #123
+```
@@ -1,102 +0,0 @@
-<!---
-
-Provide a short summary in the Title above. Examples of good PR titles:
-
-* "Feature: adds metrics to component"
-
-* "Fix: resolves duplication in comment thread"
-
-* "Update: apollo v2.34.0"
-
-->
-
-## Description & motivation
-
-<!---
-
-Describe your changes, and why you're making them.  What benefit will this have to others?
-
-Is this linked to an open Github issue, a thread in Speckle community,
-or another pull request? Link it here.
-
-If it is related to a Github issue, and resolves it, please link to the issue number, e.g.:
-Fixes #85, Fixes #22, Fixes username/repo#123
-Connects #123
-
-->
-
-## Changes:
-
-<!---
-
- Item 1
- Item 2
-
-->
-
-## To-do before merge:
-
-<!---
-
-(Optional -- remove this section if not needed)
-
-Include any notes about things that need to happen before this PR is merged, e.g.:
-
- [ ] Change the base branch
-
- [ ] Ensure PR #56 is merged
-
-->
-
-## Screenshots:
-
-<!---
-
-Include a screenshot the before and after.  This can be a screenshot of a plugin, web frontend, or output in a terminal.
-
-->
-
-## Validation of changes:
-
-<!---
-
-Describe what tests have been added or amended, and why these demonstrate it works and will prevent this feature being accidentally broken by future changes.
-
-->
-
-## Checklist:
-
-<!---
-
-This checklist is mostly useful as a reminder of small things that can easily be
-
-forgotten – it is meant as a helpful tool rather than hoops to jump through.
-
-Put an `x` between the square brackets, e.g. [x], for all the items that apply,
-
-make notes next to any that haven't been addressed, and remove any items that are not relevant to this PR.
-
-->
-
- [ ] My pull request follows the guidelines in the [Contributing guide](https://github.com/specklesystems/speckle-server/blob/main/CONTRIBUTING.md)?
- [ ] My pull request does not duplicate any other open [Pull Requests](../../pulls) for the same update/change?
- [ ] My commits are related to the pull request and do not amend unrelated code or documentation.
- [ ] My code follows a similar style to existing code.
- [ ] I have added appropriate tests.
- [ ] I have updated or added relevant documentation.
-
-## References
-
-<!---
-
-(Optional -- remove this section if not needed )
-
-Include **important** links regarding the implementation of this PR.
-
-This usually includes a RFC or an aggregation of issues and/or individual conversations
-
-that helped put this solution together. This helps ensure we retain and share knowledge
-
-regarding the implementation, and may help others understand motivation and design decisions etc..
-
-->
@@ -0,0 +1,78 @@
+name: Update issue Status
+
+on:
+  issues:
+    types: [closed]
+
+jobs:
+  update_issue:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get project data
+        env:
+          GITHUB_TOKEN: ${{secrets.GHPROJECT_TOKEN}}
+          ORGANIZATION: specklesystems
+          PROJECT_NUMBER: 9
+        run: |
+          gh api graphql --header 'GraphQL-Features: projects_next_graphql' -f query='
+            query($org: String!, $number: Int!) {
+              organization(login: $org){
+                projectNext(number: $number) {
+                  id
+                  fields(first:20) {
+                    nodes {
+                      id
+                      name
+                      settings
+                    }
+                  }
+                }
+              }
+            }' -f org=$ORGANIZATION -F number=$PROJECT_NUMBER > project_data.json
+
+          echo 'PROJECT_ID='$(jq '.data.organization.projectNext.id' project_data.json) >> $GITHUB_ENV
+          echo 'STATUS_FIELD_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Status") | .id' project_data.json) >> $GITHUB_ENV
+          
+          echo "$PROJECT_ID"
+          echo "$STATUS_FIELD_ID"
+          
+          echo 'DONE_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Status") | .settings | fromjson | .options[] | select(.name== "Done") | .id' project_data.json) >> $GITHUB_ENV
+          echo "$DONE_ID"
+
+      - name: Add Issue to project #it's already in the project, but we do this to get its node id!
+        env:
+          GITHUB_TOKEN: ${{secrets.GHPROJECT_TOKEN}}
+          ISSUE_ID: ${{ github.event.issue.node_id }}
+        run: |
+          item_id="$( gh api graphql --header 'GraphQL-Features: projects_next_graphql' -f query='
+            mutation($project:ID!, $id:ID!) {
+              addProjectNextItem(input: {projectId: $project, contentId: $id}) {
+                projectNextItem {
+                  id
+                }
+              }
+            }' -f project=$PROJECT_ID -f id=$ISSUE_ID --jq '.data.addProjectNextItem.projectNextItem.id')"
+          
+          echo 'ITEM_ID='$item_id >> $GITHUB_ENV
+          
+      - name: Update Status
+        env:
+          GITHUB_TOKEN: ${{secrets.GHPROJECT_TOKEN}}
+          ISSUE_ID: ${{ github.event.issue.node_id }}
+        run: |
+          gh api graphql --header 'GraphQL-Features: projects_next_graphql' -f query='
+            mutation($project:ID!, $status:ID!, $id:ID!, $value:String!) {
+              set_status: updateProjectNextItemField(
+                input: {
+                  projectId: $project
+                  itemId: $id
+                  fieldId: $status
+                  value: $value
+                }
+              ) {
+                projectNextItem {
+                  id
+                }
+              }
+            }' -f project=$PROJECT_ID -f status=$STATUS_FIELD_ID -f id=$ITEM_ID -f value=${{ env.DONE_ID }}
+          
@@ -0,0 +1,50 @@
+name: Move new issues into Project
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  track_issue:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get project data
+        env:
+          GITHUB_TOKEN: ${{secrets.GHPROJECT_TOKEN}}
+          ORGANIZATION: specklesystems
+          PROJECT_NUMBER: 9
+        run: |
+          gh api graphql --header 'GraphQL-Features: projects_next_graphql' -f query='
+            query($org: String!, $number: Int!) {
+              organization(login: $org){
+                projectNext(number: $number) {
+                  id
+                  fields(first:20) {
+                    nodes {
+                      id
+                      name
+                      settings
+                    }
+                  }
+                }
+              }
+            }' -f org=$ORGANIZATION -F number=$PROJECT_NUMBER > project_data.json
+
+          echo 'PROJECT_ID='$(jq '.data.organization.projectNext.id' project_data.json) >> $GITHUB_ENV
+          echo 'STATUS_FIELD_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Status") | .id' project_data.json) >> $GITHUB_ENV
+     
+      - name: Add Issue to project
+        env:
+          GITHUB_TOKEN: ${{secrets.GHPROJECT_TOKEN}}
+          ISSUE_ID: ${{ github.event.issue.node_id }}
+        run: |
+          item_id="$( gh api graphql --header 'GraphQL-Features: projects_next_graphql' -f query='
+            mutation($project:ID!, $id:ID!) {
+              addProjectNextItem(input: {projectId: $project, contentId: $id}) {
+                projectNextItem {
+                  id
+                }
+              }
+            }' -f project=$PROJECT_ID -f id=$ISSUE_ID --jq '.data.addProjectNextItem.projectNextItem.id')"
+          
+          echo 'ITEM_ID='$item_id >> $GITHUB_ENV
@@ -1,100 +0,0 @@
-name: "Specklepy test"
-on:
-  workflow_call:
-    secrets:
-      CODECOV_TOKEN:
-        required: true
-  pull_request:
-    branches:
-      - "main"
-
-jobs:
-  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
-    env:
-      IS_PUBLIC: "true"
-    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
-
-      - uses: actions/cache@v3
-        with:
-          path: ~/.cache/pre-commit/
-          key: ${{ hashFiles('.pre-commit-config.yaml') }}
-
-      - name: Run pre-commit
-        run: uv run pre-commit run --all-files
-
-      - name: Run Speckle Server
-        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
-
-      - name: Minimize uv cache
-        run: uv cache prune --ci
@@ -1,55 +0,0 @@
-name: "Publish Python Package"
-on:
-  push:
-    branches:
-      - "main"
-    tags:
-      - "3.*.*"
-
-jobs:
-  test:
-    uses: "./.github/workflows/pr.yml"
-    secrets:
-      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-
-  publish-package:
-    name: "Build and Publish Python Package"
-    runs-on: ubuntu-latest
-    needs: test
-
-    # set the environment based on what triggered the workflow
-    environment:
-      name: ${{ github.ref_type == 'tag' && 'pypi' || 'testpypi' }}
-
-    permissions:
-      id-token: write
-
-    steps:
-      - name: "Install uv"
-        uses: astral-sh/setup-uv@v5
-
-      - name: "Checkout code"
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: "Build package artifacts"
-        run: uv build
-
-      # Logic for TestPyPI (on main branch push)
-      - name: "Publish to TestPyPI"
-        if: ${{ github.ref_type == 'branch' }}
-        run: uv publish --index test
-
-      - name: "Verify TestPyPI package installation"
-        if: ${{ github.ref_type == 'branch' }}
-        run: uv run --index test --with specklepy --no-project -- python -c "import specklepy"
-
-      # Logic for PyPI (on v3* tag creation)
-      - name: "Publish to PyPI"
-        if: ${{ github.ref_type == 'tag' }}
-        run: uv publish
-
-      - name: "Verify PyPI package installation"
-        if: ${{ github.ref_type == 'tag' }}
-        run: uv run --with specklepy --no-project -- python -c "import specklepy"
@@ -2,8 +2,6 @@
 .envrc
 reports/

-.volumes/
-
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -114,4 +112,4 @@ venv.bak/

 # other
 scratch.py
-settings.json
+settings.json
@@ -1,31 +0,0 @@
-repos:
-  - repo: local
-    hooks:
-      # Run the linter.
-      - id: ruff
-        name: ruff lint
-        entry: uv run ruff check --force-exclude
-        language: system
-        types_or: [python, pyi]
-      # Run the formatter.
-      - id: ruff-format
-        name: ruff format
-        entry: uv run ruff format --force-exclude
-        language: system
-        types_or: [python, pyi]
-
-
-  - repo: https://github.com/commitizen-tools/commitizen
-    hooks:
-      - id: commitizen
-      - id: commitizen-branch
-        stages:
-          - pre-push
-    rev: v3.13.0
-
-
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
-    hooks:
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
@@ -1,6 +0,0 @@
-{
-    "recommendations": [
-        "ms-python.python",
-        "charliermarsh.ruff"
-    ]
-}
@@ -4,9 +4,10 @@
  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
  "version": "0.2.0",
  "configurations": [
+    
    {
      "name": "Python: Current File",
-      "type": "debugpy",
+      "type": "python",
      "request": "launch",
      "program": "${file}",
      "console": "integratedTerminal",
@@ -14,12 +15,12 @@
    },
    {
      "name": "Pytest",
-      "type": "debugpy",
+      "type": "python",
      "request": "launch",
-      "module": "pytest",
-      "args": [],
+      "program": "poetry",
+      "args": ["run", "pytest"],
      "console": "integratedTerminal",
      "justMyCode": true
    }
  ]
-}
+}
@@ -2,26 +2,52 @@
  <img src="https://user-images.githubusercontent.com/2679513/131189167-18ea5fe1-c578-47f6-9785-3748178e4312.png" width="150px"/><br/>
  Speckle | specklepy 🐍
 </h1>
-
-<p align="center"><a href="https://twitter.com/SpeckleSystems"><img src="https://img.shields.io/twitter/follow/SpeckleSystems?style=social" alt="Twitter Follow"></a> <a href="https://speckle.community"><img src="https://img.shields.io/discourse/users?server=https%3A%2F%2Fspeckle.community&amp;style=flat-square&amp;logo=discourse&amp;logoColor=white" alt="Community forum users"></a> <a href="https://speckle.systems"><img src="https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square" alt="website"></a> <a href="https://speckle.guide/dev/"><img src="https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&amp;logo=read-the-docs&amp;logoColor=white" alt="docs"></a></p>
-
-> Speckle is the first AEC data hub that connects with your favorite AEC tools. Speckle exists to overcome the challenges of working in a fragmented industry where communication, creative workflows, and the exchange of data are often hindered by siloed software and processes. It is here to make the industry better.
-
 <h3 align="center">
    The Python SDK
 </h3>
+<p align="center"><b>Speckle</b> is the data infrastructure for the AEC industry.</p><br/>
+
+<p align="center"><a href="https://twitter.com/SpeckleSystems"><img src="https://img.shields.io/twitter/follow/SpeckleSystems?style=social" alt="Twitter Follow"></a> <a href="https://speckle.community"><img src="https://img.shields.io/discourse/users?server=https%3A%2F%2Fspeckle.community&amp;style=flat-square&amp;logo=discourse&amp;logoColor=white" alt="Community forum users"></a> <a href="https://speckle.systems"><img src="https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square" alt="website"></a> <a href="https://speckle.guide/dev/"><img src="https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&amp;logo=read-the-docs&amp;logoColor=white" alt="docs"></a></p>
+<p align="center"><a href="https://github.com/specklesystems/specklepy/"><img src="https://circleci.com/gh/specklesystems/specklepy.svg?style=svg&amp;circle-token=76eabd350ea243575cbb258b746ed3f471f7ac29" alt="Speckle-Next"></a><a href="https://codecov.io/gh/specklesystems/specklepy">
+  <img src="https://codecov.io/gh/specklesystems/specklepy/branch/main/graph/badge.svg?token=8KQFL5N0YF"/>
+</a> </p>
+
+# About Speckle
+
+What is Speckle? Check our ![YouTube Video Views](https://img.shields.io/youtube/views/B9humiSpHzM?label=Speckle%20in%201%20minute%20video&style=social)
+
+### Features
+
+- **Object-based:** say goodbye to files! Speckle is the first object based platform for the AEC industry
+- **Version control:** Speckle is the Git & Hub for geometry and BIM data
+- **Collaboration:** share your designs collaborate with others
+- **3D Viewer:** see your CAD and BIM models online, share and embed them anywhere
+- **Interoperability:** get your CAD and BIM models into other software without exporting or importing
+- **Real time:** get real time updates and notifications and changes
+- **GraphQL API:** get what you need anywhere you want it
+- **Webhooks:** the base for a automation and next-gen pipelines
+- **Built for developers:** we are building Speckle with developers in mind and got tools for every stack
+- **Built for the AEC industry:** Speckle connectors are plugins for the most common software used in the industry such as Revit, Rhino, Grasshopper, AutoCAD, Civil 3D, Excel, Unreal Engine, Unity, QGIS, Blender and more!
+
+### Try Speckle now!
+
+Give Speckle a try in no time by:
+
+- [![speckle XYZ](https://img.shields.io/badge/https://-speckle.xyz-0069ff?style=flat-square&logo=hackthebox&logoColor=white)](https://speckle.xyz) ⇒ creating an account at our public server
+- [![create a droplet](https://img.shields.io/badge/Create%20a%20Droplet-0069ff?style=flat-square&logo=digitalocean&logoColor=white)](https://marketplace.digitalocean.com/apps/speckle-server?refcode=947a2b5d7dc1) ⇒ deploying an instance in 1 click 
+
+### Resources
+
+- [![Community forum users](https://img.shields.io/badge/community-forum-green?style=for-the-badge&logo=discourse&logoColor=white)](https://speckle.community) for help, feature requests or just to hang with other speckle enthusiasts, check out our community forum!
+- [![website](https://img.shields.io/badge/tutorials-speckle.systems-royalblue?style=for-the-badge&logo=youtube)](https://speckle.systems) our tutorials portal is full of resources to get you started using Speckle
+- [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=for-the-badge&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) reference on almost any end-user and developer functionality

-<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

 ## Usage

-Send and receive data from a Speckle Server with `operations`, interact with the Speckle API with the `SpeckleClient`, create and extend your own custom Speckle Objects with `Base`, and more!
+Send and receive data from a Speckle Server with `operations`, interact with the Speckle API with the `SpeckleClient`, create and extend your own custom Speckle Objects with `Base`, and more! 

 Head to the [**📚 specklepy docs**](https://speckle.guide/dev/python.html) for more information and usage examples.

@@ -29,32 +55,26 @@ Head to the [**📚 specklepy docs**](https://speckle.guide/dev/python.html) for

 ### Installation

-This project uses uv for dependency management, make sure you follow the official [docs](https://docs.astral.sh/uv/) to get it.
+This project uses python-poetry for dependency management, make sure you follow the official [docs](https://python-poetry.org/docs/#installation) to get poetry.

-To create a new virtual environment with uv run `$ uv venv` and follow the instructions on the screen to activate the virtual environment.
-To bootstrap the project environment run `$ uv sync`. This will install both the package and dev dependencies.
+To bootstrap the project environment run `$ poetry install`. This will create a new virtual-env for the project and install both the package and dev dependencies.

-To execute any python script run `$ uv run python my_script.py`
+If this is your first time using poetry and you're used to creating your venvs within the project directory, run `poetry config virtualenvs.in-project true` to configure poetry to do the same.

-> Alternatively you may roll your own virtual-env with either venv, virtualenv, pyenv-virtualenv etc. Uv will play along an recognize if it is invoked from inside a virtual environment.
+To execute any python script run `$ poetry run python my_script.py`

-### Style guide
-
-All our repo wide styling linting and other rules are checked and enforced by `pre-commit`, which is included in the dev dependencies.
-It is recommended to set up `pre-commit` after installing the dependencies by running `$ pre-commit install`.
-Commiting code that doesn't adhere to the given rules, will fail the checks in our CI system.
+> Alternatively you may roll your own virtual-env with either venv, virtualenv, pyenv-virtualenv etc. Poetry will play along an recognize if it is invoked from inside a virtual environment.

 ### 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`

 ## Contributing

-Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md) and [code of conduct](.github/CODE_OF_CONDUCT.md) for an overview of the practices we try to follow.
+Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md) for an overview of the best practices we try to follow.

 ## Community

@@ -62,7 +82,7 @@ The Speckle Community hangs out on [the forum](https://discourse.speckle.works),

 ## Security

-For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems.
+For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems. 

 ## License

@@ -1,12 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 2.2.+   | :white_check_mark: |
-| < 2.2   | :x:                |
-
-## Reporting a Vulnerability
-
-Hi! If you've found something off, we'd be more than happy if you would report it via security@speckle.systems. We will work together with you to correctly identify the cause and implement a fix. Thanks for helping make Speckle safer!
@@ -1 +0,0 @@
-words = ["specklepy"]
@@ -1,115 +0,0 @@
-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://speckle:speckle@postgres:5432/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:
@@ -1,118 +0,0 @@
-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: speckle/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:
@@ -1,50 +0,0 @@
-# specklepy API Reference
-
-> The Python SDK for Speckle - Build powerful AEC data workflows
-
-**specklepy** is the Python SDK for Speckle, enabling you to interact with Speckle Server, send and receive geometry, and build custom integrations for the AEC industry.
-
-## What is specklepy?
-
-specklepy is a comprehensive Python library that provides:
-
-* **Object-based data exchange** - Send and receive geometry and BIM data without files
-* **GraphQL API client** - Full access to Speckle Server's API
-* **Extensible object model** - Create custom objects that inherit from `Base`
-* **Multiple transport options** - Store data locally (SQLite), in-memory, or on Speckle Server
-* **Geometry support** - Rich geometric primitives (Point, Line, Mesh, etc.)
-
-## Speckle Automate
-
-Speckle Automate is a fully fledged CI/CD platform designed to run custom code on Speckle models whenever a new version is available.
-
-As a software developer, you can develop Functions that others in your team consume in Automations. From creating reports to running code compliance checks to wind simulations, there is no limit to what you can do with Automate.
-
-## Installation
-
-Install specklepy using pip:
-
-```bash
-pip install specklepy
-```
-
-## Quick Example
-
-```python
-from specklepy.api.client import SpeckleClient
-from specklepy.api.credentials import get_default_account
-from specklepy.objects.geometry import Point
-
-# Authenticate
-client = SpeckleClient(host="https://app.speckle.systems")
-account = get_default_account()
-client.authenticate_with_account(account)
-
-# Create geometry
-point = Point(x=10, y=20, z=5)
-```
-
-## Getting Help
-
- **Community Forum**: [speckle.community](https://speckle.community/c/help/developers)
- **GitHub Issues**: [github.com/specklesystems/specklepy](https://github.com/specklesystems/specklepy/issues)
@@ -1 +0,0 @@
-::: speckle_automate.AutomationContext
@@ -1,3 +0,0 @@
-::: speckle_automate.runner.execute_automate_function
-
-::: speckle_automate.runner.run_function
@@ -1,11 +0,0 @@
-::: speckle_automate.AutomateBase
-
-::: speckle_automate.AutomationRunData
-
-::: speckle_automate.AutomationResult
-
-::: speckle_automate.ResultCase
-
-::: speckle_automate.AutomationStatus
-
-::: speckle_automate.ObjectResultLevel
@@ -1 +0,0 @@
-::: specklepy.api.client.SpeckleClient
@@ -1,5 +0,0 @@
-::: specklepy.api.credentials.Account
-
-::: specklepy.api.credentials.UserInfo
-
-::: specklepy.api.credentials.StreamWrapper
@@ -1,7 +0,0 @@
-::: specklepy.api.operations.send
-
-::: specklepy.api.operations.receive
-
-::: specklepy.api.operations.serialize
-
-::: specklepy.api.operations.deserialize
@@ -1 +0,0 @@
-::: specklepy.api.resources.ActiveUserResource
@@ -1 +0,0 @@
-::: specklepy.api.resources.FileImportResource
@@ -1 +0,0 @@
-::: specklepy.api.resources.ModelResource
@@ -1 +0,0 @@
-::: specklepy.api.resources.OtherUserResource
@@ -1 +0,0 @@
-::: specklepy.api.resources.ProjectInviteResource
@@ -1 +0,0 @@
-::: specklepy.api.resources.ProjectResource
@@ -1 +0,0 @@
-::: specklepy.api.resources.ServerResource
@@ -1 +0,0 @@
-::: specklepy.api.resources.SubscriptionResource
@@ -1 +0,0 @@
-::: specklepy.api.resources.VersionResource
@@ -1 +0,0 @@
-::: specklepy.api.resources.WorkspaceResource
@@ -1 +0,0 @@
-::: specklepy.core.api.enums.ProjectVisibility
@@ -1,11 +0,0 @@
-::: specklepy.core.api.inputs.ProjectCreateInput
-
-::: specklepy.core.api.inputs.ProjectUpdateInput
-
-::: specklepy.core.api.inputs.CreateModelInput
-
-::: specklepy.core.api.inputs.UpdateModelInput
-
-::: specklepy.core.api.inputs.CreateVersionInput
-
-::: specklepy.core.api.inputs.UpdateVersionInput
@@ -1,13 +0,0 @@
-::: specklepy.core.api.models.User
-
-::: specklepy.core.api.models.LimitedUser
-
-::: specklepy.core.api.models.ServerInfo
-
-::: specklepy.core.api.models.Project
-
-::: specklepy.core.api.models.Model
-
-::: specklepy.core.api.models.Version
-
-::: specklepy.core.api.models.current.Workspace
@@ -1,7 +0,0 @@
-::: specklepy.logging.exceptions.SpeckleException
-
-::: specklepy.logging.exceptions.GraphQLException
-
-::: specklepy.logging.exceptions.SerializationException
-
-::: specklepy.logging.exceptions.SpeckleWarning
@@ -1,3 +0,0 @@
-::: specklepy.objects.Base
-
-::: specklepy.objects.base.DataChunk
@@ -1,5 +0,0 @@
-::: specklepy.objects.DataObject
-
-::: specklepy.objects.QgisObject
-
-::: specklepy.objects.BlenderObject
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.Arc
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.Box
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.Circle
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.ControlPoint
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.Curve
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.Ellipse
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.Line
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.Mesh
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.Plane
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.Point
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.PointCloud
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.Polycurve
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.Polyline
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.Spiral
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.Surface
@@ -1 +0,0 @@
-::: specklepy.objects.geometry.Vector
@@ -1,7 +0,0 @@
-::: specklepy.objects.graph_traversal.GraphTraversal
-
-::: specklepy.objects.graph_traversal.TraversalContext
-
-::: specklepy.objects.graph_traversal.TraversalRule
-
-::: specklepy.objects.graph_traversal.DefaultRule
@@ -1 +0,0 @@
-::: specklepy.objects.models.collections.collection.Collection
@@ -1 +0,0 @@
-::: specklepy.objects.other.RenderMaterial
@@ -1 +0,0 @@
-::: specklepy.objects.primitive.Interval
@@ -1 +0,0 @@
-::: specklepy.objects.proxies.ColorProxy
@@ -1 +0,0 @@
-::: specklepy.objects.proxies.GroupProxy
@@ -1 +0,0 @@
-::: specklepy.objects.proxies.InstanceDefinitionProxy
@@ -1 +0,0 @@
-::: specklepy.objects.proxies.InstanceProxy
@@ -1 +0,0 @@
-::: specklepy.objects.proxies.LevelProxy
@@ -1 +0,0 @@
-::: specklepy.objects.proxies.RenderMaterialProxy
@@ -1 +0,0 @@
-::: specklepy.serialization.base_object_serializer.BaseObjectSerializer
@@ -1,7 +0,0 @@
-::: specklepy.transports.abstract_transport.AbstractTransport
-
-::: specklepy.transports.memory.MemoryTransport
-
-::: specklepy.transports.sqlite.SQLiteTransport
-
-::: specklepy.transports.server.ServerTransport
@@ -1,304 +0,0 @@
-.md-content h1 {
-    font-size: 1.125rem;
-    font-weight: 700;
-    color: #111827;
-    letter-spacing: -0.025em;
-    line-height: 1.2;
-}
-
-@media (min-width: 640px) {
-    .md-content h1 {
-        font-size: 1.25rem;
-    }
-}
-
-[data-md-color-scheme="slate"] .md-content h1 {
-    color: #e5e7eb;
-}
-
-.md-content h2 {
-    font-size: 1rem;
-    font-weight: 700;
-    color: #111827;
-    letter-spacing: -0.025em;
-    margin-top: 2rem;
-}
-
-@media (min-width: 640px) {
-    .md-content h2 {
-        font-size: 1.125rem;
-    }
-}
-
-[data-md-color-scheme="slate"] .md-content h2 {
-    color: #e5e7eb;
-}
-
-.md-content h3 {
-    font-size: 0.9375rem;
-    font-weight: 600;
-    color: #1f2937;
-    margin-top: 1.5rem;
-}
-
-@media (min-width: 640px) {
-    .md-content h3 {
-        font-size: 1rem;
-    }
-}
-
-[data-md-color-scheme="slate"] .md-content h3 {
-    color: #d1d5db;
-}
-
-.md-content p,
-.md-content li {
-    font-size: 0.875rem;
-    line-height: 1.6;
-    color: #374151;
-    margin-top: 0.5rem;
-}
-
-[data-md-color-scheme="slate"] .md-content p,
-[data-md-color-scheme="slate"] .md-content li {
-    color: #d1d5db;
-}
-
-.doc.doc-object-name {
-    font-size: 1.125rem;
-    font-weight: 700;
-    color: #111827;
-}
-
-[data-md-color-scheme="slate"] .doc.doc-object-name {
-    color: #e5e7eb;
-}
-
-.doc.doc-heading {
-    font-size: 0.9375rem;
-    font-weight: 600;
-    color: #1f2937;
-}
-
-[data-md-color-scheme="slate"] .doc.doc-heading {
-    color: #d1d5db;
-}
-
-.md-content code {
-    font-size: 0.75rem;
-    color: #dc2626;
-    background-color: #f3f4f6;
-    padding: 0.125rem 0.375rem;
-    border-radius: 0.25rem;
-}
-
-[data-md-color-scheme="slate"] .md-content code {
-    color: #fca5a5;
-    background-color: #1f2937;
-}
-
-.md-content pre code {
-    font-size: 0.75rem;
-    color: inherit;
-    background-color: transparent;
-    padding: 0;
-}
-
-.md-content a {
-    color: #2563eb;
-    text-decoration: none;
-}
-
-.md-content a:hover {
-    color: #1d4ed8;
-    text-decoration: underline;
-}
-
-[data-md-color-scheme="slate"] .md-content a {
-    color: #60a5fa;
-}
-
-[data-md-color-scheme="slate"] .md-content a:hover {
-    color: #93c5fd;
-}
-
-[data-md-color-scheme="slate"] {
-    --md-default-bg-color: #000000;
-    --md-default-fg-color: #ffffff;
-    --md-code-bg-color: #0a0a0a;
-    --md-code-fg-color: #ffffff;
-}
-
-[data-md-color-scheme="slate"] .md-header {
-    background-color: #000000;
-}
-
-[data-md-color-scheme="slate"] .md-tabs {
-    background-color: #000000;
-}
-
-[data-md-color-scheme="slate"] .md-footer {
-    background-color: #000000;
-}
-
-[data-md-color-scheme="slate"] .md-sidebar {
-    background-color: #000000;
-}
-
-[data-md-color-scheme="slate"] .md-nav {
-    background-color: #000000;
-}
-
-.highlight pre,
-.highlight code {
-    background-color: #f6f8fa !important;
-    color: #24292e !important;
-}
-
-.highlight .k,
-.highlight .kc,
-.highlight .kd,
-.highlight .kn,
-.highlight .kp,
-.highlight .kr,
-.highlight .kt {
-    color: #d73a49 !important;
-}
-
-.highlight .s,
-.highlight .s1,
-.highlight .s2,
-.highlight .sb,
-.highlight .sc,
-.highlight .sd,
-.highlight .se,
-.highlight .sh,
-.highlight .si,
-.highlight .sx,
-.highlight .sr,
-.highlight .ss {
-    color: #032f62 !important;
-}
-
-.highlight .nf,
-.highlight .fm,
-.highlight .nc {
-    color: #6f42c1 !important;
-}
-
-.highlight .m,
-.highlight .mf,
-.highlight .mh,
-.highlight .mi,
-.highlight .mo {
-    color: #005cc5 !important;
-}
-
-.highlight .c,
-.highlight .c1,
-.highlight .cm,
-.highlight .cp,
-.highlight .cs {
-    color: #6a737d !important;
-    font-style: italic;
-}
-
-.highlight .o,
-.highlight .ow {
-    color: #d73a49 !important;
-}
-
-.highlight .n,
-.highlight .na,
-.highlight .nb,
-.highlight .nd,
-.highlight .ni,
-.highlight .nl,
-.highlight .nn,
-.highlight .nx,
-.highlight .py,
-.highlight .nt,
-.highlight .nv,
-.highlight .bp,
-.highlight .vc,
-.highlight .vg,
-.highlight .vi {
-    color: #e36209 !important;
-}
-
-[data-md-color-scheme="slate"] .highlight pre,
-[data-md-color-scheme="slate"] .highlight code {
-    background-color: #0d1117 !important;
-    color: #e6edf3 !important;
-}
-
-[data-md-color-scheme="slate"] .highlight .k,
-[data-md-color-scheme="slate"] .highlight .kc,
-[data-md-color-scheme="slate"] .highlight .kd,
-[data-md-color-scheme="slate"] .highlight .kn,
-[data-md-color-scheme="slate"] .highlight .kp,
-[data-md-color-scheme="slate"] .highlight .kr,
-[data-md-color-scheme="slate"] .highlight .kt {
-    color: #ff7b72 !important;
-}
-
-[data-md-color-scheme="slate"] .highlight .s,
-[data-md-color-scheme="slate"] .highlight .s1,
-[data-md-color-scheme="slate"] .highlight .s2,
-[data-md-color-scheme="slate"] .highlight .sb,
-[data-md-color-scheme="slate"] .highlight .sc,
-[data-md-color-scheme="slate"] .highlight .sd,
-[data-md-color-scheme="slate"] .highlight .se,
-[data-md-color-scheme="slate"] .highlight .sh,
-[data-md-color-scheme="slate"] .highlight .si,
-[data-md-color-scheme="slate"] .highlight .sx,
-[data-md-color-scheme="slate"] .highlight .sr,
-[data-md-color-scheme="slate"] .highlight .ss {
-    color: #a5d6ff !important;
-}
-
-[data-md-color-scheme="slate"] .highlight .nf,
-[data-md-color-scheme="slate"] .highlight .fm,
-[data-md-color-scheme="slate"] .highlight .nc {
-    color: #d2a8ff !important;
-}
-
-[data-md-color-scheme="slate"] .highlight .m,
-[data-md-color-scheme="slate"] .highlight .mf,
-[data-md-color-scheme="slate"] .highlight .mh,
-[data-md-color-scheme="slate"] .highlight .mi,
-[data-md-color-scheme="slate"] .highlight .mo {
-    color: #79c0ff !important;
-}
-
-[data-md-color-scheme="slate"] .highlight .c,
-[data-md-color-scheme="slate"] .highlight .c1,
-[data-md-color-scheme="slate"] .highlight .cm,
-[data-md-color-scheme="slate"] .highlight .cp,
-[data-md-color-scheme="slate"] .highlight .cs {
-    color: #8b949e !important;
-    font-style: italic;
-}
-
-[data-md-color-scheme="slate"] .highlight .o,
-[data-md-color-scheme="slate"] .highlight .ow {
-    color: #ff7b72 !important;
-}
-
-[data-md-color-scheme="slate"] .highlight .n,
-[data-md-color-scheme="slate"] .highlight .na,
-[data-md-color-scheme="slate"] .highlight .nb,
-[data-md-color-scheme="slate"] .highlight .nd,
-[data-md-color-scheme="slate"] .highlight .ni,
-[data-md-color-scheme="slate"] .highlight .nl,
-[data-md-color-scheme="slate"] .highlight .nn,
-[data-md-color-scheme="slate"] .highlight .nx,
-[data-md-color-scheme="slate"] .highlight .py,
-[data-md-color-scheme="slate"] .highlight .nt,
-[data-md-color-scheme="slate"] .highlight .nv,
-[data-md-color-scheme="slate"] .highlight .bp,
-[data-md-color-scheme="slate"] .highlight .vc,
-[data-md-color-scheme="slate"] .highlight .vg,
-[data-md-color-scheme="slate"] .highlight .vi {
-    color: #ffa657 !important;
-}
@@ -1,13 +1,12 @@
-import os
-import random
-import string
+from typing import List
+from specklepy.objects import Base
+from specklepy.api import operations
+from specklepy.transports.sqlite import SQLiteTransport
 import time
 from pathlib import Path
-from typing import List
-
-from specklepy.api import operations
-from specklepy.objects import Base
-from specklepy.transports.sqlite import SQLiteTransport
+import os
+import string
+import random


 class Sub(Base):
@@ -27,6 +26,7 @@ def clean_db():


 def one_pass(clean: bool, randomize: bool, child_count: int):
+
    foo = Base()
    for i in range(child_count):
        stuff = random_string() if randomize else "stuff"
@@ -1,15 +0,0 @@
-from devtools import debug
-
-from specklepy.api import operations
-from specklepy.api.wrapper import StreamWrapper
-
-if __name__ == "__main__":
-    stream_url = "https://latest.speckle.dev/streams/7d051a6449"
-    wrapper = StreamWrapper(stream_url)
-
-    transport = wrapper.get_transport()
-
-    rec = operations.receive("98396753f8bf7fe1cb60c5193e9f9d86", transport)
-
-    # hash = operations.send(base=foo, transports=[transport], use_default_cache=False)
-    debug(rec)
@@ -1,39 +0,0 @@
-import random
-import string
-from typing import List
-
-from specklepy.api import operations
-from specklepy.api.wrapper import StreamWrapper
-from specklepy.objects import Base
-
-
-class Sub(Base):
-    bar: List[str]
-
-
-def random_string():
-    letters = string.ascii_lowercase
-    return "".join(random.choice(letters) for _ in range(10))
-
-
-def create_object(child_count: int) -> Base:
-    foo = Base()
-    for i in range(child_count):
-        stuff = random_string()
-        foo[f"@child_{i}"] = Sub(bar=["asdf", "bar", i, stuff])
-    return foo
-
-
-if __name__ == "__main__":
-    stream_url = "http://hyperion:3000/streams/2372b54c35"
-
-    child_count = 10
-    foo = create_object(child_count)
-
-    wrapper = StreamWrapper(stream_url)
-    transport = wrapper.get_transport()
-
-    hash = operations.send(base=foo, transports=[transport], use_default_cache=False)
-
-    rec = operations.receive(hash, transport)
-    print(rec)
@@ -1,36 +0,0 @@
-from devtools import debug
-
-from specklepy.api import operations
-from specklepy.objects_v2.geometry import Base
-from specklepy.objects_v2.units import Units
-
-dct = {
-    "id": "1234abcd",
-    "units": None,
-    "speckle_type": "Base",
-    "applicationId": None,
-    "totalChildrenCount": 0,
-}
-base = Base()
-for prop, value in dct.items():
-    base.__setattr__(prop, value)
-
-
-debug(base)
-debug(base.units)
-
-base.units = "m"
-debug(base.units)
-base.units = None
-
-debug(base.units)
-
-foo = operations.serialize(base)
-
-base.units = 10
-
-debug(base.units)
-debug(foo)
-
-base.units = Units.mm
-debug(base.units)
@@ -1,10 +1,9 @@
 """This is an example showcasing the usage of speckle `Base` class."""

 # the speckle.objects module exposes all speckle provided classes
-from devtools import debug
-
-from specklepy.api import operations
 from specklepy.objects import Base
+from specklepy.api import operations
+from devtools import debug


 class ExampleSub(Base):
@@ -1,27 +0,0 @@
-[tools]
-python = "3.13.7"
-uv = "0.9.11"
-
-[settings]
-experimental = true
-python.uv_venv_auto = true
-
-
-[tasks.install]
-run= "uv sync --all-extras --all-groups"
-
-
-[tasks.install_docs]
-run= "uv sync --group docs"
-
-[tasks.build_docs]
-description = "Build static docs "
-run = "uv run mkdocs build"
-depends = ['install_docs']
-
-[tasks.test]
-run = "uv run pytest"
-
-
-[env]
-IS_PUBLIC = "false"
@@ -1,130 +0,0 @@
-site_name: specklepy Docs
-theme:
-  name: material
-  font:
-    text: Inter
-  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:
- stylesheets/extra.css
-
-plugins:
-  - search
-  - mkdocstrings:
-      handlers:
-        python:
-          paths: [src]
-          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]
-
-nav:
-  - Home: index.md
-  - specklepy SDK:
-    - API:
-      - Client: specklepy/api/client.md
-      - Credentials: specklepy/api/credentials.md
-      - Operations: specklepy/api/operations.md
-      - Resources:
-        - ActiveUserResource: specklepy/api/resources/ActiveUserResource.md
-        - FileImportResource: specklepy/api/resources/FileImportResource.md
-        - ModelResource: specklepy/api/resources/ModelResource.md
-        - OtherUserResource: specklepy/api/resources/OtherUserResource.md
-        - ProjectInviteResource: specklepy/api/resources/ProjectInviteResource.md
-        - ProjectResource: specklepy/api/resources/ProjectResource.md
-        - ServerResource: specklepy/api/resources/ServerResource.md
-        - SubscriptionResource: specklepy/api/resources/SubscriptionResource.md
-        - VersionResource: specklepy/api/resources/VersionResource.md
-        - WorkspaceResource: specklepy/api/resources/WorkspaceResource.md
-    - Objects:
-      - Base: specklepy/objects/base.md
-      - Data Objects: specklepy/objects/data_objects.md
-      - Geometry:
-        - Arc: specklepy/objects/geometry/Arc.md
-        - Box: specklepy/objects/geometry/Box.md
-        - Circle: specklepy/objects/geometry/Circle.md
-        - ControlPoint: specklepy/objects/geometry/ControlPoint.md
-        - Curve: specklepy/objects/geometry/Curve.md
-        - Ellipse: specklepy/objects/geometry/Ellipse.md
-        - Line: specklepy/objects/geometry/Line.md
-        - Mesh: specklepy/objects/geometry/Mesh.md
-        - Plane: specklepy/objects/geometry/Plane.md
-        - Point: specklepy/objects/geometry/Point.md
-        - PointCloud: specklepy/objects/geometry/PointCloud.md
-        - Polycurve: specklepy/objects/geometry/Polycurve.md
-        - Polyline: specklepy/objects/geometry/Polyline.md
-        - Spiral: specklepy/objects/geometry/Spiral.md
-        - Surface: specklepy/objects/geometry/Surface.md
-        - Vector: specklepy/objects/geometry/Vector.md
-      - Primitives:
-        - Interval: specklepy/objects/primitives/interval.md
-      - Other:
-        - RenderMaterial: specklepy/objects/other/render_material.md
-        - Collection: specklepy/objects/other/collection.md
-      - Proxies:
-        - ColorProxy: specklepy/objects/proxies/ColorProxy.md
-        - GroupProxy: specklepy/objects/proxies/GroupProxy.md
-        - InstanceProxy: specklepy/objects/proxies/InstanceProxy.md
-        - InstanceDefinitionProxy: specklepy/objects/proxies/InstanceDefinitionProxy.md
-        - LevelProxy: specklepy/objects/proxies/LevelProxy.md
-        - RenderMaterialProxy: specklepy/objects/proxies/RenderMaterialProxy.md
-      - Graph Traversal: specklepy/objects/graph_traversal/traversal.md
-    - Transports: specklepy/transports/transports.md
-    - Serialization: specklepy/serialization/serializer.md
-    - Core API:
-      - Models: specklepy/core/api/models/models.md
-      - Inputs: specklepy/core/api/inputs/inputs.md
-      - Enums: specklepy/core/api/enums.md
-    - Logging:
-      - Exceptions: specklepy/logging/exceptions.md
-  - Speckle Automate:
-    - AutomationContext: speckle_automate/automation_context.md
-    - Runner: speckle_automate/runner.md
-    - Schema: speckle_automate/schema.md
@@ -1,3 +0,0 @@
-[build]
-  command = "mise run build_docs"
-  publish = "site"
@@ -0,0 +1,31 @@
+import re
+import sys
+
+
+def patch(tag):
+    print(f"Patching version: {tag}")
+
+    with open("pyproject.toml", "r") as f:
+        lines = f.readlines()
+
+        if "version" not in lines[2]:
+            raise Exception(f"Invalid pyproject.toml. Could not patch version.")
+
+        lines[2] = f'version = "{tag}"\n'
+        with open("pyproject.toml", "w") as file:
+            file.writelines(lines)
+
+
+def main():
+    if len(sys.argv) < 2:
+        return
+
+    tag = sys.argv[1]
+    if not re.match(r"[0-9]+(\.[0-9]+)*$", tag):
+        raise ValueError(f"Invalid tag provided: {tag}")
+
+    patch(tag)
+
+
+if __name__ == "__main__":
+    main()
@@ -1,104 +1,52 @@
-[project]
-dynamic = ["version"]
-# version = "3.0.0a1"
+[tool.poetry]
 name = "specklepy"
-description = "The Python SDK for Speckle"
+version = "2.4.0"
+description = "The Python SDK for Speckle 2.0"
 readme = "README.md"
-authors = [{ name = "Speckle Systems", email = "devops@speckle.systems" }]
-license = { text = "Apache-2.0" }
-requires-python = ">=3.10.0, <4.0"
-dependencies = [
-    "appdirs>=1.4.4",
-    "attrs>=24.3.0",
-    "deprecated>=1.2.15",
-    "gql[requests,websockets]>=3.5.0,<4.0.0",
-    "httpx>=0.28.1",
-    "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",
-    "devtools>=0.12.2",
-    "hatch>=1.14.0",
-    "hatch-vcs>=0.4.0",
-    "pre-commit>=4.0.1",
-    "pytest>=8.3.4",
-    "pytest-asyncio>=0.25.2",
-    "pytest-cov>=6.0.0",
-    "pytest-ordering>=0.6",
-    "pytest_httpserver >=1.1.3",
-    "ruff==0.9.2",
-    "types-deprecated>=1.2.15.20241117",
-    "types-requests>=2.32.0.20241016",
-    "types-ujson>=5.10.0.20240515",
-]
-docs = [
-    "mkdocs>=1.6.1",
-    "mkdocs-material>=9.6.5",
-    "mkdocstrings>=0.28.1",
-    "mkdocstrings-python>=1.15.0",
-]
-
-[project.urls]
-repository = "https://github.com/specklesystems/specklepy"
+authors = ["Speckle Systems <devops@speckle.systems>"]
+license = "Apache-2.0"
+repository = "https://github.com/specklesystems/speckle-py"
 documentation = "https://speckle.guide/dev/py-examples.html"
 homepage = "https://speckle.systems/"

+
+[tool.poetry.dependencies]
+python = "^3.6.5"
+pydantic = "^1.8.2"
+appdirs = "^1.4.4"
+gql = {extras = ["requests", "websockets"], version = "^3.3.0"}
+ujson = "^4.3.0"
+Deprecated = "^1.2.13"
+
+[tool.poetry.dev-dependencies]
+black = "^20.8b1"
+isort = "^5.7.0"
+pytest = "^6.2.2"
+pytest-ordering = "^0.6"
+pytest-cov = "^3.0.0"
+devtools = "^0.8.0"
+
+
+[tool.black]
+exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+)/
+'''
+include = '\.pyi?$'
+line-length = 88
+target-version = ["py36", "py37", "py38"]
+
+
 [build-system]
-requires = ["hatchling", "hatch-vcs"]
-build-backend = "hatchling.build"
-
-[tool.hatch.version]
-source = "vcs"
-
-[tool.hatch.build.targets.wheel]
-only-include = ["src", "licenses"]
-sources = ["src"]
-
-[tool.hatch.build.targets.sdist]
-include = ["src", "licenses"]
-
-[tool.hatch.version.raw-options]
-local_scheme = "no-local-version"
-
-[tool.commitizen]
-name = "cz_conventional_commits"
-version = "2.9.2"
-tag_format = "$version"
-
-[tool.ruff]
-exclude = [".venv", "**/*.yml"]
-
-[tool.ruff.lint]
-select = [
-    # pycodestyle
-    "E",
-    # Pyflakes
-    "F",
-    # pyupgrade
-    "UP",
-    # flake8-bugbear
-    "B",
-    # flake8-simplify
-    "SIM",
-    # isort
-    "I",
-]
-ignore = ["UP006", "UP007", "UP035"]
-
-[[tool.uv.index]]
-name = "pypi"
-url = "https://pypi.org/simple/"
-publish-url = "https://upload.pypi.org/legacy/"
-
-[[tool.uv.index]]
-name = "test"
-url = "https://test.pypi.org/simple/"
-publish-url = "https://test.pypi.org/legacy/"
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
@@ -0,0 +1,196 @@
+import re
+from warnings import warn
+from deprecated import deprecated
+from specklepy.api.credentials import Account, get_account_from_token
+from specklepy.logging import metrics
+from specklepy.logging.exceptions import (
+    SpeckleException,
+    SpeckleWarning,
+)
+from typing import Dict
+
+from specklepy.api import resources
+from specklepy.api.resources import (
+    branch,
+    commit,
+    stream,
+    object,
+    server,
+    user,
+    subscriptions,
+)
+from specklepy.api.models import ServerInfo
+from gql import Client
+from gql.transport.requests import RequestsHTTPTransport
+from gql.transport.websockets import WebsocketsTransport
+
+
+class SpeckleClient:
+    """
+    The `SpeckleClient` is your entry point for interacting with your Speckle Server's GraphQL API.
+    You'll need to have access to a server to use it, or you can use our public server `speckle.xyz`.
+
+    To authenticate the client, you'll need to have downloaded the [Speckle Manager](https://speckle.guide/#speckle-manager)
+    and added your account.
+
+    ```py
+    from specklepy.api.client import SpeckleClient
+    from specklepy.api.credentials import get_default_account
+
+    # initialise the client
+    client = SpeckleClient(host="speckle.xyz") # or whatever your host is
+    # client = SpeckleClient(host="localhost:3000", use_ssl=False) or use local server
+
+    # authenticate the client with an account (account has been added in Speckle Manager)
+    account = get_default_account()
+    client.authenticate_with_account(account)
+
+    # create a new stream. this returns the stream id
+    new_stream_id = client.stream.create(name="a shiny new stream")
+
+    # use that stream id to get the stream from the server
+    new_stream = client.stream.get(id=new_stream_id)
+    ```
+    """
+
+    DEFAULT_HOST = "speckle.xyz"
+    USE_SSL = True
+
+    def __init__(self, host: str = DEFAULT_HOST, use_ssl: bool = USE_SSL) -> None:
+        metrics.track(metrics.CLIENT, custom_props={"name": "create"})
+        ws_protocol = "ws"
+        http_protocol = "http"
+
+        if use_ssl:
+            ws_protocol = "wss"
+            http_protocol = "https"
+
+        # sanitise host input by removing protocol and trailing slash
+        host = re.sub(r"((^\w+:|^)\/\/)|(\/$)", "", host)
+
+        self.url = f"{http_protocol}://{host}"
+        self.graphql = f"{self.url}/graphql"
+        self.ws_url = f"{ws_protocol}://{host}/graphql"
+        self.account = Account()
+
+        self.httpclient = Client(
+            transport=RequestsHTTPTransport(url=self.graphql, verify=True, retries=3)
+        )
+        self.wsclient = None
+
+        self._init_resources()
+
+        # ? Check compatibility with the server - i think we can skip this at this point? save a request
+        # try:
+        #     server_info = self.server.get()
+        #     if isinstance(server_info, Exception):
+        #         raise server_info
+        #     if not isinstance(server_info, ServerInfo):
+        #         raise Exception("Couldn't get ServerInfo")
+        # except Exception as ex:
+        #     raise SpeckleException(
+        #         f"{self.url} is not a compatible Speckle Server", ex
+        #     ) from ex
+
+    def __repr__(self):
+        return f"SpeckleClient( server: {self.url}, authenticated: {self.account.token is not None} )"
+
+    @deprecated(
+        version="2.6.0",
+        reason="Renamed: please use `authenticate_with_account` or `authenticate_with_token` instead.",
+    )
+    def authenticate(self, token: str) -> None:
+        """Authenticate the client using a personal access token
+        The token is saved in the client object and a synchronous GraphQL entrypoint is created
+
+        Arguments:
+            token {str} -- an api token
+        """
+        self.authenticate_with_token(token)
+        self._set_up_client()
+
+    def authenticate_with_token(self, token: str) -> None:
+        """Authenticate the client using a personal access token
+        The token is saved in the client object and a synchronous GraphQL entrypoint is created
+
+        Arguments:
+            token {str} -- an api token
+        """
+        self.account = get_account_from_token(token, self.url)
+        metrics.track(metrics.CLIENT, self.account, {"name": "authenticate with token"})
+        self._set_up_client()
+
+    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 entrypoint is created
+
+        Arguments:
+            account {Account} -- the account object which can be found with `get_default_account` or `get_local_accounts`
+        """
+        metrics.track(metrics.CLIENT, account, {"name": "authenticate with account"})
+        self.account = account
+        self._set_up_client()
+
+    def _set_up_client(self) -> None:
+        metrics.track(metrics.CLIENT, self.account, {"name": "set up client"})
+        headers = {
+            "Authorization": f"Bearer {self.account.token}",
+            "Content-Type": "application/json",
+        }
+        httptransport = RequestsHTTPTransport(
+            url=self.graphql, headers=headers, verify=True, retries=3
+        )
+        wstransport = WebsocketsTransport(
+            url=self.ws_url,
+            init_payload={"Authorization": f"Bearer {self.account.token}"},
+        )
+        self.httpclient = Client(transport=httptransport)
+        self.wsclient = Client(transport=wstransport)
+
+        self._init_resources()
+
+        if self.user.get() is None:
+            warn(
+                SpeckleWarning(
+                    f"Possibly invalid token - could not authenticate Speckle Client for server {self.url}"
+                )
+            )
+
+    def execute_query(self, query: str) -> Dict:
+        return self.httpclient.execute(query)
+
+    def _init_resources(self) -> None:
+        self.stream = stream.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.commit = commit.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.branch = branch.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.object = object.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.server = server.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.user = user.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.subscribe = subscriptions.Resource(
+            account=self.account,
+            basepath=self.ws_url,
+            client=self.wsclient,
+        )
+
+    def __getattr__(self, name):
+        try:
+            attr = getattr(resources, name)
+            return attr.Resource(
+                account=self.account, basepath=self.url, client=self.httpclient
+            )
+        except:
+            raise SpeckleException(
+                f"Method {name} is not supported by the SpeckleClient class"
+            )
@@ -0,0 +1,131 @@
+import os
+from pydantic import BaseModel, Field
+from typing import List, Optional
+from specklepy.logging import metrics
+from specklepy.api.models import ServerInfo
+from specklepy.transports.sqlite import SQLiteTransport
+from specklepy.logging.exceptions import SpeckleException
+
+
+class UserInfo(BaseModel):
+    name: Optional[str]
+    email: Optional[str]
+    company: Optional[str]
+    id: Optional[str]
+
+
+class Account(BaseModel):
+    isDefault: bool = False
+    token: str = None
+    refreshToken: str = None
+    serverInfo: ServerInfo = Field(default_factory=ServerInfo)
+    userInfo: UserInfo = Field(default_factory=UserInfo)
+    id: str = None
+
+    def __repr__(self) -> str:
+        return f"Account(email: {self.userInfo.email}, server: {self.serverInfo.url}, isDefault: {self.isDefault})"
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+    @classmethod
+    def from_token(cls, token: str, server_url: str = None):
+        acct = cls(token=token)
+        acct.serverInfo.url = server_url
+        return acct
+
+
+def get_local_accounts(base_path: str = None) -> List[Account]:
+    """Gets all the accounts present in this environment
+
+    Arguments:
+        base_path {str} -- custom base path if you are not using the system default
+
+    Returns:
+        List[Account] -- list of all local accounts or an empty list if no accounts were found
+    """
+    account_storage = SQLiteTransport(scope="Accounts", base_path=base_path)
+    json_path = os.path.join(account_storage._base_path, "Accounts")
+    os.makedirs(json_path, exist_ok=True)
+    json_acct_files = [file for file in os.listdir(json_path) if file.endswith(".json")]
+
+    accounts = []
+    res = account_storage.get_all_objects()
+    if res:
+        accounts.extend(Account.parse_raw(r[1]) for r in res)
+    if json_acct_files:
+        try:
+            accounts.extend(
+                Account.parse_file(os.path.join(json_path, json_file))
+                for json_file in json_acct_files
+            )
+        except Exception as ex:
+            raise SpeckleException(
+                "Invalid json accounts could not be read. Please fix or remove them.",
+                ex,
+            )
+    metrics.track(
+        metrics.ACCOUNTS,
+        next(
+            (acc for acc in accounts if acc.isDefault),
+            accounts[0] if accounts else None,
+        ),
+    )
+
+    return accounts
+
+
+def get_default_account(base_path: str = None) -> Account:
+    """Gets this environment's default account if any. If there is no default, the first found will be returned and set as default.
+    Arguments:
+        base_path {str} -- custom base path if you are not using the system default
+
+    Returns:
+        Account -- the default account or None if no local accounts were found
+    """
+    accounts = get_local_accounts(base_path=base_path)
+    if not accounts:
+        return None
+
+    default = next((acc for acc in accounts if acc.isDefault), None)
+    if not default:
+        default = accounts[0]
+        default.isDefault = True
+    metrics.initialise_tracker(default)
+
+    return default
+
+
+def get_account_from_token(token: str, server_url: str = None) -> Account:
+    """Gets the local account for the token if it exists
+    Arguments:
+        token {str} -- the api token
+
+    Returns:
+        Account -- the local account with this token or a shell account containing just the token and url if no local account is found
+    """
+    accounts = get_local_accounts()
+    if not accounts:
+        return Account.from_token(token, server_url)
+
+    acct = next((acc for acc in accounts if acc.token == token), None)
+    if acct:
+        return acct
+
+    if server_url:
+        url = server_url.lower()
+        acct = next(
+            (acc for acc in accounts if url in acc.serverInfo.url.lower()), None
+        )
+        if acct:
+            return acct
+
+    return Account.from_token(token, server_url)
+
+
+class StreamWrapper:
+    def __init__(self, url: str = None) -> None:
+        raise SpeckleException(
+            message="The StreamWrapper has moved as of v2.6.0! Please import from specklepy.api.wrapper",
+            exception=DeprecationWarning,
+        )
@@ -0,0 +1,152 @@
+# generated by datamodel-codegen:
+#   filename:  stream_schema.json
+#   timestamp: 2020-11-17T14:33:13+00:00
+
+from datetime import datetime
+from typing import Any, Dict, List, Optional
+
+
+from pydantic import BaseModel
+
+
+class Collaborator(BaseModel):
+    id: Optional[str]
+    name: Optional[str]
+    role: Optional[str]
+    avatar: Optional[str]
+
+
+class Commit(BaseModel):
+    id: Optional[str]
+    message: Optional[str]
+    authorName: Optional[str]
+    authorId: Optional[str]
+    authorAvatar: Optional[str]
+    branchName: Optional[str]
+    createdAt: Optional[datetime]
+    sourceApplication: Optional[str]
+    referencedObject: Optional[str]
+    totalChildrenCount: Optional[int]
+    parents: Optional[List[str]]
+
+    def __repr__(self) -> str:
+        return f"Commit( id: {self.id}, message: {self.message}, referencedObject: {self.referencedObject}, authorName: {self.authorName}, branchName: {self.branchName}, createdAt: {self.createdAt} )"
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+
+class Commits(BaseModel):
+    totalCount: Optional[int]
+    cursor: Optional[datetime]
+    items: List[Commit] = []
+
+
+class Object(BaseModel):
+    id: Optional[str]
+    speckleType: Optional[str]
+    applicationId: Optional[str]
+    totalChildrenCount: Optional[int]
+    createdAt: Optional[datetime]
+
+
+class Branch(BaseModel):
+    id: Optional[str]
+    name: Optional[str]
+    description: Optional[str]
+    commits: Optional[Commits]
+
+
+class Branches(BaseModel):
+    totalCount: Optional[int]
+    cursor: Optional[datetime]
+    items: List[Branch] = []
+
+
+class Stream(BaseModel):
+    id: Optional[str]
+    name: Optional[str]
+    role: Optional[str]
+    isPublic: Optional[bool]
+    description: Optional[str]
+    createdAt: Optional[datetime]
+    updatedAt: Optional[datetime]
+    collaborators: List[Collaborator] = []
+    branches: Optional[Branches]
+    commit: Optional[Commit]
+    object: Optional[Object]
+    commentCount: Optional[int]
+    favoritedDate: Optional[datetime]
+    favoritesCount: Optional[int]
+
+    def __repr__(self):
+        return f"Stream( id: {self.id}, name: {self.name}, description: {self.description}, isPublic: {self.isPublic})"
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+
+class Streams(BaseModel):
+    totalCount: Optional[int]
+    cursor: Optional[datetime]
+    items: List[Stream] = []
+
+
+class User(BaseModel):
+    id: Optional[str]
+    email: Optional[str]
+    name: Optional[str]
+    bio: Optional[str]
+    company: Optional[str]
+    avatar: Optional[str]
+    verified: Optional[bool]
+    role: Optional[str]
+    streams: Optional[Streams]
+
+    def __repr__(self):
+        return f"User( id: {self.id}, name: {self.name}, email: {self.email}, company: {self.company} )"
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+
+class Activity(BaseModel):
+    actionType: Optional[str]
+    info: Optional[dict]
+    userId: Optional[str]
+    streamId: Optional[str]
+    resourceId: Optional[str]
+    resourceType: Optional[str]
+    message: Optional[str]
+    time: Optional[datetime]
+
+    def __repr__(self) -> str:
+        return f"Activity( streamId: {self.streamId}, actionType: {self.actionType}, message: {self.message}, userId: {self.userId} )"
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+
+class ActivityCollection(BaseModel):
+    totalCount: Optional[int]
+    items: Optional[List[Activity]]
+    cursor: Optional[datetime]
+
+    def __repr__(self) -> str:
+        return f"ActivityCollection( totalCount: {self.totalCount}, items: {len(self.items) if self.items else 0}, cursor: {self.cursor.isoformat()} )"
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+
+class ServerInfo(BaseModel):
+    name: Optional[str]
+    company: Optional[str]
+    url: Optional[str]
+    description: Optional[str]
+    adminContact: Optional[str]
+    canonicalUrl: Optional[str]
+    roles: Optional[List[dict]]
+    scopes: Optional[List[dict]]
+    authStrategies: Optional[List[dict]]
+    version: Optional[str]
@@ -1,16 +1,16 @@
-from typing import List, Optional
-
-# from specklepy.logging import metrics
-from specklepy.logging.exceptions import SpeckleException
+from typing import List
+from specklepy.logging import metrics
 from specklepy.objects.base import Base
-from specklepy.serialization.base_object_serializer import BaseObjectSerializer
-from specklepy.transports.abstract_transport import AbstractTransport
 from specklepy.transports.sqlite import SQLiteTransport
+from specklepy.transports.server import ServerTransport
+from specklepy.logging.exceptions import SpeckleException
+from specklepy.transports.abstract_transport import AbstractTransport
+from specklepy.serialization.base_object_serializer import BaseObjectSerializer


 def send(
    base: Base,
-    transports: Optional[List[AbstractTransport]] = None,
+    transports: List[AbstractTransport] = None,
    use_default_cache: bool = True,
 ):
    """Sends an object via the provided transports. Defaults to the local cache.
@@ -18,8 +18,7 @@ def send(
    Arguments:
        obj {Base} -- the object you want to send
        transports {list} -- where you want to send them
-        use_default_cache {bool} -- toggle for the default cache.
-        If set to false, it will only send to the provided transports
+        use_default_cache {bool} -- toggle for the default cache. If set to false, it will only send to the provided transports

    Returns:
        str -- the object id of the sent object
@@ -27,17 +26,14 @@ def send(

    if not transports and not use_default_cache:
        raise SpeckleException(
-            message=(
-                "You need to provide at least one transport: cannot send with an empty"
-                " transport list and no default cache"
-            )
+            message="You need to provide at least one transport: cannot send with an empty transport list and no default cache"
        )

-    if isinstance(transports, AbstractTransport):
-        transports = [transports]
-
    if transports is None:
+        metrics.track(metrics.SEND)
        transports = []
+    else:
+        metrics.track(metrics.SEND, getattr(transports[0], "account", None))

    if use_default_cache:
        transports.insert(0, SQLiteTransport())
@@ -51,8 +47,8 @@ def send(

 def receive(
    obj_id: str,
-    remote_transport: Optional[AbstractTransport] = None,
-    local_transport: Optional[AbstractTransport] = None,
+    remote_transport: AbstractTransport = None,
+    local_transport: AbstractTransport = None,
 ) -> Base:
    """Receives an object from a transport.

@@ -65,23 +61,20 @@ def receive(
    Returns:
        Base -- the base object
    """
+    metrics.track(metrics.RECEIVE, getattr(remote_transport, "account", None))
    if not local_transport:
        local_transport = SQLiteTransport()

    serializer = BaseObjectSerializer(read_transport=local_transport)

-    # try local transport first. if the parent is there, we assume all the children
-    # are there and continue with deserialization using the local transport
+    # try local transport first. if the parent is there, we assume all the children are there and continue with deserialisation using the local transport
    obj_string = local_transport.get_object(obj_id)
    if obj_string:
        return serializer.read_json(obj_string=obj_string)

    if not remote_transport:
        raise SpeckleException(
-            message=(
-                "Could not find the specified object using the local transport, and you"
-                " didn't provide a fallback remote from which to pull it."
-            )
+            message="Could not find the specified object using the local transport, and you didn't provide a fallback remote from which to pull it."
        )

    obj_string = remote_transport.copy_object_and_children(
@@ -91,54 +84,40 @@ def receive(
    return serializer.read_json(obj_string=obj_string)


-def serialize(
-    base: Base, write_transports: List[AbstractTransport] | None = None
-) -> str:
+def serialize(base: Base, write_transports: List[AbstractTransport] = []) -> str:
    """
-    Serialize a base object. If no write transports are provided,
-    the object will be serialized
+    Serialize a base object. If no write transports are provided, the object will be serialized
    without detaching or chunking any of the attributes.

    Arguments:
        base {Base} -- the object to serialize
-        write_transports {List[AbstractTransport]}
-        -- optional: the transports to write to
+        write_transports {List[AbstractTransport]} -- optional: the transports to write to

    Returns:
        str -- the serialized object
    """
-    if not write_transports:
-        write_transports = []
+    metrics.track(metrics.SERIALIZE)
    serializer = BaseObjectSerializer(write_transports=write_transports)

    return serializer.write_json(base)[1]


-def deserialize(
-    obj_string: str, read_transport: Optional[AbstractTransport] = None
-) -> Base:
+def deserialize(obj_string: str, read_transport: AbstractTransport = None) -> Base:
    """
-    Deserialize a string object into a Base object.
-
-    If the object contains referenced child objects that are not stored in the local db,
-    a read transport needs to be provided in order to recompose
-    the base with the children objects.
+    Deserialize a string object into a Base object. If the object contains referenced child objects that are not stored in the local db, a read transport needs to be provided in order to recompose the base with the children objects.

    Arguments:
        obj_string {str} -- the string object to deserialize
-        read_transport {AbstractTransport}
-            -- the transport to fetch children objects from
-                (defaults to SQLiteTransport)
+        read_transport {AbstractTransport} -- the transport to fetch children objects from
+                                              (defaults to SQLiteTransport)

    Returns:
        Base -- the deserialized object
    """
+    metrics.track(metrics.DESERIALIZE)
    if not read_transport:
        read_transport = SQLiteTransport()

    serializer = BaseObjectSerializer(read_transport=read_transport)

    return serializer.read_json(obj_string=obj_string)
-
-
-__all__ = ["receive", "send", "serialize", "deserialize"]
@@ -0,0 +1,82 @@
+from specklepy.api.credentials import Account
+from specklepy.transports.sqlite import SQLiteTransport
+from typing import Dict, List
+from gql.client import Client
+from gql.gql import gql
+from gql.transport.exceptions import TransportQueryError
+from specklepy.logging.exceptions import GraphQLException, SpeckleException
+from specklepy.serialization.base_object_serializer import BaseObjectSerializer
+
+
+class ResourceBase(object):
+    def __init__(
+        self,
+        account: Account,
+        basepath: str,
+        client: Client,
+        name: str,
+        methods: list,
+    ) -> None:
+        self.account = account
+        self.basepath = basepath
+        self.client = client
+        self.name = name
+        self.methods = methods
+        self.schema = None
+
+    def _step_into_response(self, response: dict, return_type: str or List):
+        """Step into the dict to get the relevant data"""
+        if return_type is None:
+            return response
+        elif isinstance(return_type, str):
+            return response[return_type]
+        elif isinstance(return_type, List):
+            for key in return_type:
+                response = response[key]
+            return response
+
+    def _parse_response(self, response: dict or list, schema=None):
+        """Try to create a class instance from the response"""
+        if isinstance(response, list):
+            return [self._parse_response(response=r, schema=schema) for r in response]
+        if schema:
+            return schema.parse_obj(response)
+        elif self.schema:
+            try:
+                return self.schema.parse_obj(response)
+            except:
+                s = BaseObjectSerializer(read_transport=SQLiteTransport())
+                return s.recompose_base(response)
+        else:
+            return response
+
+    def make_request(
+        self,
+        query: gql,
+        params: Dict = None,
+        return_type: str or List = None,
+        schema=None,
+        parse_response: bool = True,
+    ) -> Dict or GraphQLException:
+        """Executes the GraphQL query"""
+        try:
+            response = self.client.execute(query, variable_values=params)
+        except Exception as e:
+            if isinstance(e, TransportQueryError):
+                return GraphQLException(
+                    message=f"Failed to execute the GraphQL {self.name} request. Errors: {e.errors}",
+                    errors=e.errors,
+                    data=e.data,
+                )
+            else:
+                return SpeckleException(
+                    message=f"Failed to execute the GraphQL {self.name} request. Inner exception: {e}",
+                    exception=e,
+                )
+
+        response = self._step_into_response(response=response, return_type=return_type)
+
+        if parse_response:
+            return self._parse_response(response=response, schema=schema)
+        else:
+            return response
@@ -0,0 +1,13 @@
+from pathlib import Path
+import sys
+import inspect
+import pkgutil
+from importlib import import_module
+
+
+for (_, name, _) in pkgutil.iter_modules(__path__):
+
+    imported_module = import_module("." + name, package=__name__)
+
+    if hasattr(imported_module, "Resource"):
+        setattr(sys.modules[__name__], name, imported_module)
@@ -0,0 +1,216 @@
+from gql import gql
+from specklepy.api.resource import ResourceBase
+from specklepy.api.models import Branch
+from specklepy.logging import metrics
+
+NAME = "branch"
+METHODS = ["create"]
+
+
+class Resource(ResourceBase):
+    """API Access class for branches"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+            methods=METHODS,
+        )
+        self.schema = Branch
+
+    def create(
+        self, stream_id: str, name: str, description: str = "No description provided"
+    ) -> str:
+        """Create a new branch on this stream
+
+        Arguments:
+            name {str} -- the name of the new branch
+            description {str} -- a short description of the branch
+
+        Returns:
+            id {str} -- the newly created branch's id
+        """
+        metrics.track(metrics.BRANCH, self.account, {"name": "create"})
+        query = gql(
+            """
+            mutation BranchCreate($branch: BranchCreateInput!) {
+              branchCreate(branch: $branch)
+            }
+          """
+        )
+        params = {
+            "branch": {
+                "streamId": stream_id,
+                "name": name,
+                "description": description,
+            }
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type="branchCreate", parse_response=False
+        )
+
+    def get(self, stream_id: str, name: str, commits_limit: int = 10):
+        """Get a branch by name from a stream
+
+        Arguments:
+            stream_id {str} -- the id of the stream to get the branch from
+            name {str} -- the name of the branch to get
+            commits_limit {int} -- maximum number of commits to get
+
+        Returns:
+            Branch -- the fetched branch with its latest commits
+        """
+        metrics.track(metrics.BRANCH, self.account, {"name": "get"})
+        query = gql(
+            """
+            query BranchGet($stream_id: String!, $name: String!, $commits_limit: Int!) {
+                stream(id: $stream_id) {
+                        branch(name: $name) {
+                          id,
+                          name,
+                          description,
+                          commits (limit: $commits_limit) {
+                            totalCount,
+                            cursor,
+                            items {
+                              id,
+                              referencedObject,
+                              sourceApplication,
+                              totalChildrenCount,
+                              message,
+                              authorName,
+                              authorId,
+                              branchName,
+                              parents,
+                              createdAt
+                            }
+                        }
+                    }                      
+                }
+            }
+            """
+        )
+
+        params = {"stream_id": stream_id, "name": name, "commits_limit": commits_limit}
+
+        return self.make_request(
+            query=query, params=params, return_type=["stream", "branch"]
+        )
+
+    def list(self, stream_id: str, branches_limit: int = 10, commits_limit: int = 10):
+        """Get a list of branches from a given stream
+
+        Arguments:
+            stream_id {str} -- the id of the stream to get the branches from
+            branches_limit {int} -- maximum number of branches to get
+            commits_limit {int} -- maximum number of commits to get
+
+        Returns:
+            List[Branch] -- the branches on the stream
+        """
+        metrics.track(metrics.BRANCH, self.account, {"name": "get"})
+        query = gql(
+            """
+            query BranchesGet($stream_id: String!, $branches_limit: Int!, $commits_limit: Int!) {
+                stream(id: $stream_id) {
+                    branches(limit: $branches_limit) {
+                        items {
+                            id
+                            name
+                            description
+                            commits(limit: $commits_limit) {
+                                totalCount
+                                items{
+                                    id
+                                    message
+                                    referencedObject
+                                    sourceApplication
+                                    parents
+                                    authorId
+                                    authorName
+                                    branchName
+                                    createdAt
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+            """
+        )
+
+        params = {
+            "stream_id": stream_id,
+            "branches_limit": branches_limit,
+            "commits_limit": commits_limit,
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type=["stream", "branches", "items"]
+        )
+
+    def update(
+        self, stream_id: str, branch_id: str, name: str = None, description: str = None
+    ):
+        """Update a branch
+
+        Arguments:
+            stream_id {str} -- the id of the stream containing the branch to update
+            branch_id {str} -- the id of the branch to update
+            name {str} -- optional: the updated branch name
+            description {str} -- optional: the updated branch description
+
+        Returns:
+            bool -- True if update is successful
+        """
+        metrics.track(metrics.BRANCH, self.account, {"name": "update"})
+        query = gql(
+            """
+            mutation  BranchUpdate($branch: BranchUpdateInput!) {
+                branchUpdate(branch: $branch)
+                }
+            """
+        )
+        params = {
+            "branch": {
+                "streamId": stream_id,
+                "id": branch_id,
+            }
+        }
+
+        if name:
+            params["branch"]["name"] = name
+        if description:
+            params["branch"]["description"] = description
+
+        return self.make_request(
+            query=query, params=params, return_type="branchUpdate", parse_response=False
+        )
+
+    def delete(self, stream_id: str, branch_id: str):
+        """Delete a branch
+
+        Arguments:
+            stream_id {str} -- the id of the stream containing the branch to delete
+            branch_id {str} -- the branch to delete
+
+        Returns:
+            bool -- True if deletion is successful
+        """
+        metrics.track(metrics.BRANCH, self.account, {"name": "delete"})
+        query = gql(
+            """
+            mutation BranchDelete($branch: BranchDeleteInput!) {
+                branchDelete(branch: $branch)
+            }
+            """
+        )
+
+        params = {"branch": {"streamId": stream_id, "id": branch_id}}
+
+        return self.make_request(
+            query=query, params=params, return_type="branchDelete", parse_response=False
+        )
@@ -0,0 +1,235 @@
+from typing import Optional, List
+from gql import gql
+from specklepy.api.resource import ResourceBase
+from specklepy.api.models import Commit
+from specklepy.logging import metrics
+
+
+NAME = "commit"
+METHODS = []
+
+
+class Resource(ResourceBase):
+    """API Access class for commits"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+            methods=METHODS,
+        )
+        self.schema = Commit
+
+    def get(self, stream_id: str, commit_id: str) -> Commit:
+        """
+        Gets a commit given a stream and the commit id
+
+        Arguments:
+            stream_id {str} -- the stream where we can find the commit
+            commit_id {str} -- the id of the commit you want to get
+
+        Returns:
+            Commit -- the retrieved commit object
+        """
+        query = gql(
+            """
+            query Commit($stream_id: String!, $commit_id: String!) {
+                stream(id: $stream_id) {
+                    commit(id: $commit_id) {
+                        id
+                        message
+                        referencedObject
+                        authorId
+                        authorName
+                        authorAvatar
+                        branchName
+                        createdAt
+                        sourceApplication
+                        totalChildrenCount
+                        parents
+                    }
+                }
+            }
+            """
+        )
+        params = {"stream_id": stream_id, "commit_id": commit_id}
+
+        return self.make_request(
+            query=query, params=params, return_type=["stream", "commit"]
+        )
+
+    def list(self, stream_id: str, limit: int = 10) -> List[Commit]:
+        """
+        Get a list of commits on a given stream
+
+        Arguments:
+            stream_id {str} -- the stream where the commits are
+            limit {int} -- the maximum number of commits to fetch (default = 10)
+
+        Returns:
+            List[Commit] -- a list of the most recent commit objects
+        """
+        metrics.track(metrics.COMMIT, self.account, {"name": "get"})
+        query = gql(
+            """
+            query Commits($stream_id: String!, $limit: Int!) {
+                stream(id: $stream_id) {
+                    commits(limit: $limit) {
+                        items {
+                            id
+                            message
+                            referencedObject
+                            authorName
+                            authorId
+                            authorName
+                            authorAvatar
+                            branchName
+                            createdAt
+                            sourceApplication
+                            totalChildrenCount
+                            parents
+                        }
+                    }
+                }
+            }
+            """
+        )
+        params = {"stream_id": stream_id, "limit": limit}
+
+        return self.make_request(
+            query=query, params=params, return_type=["stream", "commits", "items"]
+        )
+
+    def create(
+        self,
+        stream_id: str,
+        object_id: str,
+        branch_name: str = "main",
+        message: str = "",
+        source_application: str = "python",
+        parents: List[str] = None,
+    ) -> str:
+        """
+        Creates a commit on a branch
+
+        Arguments:
+            stream_id {str} -- the stream you want to commit to
+            object_id {str} -- the hash of your commit object
+            branch_name {str} -- the name of the branch to commit to (defaults to "main")
+            message {str} -- optional: a message to give more information about the commit
+            source_application{str} -- optional: the application from which the commit was created (defaults to "python")
+            parents {List[str]} -- optional: the id of the parent commits
+
+        Returns:
+            str -- the id of the created commit
+        """
+        metrics.track(metrics.COMMIT, self.account, {"name": "create"})
+        query = gql(
+            """
+            mutation CommitCreate ($commit: CommitCreateInput!){ commitCreate(commit: $commit)}
+            """
+        )
+        params = {
+            "commit": {
+                "streamId": stream_id,
+                "branchName": branch_name,
+                "objectId": object_id,
+                "message": message,
+                "sourceApplication": source_application,
+            }
+        }
+        if parents:
+            params["commit"]["parents"] = parents
+
+        return self.make_request(
+            query=query, params=params, return_type="commitCreate", parse_response=False
+        )
+
+    def update(self, stream_id: str, commit_id: str, message: str) -> bool:
+        """
+        Update a commit
+
+        Arguments:
+            stream_id {str} -- the id of the stream that contains the commit you'd like to update
+            commit_id {str} -- the id of the commit you'd like to update
+            message {str} -- the updated commit message
+
+        Returns:
+            bool -- True if the operation succeeded
+        """
+        metrics.track(metrics.COMMIT, self.account, {"name": "update"})
+        query = gql(
+            """
+            mutation CommitUpdate($commit: CommitUpdateInput!){ commitUpdate(commit: $commit)}
+            """
+        )
+        params = {
+            "commit": {"streamId": stream_id, "id": commit_id, "message": message}
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type="commitUpdate", parse_response=False
+        )
+
+    def delete(self, stream_id: str, commit_id: str) -> bool:
+        """
+        Delete a commit
+
+        Arguments:
+            stream_id {str} -- the id of the stream that contains the commit you'd like to delete
+            commit_id {str} -- the id of the commit you'd like to delete
+
+        Returns:
+            bool -- True if the operation succeeded
+        """
+        metrics.track(metrics.COMMIT, self.account, {"name": "delete"})
+        query = gql(
+            """
+            mutation CommitDelete($commit: CommitDeleteInput!){ commitDelete(commit: $commit)}
+            """
+        )
+        params = {"commit": {"streamId": stream_id, "id": commit_id}}
+
+        return self.make_request(
+            query=query, params=params, return_type="commitDelete", parse_response=False
+        )
+
+    def received(
+        self,
+        stream_id: str,
+        commit_id: str,
+        source_application: str = "python",
+        message: Optional[str] = None,
+    ) -> bool:
+        """
+        Mark a commit object a received by the source application.
+        """
+        metrics.track(metrics.COMMIT, self.account, {"name": "received"})
+        query = gql(
+            """
+            mutation CommitReceive($receivedInput:CommitReceivedInput!){
+                commitReceive(input:$receivedInput)
+            }
+            """
+        )
+        params = {
+            "receivedInput": {
+                "sourceApplication": source_application,
+                "streamId": stream_id,
+                "commitId": commit_id,
+                "message": "message",
+            }
+        }
+
+        try:
+            return self.make_request(
+                query=query,
+                params=params,
+                return_type="commitReceive",
+                parse_response=False,
+            )
+        except Exception as ex:
+            print(ex.with_traceback)
+            return False
@@ -0,0 +1,85 @@
+from typing import Dict, List
+from gql import gql
+from specklepy.api.resource import ResourceBase
+from specklepy.objects.base import Base
+
+NAME = "object"
+METHODS = []
+
+
+class Resource(ResourceBase):
+    """API Access class for objects"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+            methods=METHODS,
+        )
+        self.schema = Base
+
+    def get(self, stream_id: str, object_id: str) -> Base:
+        """
+        Get a stream object
+
+        Arguments:
+            stream_id {str} -- the id of the stream for the object
+            object_id {str} -- the hash of the object you want to get
+
+        Returns:
+            Base -- the returned Base object
+        """
+        query = gql(
+            """
+            query Object($stream_id: String!, $object_id: String!) {
+              stream(id: $stream_id) {
+                id
+                name
+                object(id: $object_id) {
+                  id
+                  speckleType
+                  applicationId
+                  createdAt
+                  totalChildrenCount
+                  data
+                }
+              }
+            }
+          """
+        )
+        params = {"stream_id": stream_id, "object_id": object_id}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type=["stream", "object", "data"],
+        )
+
+    def create(self, stream_id: str, objects: List[Dict]) -> str:
+        """
+        Not advised - generally, you want to use `operations.send()`.
+
+        Create a new object on a stream. To send a base object, you can prepare it by running it through the
+        `BaseObjectSerializer.traverse_base()` function to get a valid (serialisable) object to send.
+
+        NOTE: this does not create a commit - you can create one with `SpeckleClient.commit.create`. Dynamic fields will be located in the 'data' dict of the received `Base` object
+
+        Arguments:
+            stream_id {str} -- the id of the stream you want to send the object to
+            objects {List[Dict]} -- a list of base dictionary objects (NOTE: must be json serialisable)
+
+        Returns:
+            str -- the id of the object
+        """
+        query = gql(
+            """
+          mutation ObjectCreate($object_input: ObjectCreateInput!) { objectCreate(objectInput: $object_input) }
+          """
+        )
+        params = {"object_input": {"streamId": stream_id, "objects": objects}}
+
+        return self.make_request(
+            query=query, params=params, return_type="objectCreate", parse_response=False
+        )
@@ -1,16 +1,15 @@
-import re
-from typing import Any, Dict, List, Tuple
-
+from typing import Dict, List
 from gql import gql
+from specklepy.api.models import ServerInfo
+from specklepy.api.resource import ResourceBase
+from specklepy.logging import metrics

-from specklepy.core.api.models import ServerInfo
-from specklepy.core.api.resource import ResourceBase
-from specklepy.logging.exceptions import GraphQLException

 NAME = "server"
+METHODS = ["get", "apps"]


-class ServerResource(ResourceBase):
+class Resource(ResourceBase):
    """API Access class for the server"""

    def __init__(self, account, basepath, client) -> None:
@@ -19,6 +18,7 @@ class ServerResource(ResourceBase):
            basepath=basepath,
            client=client,
            name=NAME,
+            methods=METHODS,
        )

    def get(self) -> ServerInfo:
@@ -27,6 +27,7 @@ class ServerResource(ResourceBase):
        Returns:
            dict -- the server info in dictionary form
        """
+        metrics.track(metrics.SERVER, self.account, {"name": "get"})
        query = gql(
            """
            query Server {
@@ -37,6 +38,11 @@ class ServerResource(ResourceBase):
                    adminContact
                    canonicalUrl
                    version
+                    roles {
+                        name
+                        description
+                        resourceTarget
+                    }
                    scopes {
                        name
                        description
@@ -46,60 +52,22 @@ class ServerResource(ResourceBase):
                        name
                        icon
                    }
-                    workspaces {
-                      workspacesEnabled
-                    }
                }
            }
            """
        )

-        server_info = self.make_request(
+        return self.make_request(
            query=query, return_type="serverInfo", schema=ServerInfo
        )

-        return server_info
-
-    def version(self) -> Tuple[Any, ...]:
-        """Get the server version
-
-        Returns:
-            the server version in the format (major, minor, patch, (tag, build))
-            eg (2, 6, 3) for a stable build and (2, 6, 4, 'alpha', 4711) for alpha
-        """
-        # not tracking as it will be called along with other mutations / queries
-        # as a check
-        query = gql(
-            """
-            query Server {
-                serverInfo {
-                    version
-                }
-            }
-            """
-        )
-        ver = self.make_request(
-            query=query, return_type=["serverInfo", "version"], parse_response=False
-        )
-        if isinstance(ver, Exception):
-            raise GraphQLException(
-                f"Could not get server version for {self.basepath}", [ver]
-            )
-
-        # pylint: disable=consider-using-generator; (list comp is faster)
-        return tuple(
-            [
-                int(segment) if segment.isdigit() else segment
-                for segment in re.split(r"\.|-", ver)
-            ]
-        )
-
    def apps(self) -> Dict:
        """Get the apps registered on the server

        Returns:
            dict -- a dictionary of apps registered on the server
        """
+        metrics.track(metrics.SERVER, self.account, {"name": "apps"})
        query = gql(
            """
            query Apps {
@@ -133,6 +101,7 @@ class ServerResource(ResourceBase):
        Returns:
            str -- the new API token. note: this is the only time you'll see the token!
        """
+        metrics.track(metrics.SERVER, self.account, {"name": "create_token"})
        query = gql(
            """
            mutation TokenCreate($token: ApiTokenCreateInput!) {
@@ -158,6 +127,7 @@ class ServerResource(ResourceBase):
        Returns:
            bool -- True if the token was successfully deleted
        """
+        metrics.track(metrics.SERVER, self.account, {"name": "revoke_token"})
        query = gql(
            """
            mutation TokenRevoke($token: String!) {
@@ -0,0 +1,475 @@
+from datetime import datetime, timezone
+from gql import gql
+from typing import List
+from specklepy.logging import metrics
+from specklepy.api.models import ActivityCollection, Stream
+from specklepy.api.resource import ResourceBase
+from specklepy.logging.exceptions import SpeckleException
+
+
+NAME = "stream"
+METHODS = ["list", "create", "get", "update", "delete", "search", "activity"]
+
+
+class Resource(ResourceBase):
+    """API Access class for streams"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+            methods=METHODS,
+        )
+
+        self.schema = Stream
+
+    def get(self, id: str, branch_limit: int = 10, commit_limit: int = 10) -> Stream:
+        """Get the specified stream from the server
+
+        Arguments:
+            id {str} -- the stream id
+            branch_limit {int} -- the maximum number of branches to return
+            commit_limit {int} -- the maximum number of commits to return
+
+        Returns:
+            Stream -- the retrieved stream
+        """
+        metrics.track(metrics.STREAM, self.account, {"name": "get"})
+        query = gql(
+            """
+            query Stream($id: String!, $branch_limit: Int!, $commit_limit: Int!) {
+                stream(id: $id) {
+                    id
+                    name
+                    role
+                    description
+                    isPublic
+                    createdAt
+                    updatedAt
+                    commentCount
+                    favoritesCount
+                    collaborators {
+                        id
+                        name
+                        role
+                        avatar
+                    }
+                    branches(limit: $branch_limit) {
+                        totalCount
+                        cursor
+                        items {
+                            id
+                            name
+                            description
+                            commits(limit: $commit_limit) {
+                                totalCount
+                                cursor
+                                items {
+                                    id
+                                    message
+                                    authorId
+                                    createdAt
+                                    authorName
+                                    referencedObject
+                                    sourceApplication
+                                }
+                              }
+                          }
+                      }
+                }
+            }
+          """
+        )
+
+        params = {"id": id, "branch_limit": branch_limit, "commit_limit": commit_limit}
+
+        return self.make_request(query=query, params=params, return_type="stream")
+
+    def list(self, stream_limit: int = 10) -> List[Stream]:
+        """Get a list of the user's streams
+
+        Arguments:
+            stream_limit {int} -- The maximum number of streams to return
+
+        Returns:
+            List[Stream] -- A list of Stream objects
+        """
+        metrics.track(metrics.STREAM, self.account, {"name": "get"})
+        query = gql(
+            """
+            query User($stream_limit: Int!) {
+                user {
+                    id
+                    bio
+                    name
+                    email
+                    avatar
+                    company
+                    verified
+                    profiles
+                    role
+                    streams(limit: $stream_limit) {
+                        totalCount
+                        cursor
+                        items {
+                            id
+                            name
+                            role
+                            isPublic
+                            createdAt
+                            updatedAt
+                            description
+                            commentCount
+                            favoritesCount
+                            collaborators {
+                                id
+                                name
+                                role
+                            }
+                          }
+                      }
+                  }
+            }
+          """
+        )
+
+        params = {"stream_limit": stream_limit}
+
+        return self.make_request(
+            query=query, params=params, return_type=["user", "streams", "items"]
+        )
+
+    def create(
+        self,
+        name: str = "Anonymous Python Stream",
+        description: str = "No description provided",
+        is_public: bool = True,
+    ) -> str:
+        """Create a new stream
+
+        Arguments:
+            name {str} -- the name of the string
+            description {str} -- a short description of the stream
+            is_public {bool} -- whether or not the stream can be viewed by anyone with the id
+
+        Returns:
+            id {str} -- the id of the newly created stream
+        """
+        metrics.track(metrics.STREAM, self.account, {"name": "create"})
+        query = gql(
+            """
+            mutation StreamCreate($stream: StreamCreateInput!) {
+              streamCreate(stream: $stream)
+            }
+        """
+        )
+
+        params = {
+            "stream": {"name": name, "description": description, "isPublic": is_public}
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type="streamCreate", parse_response=False
+        )
+
+    def update(
+        self, id: str, name: str = None, description: str = None, is_public: bool = None
+    ) -> bool:
+        """Update an existing stream
+
+        Arguments:
+            id {str} -- the id of the stream to be updated
+            name {str} -- the name of the string
+            description {str} -- a short description of the stream
+            is_public {bool} -- whether or not the stream can be viewed by anyone with the id
+
+        Returns:
+            bool -- whether the stream update was successful
+        """
+        metrics.track(metrics.STREAM, self.account, {"name": "update"})
+        query = gql(
+            """
+            mutation StreamUpdate($stream: StreamUpdateInput!) {
+                streamUpdate(stream: $stream)
+            }
+        """
+        )
+
+        params = {
+            "id": id,
+            "name": name,
+            "description": description,
+            "isPublic": is_public,
+        }
+        # remove None values so graphql doesn't cry
+        params = {"stream": {k: v for k, v in params.items() if v is not None}}
+
+        return self.make_request(
+            query=query, params=params, return_type="streamUpdate", parse_response=False
+        )
+
+    def delete(self, id: str) -> bool:
+        """Delete a stream given its id
+
+        Arguments:
+            id {str} -- the id of the stream to delete
+
+        Returns:
+            bool -- whether the deletion was successful
+        """
+        metrics.track(metrics.STREAM, self.account, {"name": "delete"})
+        query = gql(
+            """
+            mutation StreamDelete($id: String!) {
+                streamDelete(id: $id)
+            }
+            """
+        )
+
+        params = {"id": id}
+
+        return self.make_request(
+            query=query, params=params, return_type="streamDelete", parse_response=False
+        )
+
+    def search(
+        self,
+        search_query: str,
+        limit: int = 25,
+        branch_limit: int = 10,
+        commit_limit: int = 10,
+    ):
+        """Search for streams by name, description, or id
+
+        Arguments:
+            search_query {str} -- a string to search for
+            limit {int} -- the maximum number of results to return
+            branch_limit {int} -- the maximum number of branches to return
+            commit_limit {int} -- the maximum number of commits to return
+
+        Returns:
+            List[Stream] -- a list of Streams that match the search query
+        """
+        metrics.track(metrics.STREAM, self.account, {"name": "search"})
+        query = gql(
+            """
+            query StreamSearch($search_query: String!,$limit: Int!, $branch_limit:Int!, $commit_limit:Int!) {
+                streams(query: $search_query, limit: $limit) {
+                    items {
+                        id
+                        name
+                        role
+                        description
+                        isPublic
+                        createdAt
+                        updatedAt
+                        collaborators {
+                            id
+                            name
+                            role
+                            avatar
+                        }
+                        branches(limit: $branch_limit) {
+                            totalCount
+                            cursor
+                            items {
+                                id
+                                name
+                                description
+                                commits(limit: $commit_limit) {
+                                    totalCount
+                                    cursor
+                                    items {
+                                        id
+                                        referencedObject
+                                        message
+                                        authorName
+                                        authorId
+                                        createdAt
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+          """
+        )
+
+        params = {
+            "search_query": search_query,
+            "limit": limit,
+            "branch_limit": branch_limit,
+            "commit_limit": commit_limit,
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type=["streams", "items"]
+        )
+
+    def favorite(self, stream_id: str, favorited: bool = True):
+        """Favorite or unfavorite the given stream.
+
+        Arguments:
+            stream_id {str} -- the id of the stream to favorite / unfavorite
+            favorited {bool} -- whether to favorite (True) or unfavorite (False) the stream
+
+        Returns:
+            Stream -- the stream with its `id`, `name`, and `favoritedDate`
+        """
+        metrics.track(metrics.STREAM, self.account, {"name": "favorite"})
+        query = gql(
+            """
+            mutation StreamFavorite($stream_id: String!, $favorited: Boolean!) {
+                streamFavorite(streamId: $stream_id, favorited: $favorited) {
+                    id
+                    name
+                    favoritedDate
+                    favoritesCount
+                }
+            }
+            """
+        )
+
+        params = {
+            "stream_id": stream_id,
+            "favorited": favorited,
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type=["streamFavorite"]
+        )
+
+    def grant_permission(self, stream_id: str, user_id: str, role: str):
+        """Grant permissions to a user on a given stream
+
+        Arguments:
+            stream_id {str} -- the id of the stream to grant permissions to
+            user_id {str} -- the id of the user to grant permissions for
+            role {str} -- the role to grant the user
+
+        Returns:
+            bool -- True if the operation was successful
+        """
+        metrics.track(metrics.PERMISSION, self.account, {"name": "add", "role": role})
+        query = gql(
+            """
+            mutation StreamGrantPermission($permission_params: StreamGrantPermissionInput !) {
+                streamGrantPermission(permissionParams: $permission_params)
+            }
+            """
+        )
+
+        params = {
+            "permission_params": {
+                "streamId": stream_id,
+                "userId": user_id,
+                "role": role,
+            }
+        }
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamGrantPermission",
+            parse_response=False,
+        )
+
+    def revoke_permission(self, stream_id: str, user_id: str):
+        """Revoke permissions from a user on a given stream
+
+        Arguments:
+            stream_id {str} -- the id of the stream to revoke permissions from
+            user_id {str} -- the id of the user to revoke permissions from
+
+        Returns:
+            bool -- True if the operation was successful
+        """
+        metrics.track(metrics.PERMISSION, self.account, {"name": "revoke"})
+        query = gql(
+            """
+            mutation StreamRevokePermission($permission_params: StreamRevokePermissionInput !) {
+                streamRevokePermission(permissionParams: $permission_params)
+            }
+            """
+        )
+
+        params = {"permission_params": {"streamId": stream_id, "userId": user_id}}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamRevokePermission",
+            parse_response=False,
+        )
+
+    def activity(
+        self,
+        stream_id: str,
+        action_type: str = None,
+        limit: int = 20,
+        before: datetime = None,
+        after: datetime = None,
+        cursor: datetime = None,
+    ):
+        """
+        Get the activity from a given stream in an Activity collection. Step into the activity `items` for the list of activity.
+
+        Note: all timestamps arguments should be `datetime` of any tz as they will be converted to UTC ISO format strings
+
+        stream_id {str} -- the id of the stream to get activity from
+        action_type {str} -- filter results to a single action type (eg: `commit_create` or `commit_receive`)
+        limit {int} -- max number of Activity items to return
+        before {datetime} -- latest cutoff for activity (ie: return all activity _before_ this time)
+        after {datetime} -- oldest cutoff for activity (ie: return all activity _after_ this time)
+        cursor {datetime} -- timestamp cursor for pagination
+        """
+        query = gql(
+            """
+            query StreamActivity($stream_id: String!, $action_type: String, $before:DateTime, $after: DateTime, $cursor: DateTime, $limit: Int){
+                stream(id: $stream_id) {
+                    activity(actionType: $action_type, before: $before, after: $after, cursor: $cursor, limit: $limit) {
+                        totalCount
+                        cursor
+                        items {
+                            actionType
+                            info
+                            userId
+                            streamId
+                            resourceId
+                            resourceType
+                            message
+                            time
+                        }
+                    }
+                }
+            }
+            """
+        )
+        try:
+            params = {
+                "stream_id": stream_id,
+                "limit": limit,
+                "action_type": action_type,
+                "before": before.astimezone(timezone.utc).isoformat()
+                if before
+                else before,
+                "after": after.astimezone(timezone.utc).isoformat() if after else after,
+                "cursor": cursor.astimezone(timezone.utc).isoformat()
+                if cursor
+                else cursor,
+            }
+        except AttributeError as e:
+            raise SpeckleException(
+                "Could not get stream activity - `before`, `after`, and `cursor` must be in `datetime` format if provided",
+                ValueError,
+            ) from e
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type=["stream", "activity"],
+            schema=ActivityCollection,
+        )
--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
izzy lyseggen	fc7e3ca893	fix(serializer): wrap `traverse_base` moving `begin` and `end_write` to the seriazlier due to the new sqlite transport with batched writes necessitates a wrapper around `traverse_base` so end/begin write can be called once at the top level. just adding begin/end write to the original traversal method would make tons of calls to `end_write` since the traversal is recursive	2022-06-20 11:48:45 +01:00
izzy lyseggen	9a4635c561	fix(client): don't parse obj create response	2022-06-20 11:42:18 +01:00
izzy lyseggen	9f873333f5	fix(serializer): warn but don't throw if ref not found this is _not_ an issue with the transports, but an issue with using the graphql api to fetch objects. since you are only receiving one obj and none of the children, the transport has no way to find them and should simply return the reference as is. idk why anyone would really use `object.get` so tbh i'm not surprised no one has found this bug yet lol	2022-06-20 11:21:09 +01:00
izzy lyseggen	50c78d679e	style: formatting	2022-06-20 11:17:32 +01:00
izzy lyseggen	72dcb674eb	fix(serialization): move end and begin write	2022-06-20 07:52:58 +01:00
izzy lyseggen	9d038de3ab	chore: dev container update	2022-06-20 07:52:27 +01:00
Gergő Jedlicska	52a667f28e	add start and finish write method calls to base object serialize	2022-06-19 14:41:22 +02:00
Gergő Jedlicska	31cd12160b	update test fixture auth to non deprecated token based method	2022-06-19 14:40:50 +02:00
Gergő Jedlicska	22e7f18648	update to new circleci redis baseimage	2022-06-19 14:40:18 +02:00
Gergő Jedlicska	97815ead9d	Merge branch 'gergo/sqliteSpeedup' of github.com:specklesystems/specklepy into gergo/sqliteSpeedup	2022-06-19 14:06:18 +02:00
Gergő Jedlicska	332331465d	update CI versions	2022-06-19 14:04:38 +02:00
izzy lyseggen	b56f006103	ci: formatting	2022-06-17 17:21:06 +01:00
izzy lyseggen	1fdefc8929	ci: bump node version	2022-06-17 16:50:04 +01:00
izzy lyseggen	f51dd28e46	chore: upgrade gql3 also removed py-spy as it's not used and i was getting install errors :/	2022-06-17 16:29:28 +01:00
izzy lyseggen	e22bfd72ea	feat(transports): batching sqlite inserts	2022-06-17 16:15:47 +01:00
Gergő Jedlicska	739d8bc189	quick and hacky sqlite batching	2022-06-17 16:35:15 +02:00
				`@@ -1 +0,0 @@`
				`::: specklepy.api.resources.ActiveUserResource`
				`@@ -1 +0,0 @@`
				`::: specklepy.api.resources.FileImportResource`
				`@@ -1 +0,0 @@`
				`::: specklepy.api.resources.OtherUserResource`
				`@@ -1 +0,0 @@`
				`::: specklepy.api.resources.ProjectInviteResource`
				`@@ -1 +0,0 @@`
				`::: specklepy.api.resources.ProjectResource`
				`@@ -1 +0,0 @@`
				`::: specklepy.api.resources.SubscriptionResource`
				`@@ -1 +0,0 @@`
				`::: specklepy.api.resources.VersionResource`
				`@@ -1 +0,0 @@`
				`::: specklepy.api.resources.WorkspaceResource`
				`@@ -1 +0,0 @@`
				`::: specklepy.core.api.enums.ProjectVisibility`