Merge pull request #250 from specklesystems/gergo/nonGenericTFix

fix(typing): fix non generic typedefed lists and tuples

.circleci/config.yml

@@ -1,31 +1,33 @@
 version: 2.1
 
 orbs:
-  python: circleci/python@1.3.2
+  python: circleci/python@2.0.3
+  codecov: codecov/codecov@3.2.2
 
 jobs:
-  build:
+  test:
     docker:
       - image: "cimg/python:<<parameters.tag>>"
-      - image: "circleci/node:12"
-      - image: "circleci/redis:6"
-      - image: "circleci/postgres:12"
+      - 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:5f8cf11cba07ea6a54000243f9cb343b61cbba13"
+      - image: "speckle/speckle-server"
         command: ["bash", "-c", "/wait && node bin/www"]
         environment:
-          POSTGRES_URL: "localhost"
+          POSTGRES_URL: "127.0.0.1"
           POSTGRES_USER: "speckle"
           POSTGRES_PASSWORD: "speckle"
           POSTGRES_DB: "speckle2_test"
-          REDIS_URL: "redis://localhost"
+          REDIS_URL: "redis://127.0.0.1"
           SESSION_SECRET: "keyboard cat"
           STRATEGY_LOCAL: "true"
           CANONICAL_URL: "http://localhost:3000"
-          WAIT_HOSTS: localhost:5432, localhost:6379
+          WAIT_HOSTS: 127.0.0.1:5432, 127.0.0.1:6379
+          DISABLE_FILE_UPLOADS: "true"
     parameters:
       tag:
         default: "3.8"
@@ -38,27 +40,39 @@ jobs:
           name: upgrade pip
       - python/install-packages:
           pkg-manager: poetry
-      - run: poetry run pytest --version
+      - 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: "circleci/python:3.8"
+      - 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
+      - run: poetry publish -u __token__ -p $PYPI_TOKEN
 
 workflows:
   main:
     jobs:
-      - build:
+      - test:
           matrix:
             parameters:
-              tag: ["3.6", "3.7", "3.8", "3.9"]
-
-  publish:
-    jobs: 
+              tag: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+          filters:
+            tags:
+              only: /.*/
       - deploy:
+          context: pypi
+          requires:
+            - test
           filters:
             tags:
               only: /[0-9]+(\.[0-9]+)*/

.devcontainer/Dockerfile

@@ -0,0 +1,27 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/blob/main/containers/python-3/.devcontainer/base.Dockerfile
+
+# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6
+ARG VARIANT="3.10"
+FROM mcr.microsoft.com/vscode/devcontainers/python:${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="16"
+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

.devcontainer/devcontainer.json

@@ -0,0 +1,55 @@
+// 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.linting.pylintArgs": [
+			"--max-line-length=120"
+		],
+		"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"
+}

.devcontainer/docker-compose.yaml

@@ -0,0 +1,44 @@
+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
+    network_mode: host
+  redis:
+    image: cimg/redis:6.2
+    network_mode: host
+  speckle-server:
+    image: speckle/speckle-server:latest
+    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"
+    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:

.gitattributes

@@ -0,0 +1,3 @@
+* text=auto eol=lf
+*.{cmd,[cC][mM][dD]} text eol=crlf
+*.{bat,[bB][aA][tT]} text eol=crlf

.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md

@@ -1,25 +0,0 @@
----
-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!

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,113 @@
+---
+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!
+-->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,71 @@
+---
+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/
+-->

.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md

@@ -1,25 +0,0 @@
-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
-```

.github/pull_request_template.md

@@ -0,0 +1,102 @@
+<!---
+
+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..
+
+-->

.github/workflows/close-issue.yml

@@ -0,0 +1,77 @@
+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 }}

.github/workflows/open-issue.yml

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

.gitignore

@@ -1,3 +1,7 @@
+.tool-versions
+.envrc
+reports/
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -108,4 +112,4 @@ venv.bak/
 
 # other
 scratch.py
-settings.json
+settings.json

.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+repos:
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    hooks:
+      - id: ruff
+    rev: v0.0.186
+
+  - repo: https://github.com/commitizen-tools/commitizen
+    hooks:
+    - id: commitizen
+    - id: commitizen-branch
+      stages:
+      - push
+    rev: v2.38.0
+
+  - repo: https://github.com/pycqa/isort
+    rev: v5.11.3
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/psf/black
+    rev: 22.12.0
+    hooks:
+      - id: black
+        # It is recommended to specify the latest version of Python
+        # supported by your project here, or alternatively use
+        # pre-commit's default_language_version, see
+        # https://pre-commit.com/#top_level-default_language_version
+        # language_version: python3.11
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

.vscode/launch.json

@@ -4,6 +4,7 @@
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
+
     {
       "name": "Python: Current File",
       "type": "python",
@@ -13,10 +14,13 @@
       "justMyCode": false
     },
     {
-      "name": "Python: Test debug config",
+      "name": "Pytest",
       "type": "python",
-      "request": "test",
+      "request": "launch",
+      "program": "poetry",
+      "args": ["run", "pytest"],
       "console": "integratedTerminal",
+      "justMyCode": true
     }
   ]
-}
+}

README.md

@@ -1,17 +1,55 @@
-# speckle-py 🥧
+<h1 align="center">
+  <img src="https://user-images.githubusercontent.com/2679513/131189167-18ea5fe1-c578-47f6-9785-3748178e4312.png" width="150px"/><br/>
+  Speckle | specklepy 🐍
+</h1>
+<h3 align="center">
+    The Python SDK
+</h3>
+<p align="center"><b>Speckle</b> is the data infrastructure for the AEC industry.</p><br/>
 
-[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square&logo=discourse&logoColor=white)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/)
+<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>
 
-## Introduction
+# About Speckle
 
-> ⚠ This is the start of the Python client for Speckle 2.0. It is currently quite nebulous and may be trashed and rebuilt at any moment! It is compatible with Python 3.6+ ⚠
-> 
+What is Speckle? Check our ![YouTube Video Views](https://img.shields.io/youtube/views/B9humiSpHzM?label=Speckle%20in%201%20minute%20video&style=social)
 
-## Documentation
+### Features
 
-Comprehensive developer and user documentation can be found in our:
+- **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!
 
-#### 📚 [Speckle Docs website](https://speckle.guide/dev/)
+### 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
+
+
+# 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!
+
+Head to the [**📚 specklepy docs**](https://speckle.guide/dev/python.html) for more information and usage examples.
 
 ## Developing & Debugging
 
@@ -27,6 +65,12 @@ To execute any python script run `$ poetry run python my_script.py`
 
 > 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.
 
+### 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.
+
 ### 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:
@@ -34,112 +78,9 @@ It may be helpful to know where the local accounts and object cache dbs are stor
 - Linux: `$XDG_DATA_HOME` or by default `~/.local/share/Speckle`
 - Mac: `~/.config/Speckle`
 
-## Overview of functionality 
-
-The `SpeckleClient` is the entry point for interacting with the GraphQL API. You'll need to have a running server to use this.
-
-```py
-from specklepy.api.client import SpeckleClient
-from specklepy.api.credentials import get_default_account, get_local_accounts
-
-all_accounts = get_local_accounts() # get back a list
-account = get_default_account()
-
-client = SpeckleClient(host="localhost:3000", use_ssl=False)
-# client = SpeckleClient(host="yourserver.com") or whatever your host is
-
-client.authenticate(account.token)
-```
-
-Interacting with streams is meant to be intuitive and evocative of PySpeckle 1.0
-
-```py
-# get your streams
-stream_list = client.stream.list()
-
-# search your streams
-results = client.user.search("mech")
-
-# create a stream
-new_stream_id = client.stream.create(name="a shiny new stream")
-
-# get a stream
-new_stream = client.stream.get(id=new_stream_id)
-```
-
-New in 2.0: commits! Here are some basic commit interactions.
-
-```py
-# get list of commits
-commits = client.commit.list("stream id")
-
-# get a specific commit
-commit = client.commit.get("stream id", "commit id")
-
-# create a commit
-commit_id = client.commit.create("stream id", "object id", "this is a commit message to describe the commit")
-
-# delete a commit
-deleted = client.commit.delete("stream id", "commit id")
-```
-
-The `BaseObjectSerializer` is used for decomposing and serializing `Base` objects so they can be sent / received to the server. You can use it directly to get the id (hash) and a serializable object representation of the decomposed `Base`. You can learn more about the Speckle `Base` object [here](https://discourse.speckle.works/t/core-2-0-the-base-object/782) and the decomposition API [here](https://discourse.speckle.works/t/core-2-0-decomposition-api/911).
-
-```py
-from specklepy.objects.base import Base
-from specklepy.serialization.base_object_serializer import BaseObjectSerializer
-
-detached_base = Base()
-detached_base.name = "this will get detached"
-
-base_obj = Base()
-base_obj.name = "my base"
-base_obj["@nested"] = detached_base
-
-serializer = BaseObjectSerializer()
-hash, obj_dict = serializer.traverse_base(base_obj)
-```
-
-If you use the `operations`, you will not need to interact with the serializer directly as this will be taken care of for you. You will just need to provide a transport to indicate where the objects should be sent / received from. At the moment, just the `MemoryTransport` and the `ServerTransport` are fully functional at the moment. If you'd like to learn more about Transports in Speckle 2.0, have a look [here](https://discourse.speckle.works/t/core-2-0-transports/919).
-
-```py
-from specklepy.transports.memory import MemoryTransport
-from specklepy.api import operations
-
-transport = MemoryTransport()
-
-# this serialises the object and sends it to the transport
-hash = operations.send(base=base_obj, transports=[transport])
-
-# if the object had detached objects, you can see these as well
-saved_objects = transport.objects # a dict with the obj hash as the key
-
-# this receives and object from the given transport, deserialises it, and recomposes it into a base object
-received_base = operations.receive(obj_id=hash, remote_transport=transport)
-```
-
-You can also use the GraphQL API to send and receive objects.
-
-```py
-# create a test base object
-test_base = Base()
-test_base.testing = "a test base obj"
-
-# run it through the serialiser
-s = BaseObjectSerializer()
-hash, obj = s.traverse_base(test_base)
-
-# send it to the server
-objCreate = client.object.create(stream_id="stream id", objects=[obj])
-
-received_base = client.object.get("stream id", hash)
-```
-
-This doc is not complete - there's more to see so have a dive into the code and play around! Please feel free to provide feedback, submit issues, or discuss new features ✨
-
 ## Contributing
 
-Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md) for an overview of the best practices we try to follow.
+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.
 
 ## Community
 
@@ -147,7 +88,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
 

SECURITY.md

@@ -0,0 +1,12 @@
+# 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!

example/many_children.py

@@ -0,0 +1,63 @@
+import os
+import random
+import string
+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
+
+
+class Sub(Base):
+    bar: List[str]
+
+
+def random_string():
+    letters = string.ascii_lowercase
+    return "".join(random.choice(letters) for _ in range(10))
+
+
+BASE_PATH = SQLiteTransport.get_base_path("Speckle")
+
+
+def clean_db():
+    os.remove(Path(BASE_PATH, "Objects.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"
+        foo[f"@child_{i}"] = Sub(bar=["asdf", "bar", i, stuff])
+
+    if clean:
+        clean_db()
+    transport = SQLiteTransport()
+    start = time.time()
+    hash = operations.send(base=foo, transports=[transport])
+    send_time = time.time() - start
+
+    receive_start = time.time()
+    operations.receive(hash, transport)
+    receive_time = time.time() - receive_start
+    return send_time, receive_time
+
+
+if __name__ == "__main__":
+    sample_size = 4
+
+    test_permutations = [
+        (True, True),
+        (False, False),
+        (False, True),
+        (True, False),
+    ]
+    for clean, randomize in test_permutations:
+        print(f"CLEAN: {clean}, RANDOMIZE: {randomize}")
+        for child_count in [10, 100, 1000, 10000]:
+            print(f"\tCHILD COUNT: {child_count}")
+            for _ in range(sample_size):
+                send_time, receive_time = one_pass(clean, randomize, child_count)
+                print(f"\t\tSend: {send_time} Receive: {receive_time}")

example/send_receive.py

@@ -0,0 +1,15 @@
+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)

example/stream_objects.py

@@ -0,0 +1,39 @@
+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)

example/units_none.py

@@ -0,0 +1,36 @@
+from devtools import debug
+
+from specklepy.api import operations
+from specklepy.objects.geometry import Base
+from specklepy.objects.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)

example/using_speckle_base.py

@@ -1,10 +1,11 @@
 """This is an example showcasing the usage of speckle `Base` class."""
 
 # the speckle.objects module exposes all speckle provided classes
-from specklepy.objects import Base
-from specklepy.api import operations
 from devtools import debug
 
+from specklepy.api import operations
+from specklepy.objects import Base
+
 
 class ExampleSub(Base):
     """
@@ -50,10 +51,10 @@ if __name__ == "__main__":
     )
     # support for dynamic attributes
     custom_sub.extra_extra = "what is this?"
-    debug(custom_sub.json())
+    debug(custom_sub)
 
     serialized = operations.serialize(custom_sub)
     deserialized = operations.deserialize(serialized)
     # the only difference should be between the two data is that the deserialized
     # instance id attribute is not None.
-    debug(deserialized.json())
+    debug(deserialized)

patch_version.py

@@ -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("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()

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "specklepy"
-version = "2.2.3"
+version = "2.9.1"
 description = "The Python SDK for Speckle 2.0"
 readme = "README.md"
 authors = ["Speckle Systems <devops@speckle.systems>"]
@@ -8,20 +8,35 @@ license = "Apache-2.0"
 repository = "https://github.com/specklesystems/speckle-py"
 documentation = "https://speckle.guide/dev/py-examples.html"
 homepage = "https://speckle.systems/"
+packages = [
+  { include = "specklepy", from = "src" },
+]
 
 
 [tool.poetry.dependencies]
-python = "^3.6.5"
-pydantic = "^1.7.3"
+python = ">=3.7.2, <4.0"
+pydantic = "^1.9"
 appdirs = "^1.4.4"
-gql = {version = ">=3.0.0a6", extras = ["all"], allow-prereleases = true}
+gql = {extras = ["requests", "websockets"], version = "^3.3.0"}
+ujson = "^5.3.0"
+Deprecated = "^1.2.13"
+stringcase = "^1.2.0"
 
-[tool.poetry.dev-dependencies]
-black = "^20.8b1"
+[tool.poetry.group.dev.dependencies]
+black = "^22.8.0"
 isort = "^5.7.0"
-pytest = "^6.2.2"
+pytest = "^7.1.3"
 pytest-ordering = "^0.6"
-
+pytest-cov = "^3.0.0"
+devtools = "^0.8.0"
+pylint = "^2.14.4"
+mypy = "^0.982"
+pre-commit = "^2.20.0"
+commitizen = "^2.38.0"
+ruff = "^0.0.187"
+types-deprecated = "^1.2.9"
+types-ujson = "^5.6.0.0"
+types-requests = "^2.28.11.5"
 
 [tool.black]
 exclude = '''
@@ -40,9 +55,16 @@ exclude = '''
 '''
 include = '\.pyi?$'
 line-length = 88
-target-version = ["py36", "py37", "py38"]
+target-version = ["py37", "py38", "py39", "py310", "py311"]
 
 
+[tool.commitizen]
+name = "cz_conventional_commits"
+version = "2.9.2"
+tag_format = "$version"
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.isort]
+profile = "black"

specklepy/api/client.py

@@ -1,115 +0,0 @@
-import re
-from gql.client import SyncClientSession
-from specklepy.logging.exceptions import SpeckleException
-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, gql
-from gql.transport.requests import RequestsHTTPTransport
-from gql.transport.aiohttp import AIOHTTPTransport
-from gql.transport.websockets import WebsocketsTransport
-
-
-class SpeckleClient:
-    DEFAULT_HOST = "speckle.xyz"
-    USE_SSL = True
-
-    def __init__(self, host: str = DEFAULT_HOST, use_ssl: bool = USE_SSL) -> None:
-        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 = self.url + "/graphql"
-        self.ws_url = f"{ws_protocol}://{host}/graphql"
-        self.me = None
-
-        self.httpclient = Client(
-            transport=RequestsHTTPTransport(url=self.graphql, verify=True, retries=3)
-        )
-        self.wsclient = None
-
-        self._init_resources()
-
-        # Check compatibility with the server
-        try:
-            serverInfo = self.server.get()
-            if not isinstance(serverInfo, ServerInfo):
-                raise Exception("Couldn't get ServerInfo")
-        except Exception as ex:
-            raise SpeckleException(f"{self.url} is not a compatible Speckle Server", ex)
-
-    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.me = {"token": token}
-        headers = {
-            "Authorization": f"Bearer {self.me['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.me['token']}"},
-        )
-        self.httpclient = Client(transport=httptransport)
-        self.wsclient = Client(transport=wstransport)
-
-        self._init_resources()
-
-    def execute_query(self, query: str) -> Dict:
-        return self.httpclient.execute(query)
-
-    def _init_resources(self) -> None:
-        self.stream = stream.Resource(
-            me=self.me, basepath=self.url, client=self.httpclient
-        )
-        self.commit = commit.Resource(
-            me=self.me, basepath=self.url, client=self.httpclient
-        )
-        self.branch = branch.Resource(
-            me=self.me, basepath=self.url, client=self.httpclient
-        )
-        self.object = object.Resource(
-            me=self.me, basepath=self.url, client=self.httpclient
-        )
-        self.server = server.Resource(
-            me=self.me, basepath=self.url, client=self.httpclient
-        )
-        self.user = user.Resource(me=self.me, basepath=self.url, client=self.httpclient)
-        self.subscribe = subscriptions.Resource(
-            me=self.me,
-            basepath=self.ws_url,
-            client=self.wsclient,
-        )
-
-    def __getattr__(self, name):
-        try:
-            attr = getattr(resources, name)
-            return attr.Resource(me=self.me, basepath=self.url, client=self.httpclient)
-        except:
-            raise SpeckleException(
-                f"Method {name} is not supported by the SpeckleClient class"
-            )

specklepy/api/credentials.py

@@ -1,81 +0,0 @@
-import os
-from typing import List, Optional
-from pydantic import BaseModel
-from specklepy.api.models import ServerInfo
-from specklepy.transports.sqlite import SQLiteTransport
-from specklepy.logging.exceptions import SpeckleException
-
-
-class UserInfo(BaseModel):
-    name: str
-    email: str
-    company: Optional[str]
-    id: str
-
-
-class Account(BaseModel):
-    isDefault: bool = None
-    token: str
-    refreshToken: str = None
-    serverInfo: ServerInfo
-    userInfo: 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__()
-
-
-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,
-            )
-
-    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
-
-    return default

specklepy/api/models.py

@@ -1,118 +0,0 @@
-# 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]
-    createdAt: Optional[str]
-    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}, createdAt: {self.createdAt} )"
-
-    def __str__(self) -> str:
-        return self.__repr__()
-
-
-class Commits(BaseModel):
-    totalCount: Optional[int]
-    cursor: Optional[Any]
-    items: List[Commit] = []
-
-
-class Object(BaseModel):
-    id: Optional[str]
-    speckleType: Optional[str]
-    applicationId: Optional[str]
-    totalChildrenCount: Optional[int]
-    createdAt: Optional[str]
-
-
-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]
-    description: Optional[str]
-    isPublic: Optional[bool]
-    createdAt: Optional[str]
-    updatedAt: Optional[str]
-    collaborators: List[Collaborator] = []
-    branches: Optional[Branches]
-    commit: Optional[Commit]
-    object: Optional[Object]
-
-    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 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]

specklepy/api/resource.py

@@ -1,76 +0,0 @@
-from logging import error
-from specklepy.logging.exceptions import GraphQLException, SpeckleException
-from typing import Dict, List
-from gql.client import Client
-from gql.gql import gql
-from gql.transport.exceptions import TransportQueryError
-
-
-class ResourceBase(object):
-    def __init__(
-        self,
-        me: Dict,
-        basepath: str,
-        client: Client,
-        name: str,
-        methods: list,
-    ) -> None:
-        self.me = me
-        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:
-            return self.schema.parse_obj(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

specklepy/api/resources/stream.py

@@ -1,356 +0,0 @@
-from typing import Dict, List, Optional
-from gql import gql
-from specklepy.api.resource import ResourceBase
-from specklepy.api.models import Stream
-
-NAME = "stream"
-METHODS = [
-    "list",
-    "create",
-    "get",
-    "update",
-    "delete",
-    "search",
-]
-
-
-class Resource(ResourceBase):
-    """API Access class for streams"""
-
-    def __init__(self, me, basepath, client) -> None:
-        super().__init__(
-            me=me, 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
-        """
-        query = gql(
-            """
-            query Stream($id: String!, $branch_limit: Int!, $commit_limit: Int!) {
-              stream(id: $id) {
-                id
-                name
-                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 = {"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
-        """
-        query = gql(
-            """
-            query User($stream_limit: Int!) {
-              user {
-                id
-                email
-                name
-                bio
-                company
-                avatar
-                verified
-                profiles
-                role
-                streams(limit: $stream_limit) {
-                  totalCount
-                  cursor
-                  items {
-                    id
-                    name
-                    description
-                    isPublic
-                    createdAt
-                    updatedAt
-                    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
-        """
-        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
-        """
-        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
-        """
-        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
-        """
-        query = gql(
-            """
-            query StreamSearch($search_query: String!,$limit: Int!, $branch_limit:Int!, $commit_limit:Int!) {
-              streams(query: $search_query, limit: $limit) {
-                items {
-                  id
-                  name
-                  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 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
-        """
-        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
-        """
-        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,
-        )

specklepy/api/resources/user.py

@@ -1,120 +0,0 @@
-from specklepy.logging.exceptions import SpeckleException
-from typing import List, Optional
-from gql import gql
-from pydantic.main import BaseModel
-from specklepy.api.resource import ResourceBase
-from specklepy.api.models import User
-
-NAME = "user"
-METHODS = ["get"]
-
-
-class Resource(ResourceBase):
-    """API Access class for users"""
-
-    def __init__(self, me, basepath, client) -> None:
-        super().__init__(
-            me=me, basepath=basepath, client=client, name=NAME, methods=METHODS
-        )
-        self.schema = User
-
-    def get(self, id: str = None) -> User:
-        """Gets the profile of a user. If no id argument is provided, will return the current authenticated user's profile (as extracted from the authorization header).
-
-        Arguments:
-            id {str} -- the user id
-
-        Returns:
-            User -- the retrieved user
-        """
-        query = gql(
-            """
-            query User($id: String) {
-                user(id: $id) {
-                    id
-                    email
-                    name
-                    bio
-                    company
-                    avatar
-                    verified
-                    profiles
-                    role
-                }
-            }
-          """
-        )
-
-        params = {"id": id}
-
-        return self.make_request(query=query, params=params, return_type="user")
-
-    def search(self, search_query: str, limit: int = 25) -> List[User]:
-        """Searches for user by name or email. The search query must be at least 3 characters long
-
-        Arguments:
-            search_query {str} -- a string to search for
-            limit {int} -- the maximum number of results to return
-        Returns:
-            List[User] -- a list of User objects that match the search query
-        """
-        if len(search_query) < 3:
-            return SpeckleException(
-                message="User search query must be at least 3 characters"
-            )
-
-        query = gql(
-            """
-            query UserSearch($search_query: String!, $limit: Int!) {
-                userSearch(query: $search_query, limit: $limit) {
-                    items {
-                        id
-                        name
-                        bio
-                        company
-                        avatar
-                        verified
-                    }
-                }
-            }
-          """
-        )
-        params = {"search_query": search_query, "limit": limit}
-
-        return self.make_request(
-            query=query, params=params, return_type=["userSearch", "items"]
-        )
-
-    def update(
-        self, name: str = None, company: str = None, bio: str = None, avatar: str = None
-    ):
-        """Updates your user profile. All arguments are optional.
-
-        Arguments:
-            name {str} -- your name
-            company {str} -- the company you may or may not work for
-            bio {str} -- tell us about yourself
-            avatar {str} -- a nice photo of yourself
-
-        Returns:
-            bool -- True if your profile was updated successfully
-        """
-        query = gql(
-            """
-            mutation UserUpdate($user: UserUpdateInput!) {
-                userUpdate(user: $user)
-            }
-            """
-        )
-        params = {"name": name, "company": company, "bio": bio, "avatar": avatar}
-
-        params = {"user": {k: v for k, v in params.items() if v is not None}}
-
-        if not params["user"]:
-            return SpeckleException(
-                message="You must provide at least one field to update your user profile"
-            )
-
-        return self.make_request(
-            query=query, params=params, return_type="userUpdate", parse_response=False
-        )

specklepy/api/speckle2schema.graphql

@@ -1,640 +0,0 @@
-
-      
-scalar DateTime
-
-scalar EmailAddress
-
-scalar BigInt
-
-scalar JSONObject
-
-
-      directive @hasScope(scope: String!) on FIELD_DEFINITION
-      directive @hasRole(role: String!) on FIELD_DEFINITION
-
-      type Query {
-      """
-      Stare into the void.
-      """
-        _: String
-      }
-      type Mutation{
-      """
-      The void stares back.
-      """
-      _: String
-      }
-      type Subscription{
-        """
-        It's lonely in the void.
-        """
-        _: String
-      },extend type Query {
-  """
-  Gets a specific app from the server.
-  """
-  app( id: String! ): ServerApp
-
-  """
-  Returns all the publicly available apps on this server.
-  """
-  apps: [ServerAppListItem]
-}
-
-type ServerApp {
-  id: String!
-  secret: String!
-  name: String!
-  description: String
-  termsAndConditionsLink: String
-  logo: String
-  public: Boolean
-  trustByDefault: Boolean
-  author: AppAuthor
-  createdAt: DateTime!
-  redirectUrl: String!
-  scopes: [Scope]!
-}
-
-type ServerAppListItem {
-  id: String!
-  name: String!
-  description: String
-  termsAndConditionsLink: String
-  logo: String
-  author: AppAuthor
-}
-
-type AppAuthor {
-  name: String
-  id: String
-}
-
-extend type User {
-  """
-  Returns the apps you have authorized.
-  """
-  authorizedApps: [ServerAppListItem]
-    @hasRole(role: "server:user")
-    @hasScope(scope: "apps:read")
-
-  """
-  Returns the apps you have created.
-  """
-  createdApps: [ServerAppListItem]
-    @hasRole(role: "server:user")
-    @hasScope(scope: "apps:read")
-}
-
-extend type Mutation {
-  """
-  Register a new third party application.
-  """
-  appCreate(app: AppCreateInput!): String!
-    @hasRole(role: "server:user")
-    @hasScope(scope: "apps:write")
-
-  """
-  Update an existing third party application. **Note: This will invalidate all existing tokens, refresh tokens and access codes and will require existing users to re-authorize it.**
-  """
-  appUpdate(app: AppUpdateInput!): Boolean!
-    @hasRole(role: "server:user")
-    @hasScope(scope: "apps:write")
-
-  """
-  Deletes a thirty party application.
-  """
-  appDelete(appId: String!): Boolean!
-    @hasRole(role: "server:user")
-    @hasScope(scope: "apps:write")
-
-  """
-  Revokes (de-authorizes) an application that you have previously authorized.
-  """
-  appRevokeAccess(appId: String!): Boolean
-    @hasRole(role: "server:user")
-    @hasScope(scope: "apps:write")
-
-}
-
-input AppCreateInput {
-  name: String!
-  description: String!
-  termsAndConditionsLink: String
-  logo: String
-  public: Boolean
-  redirectUrl: String!
-  scopes: [String]!
-}
-
-input AppUpdateInput {
-  id: String!
-  name: String!
-  description: String!
-  termsAndConditionsLink: String
-  logo: String
-  public: Boolean
-  redirectUrl: String!
-  scopes: [String]!
-}
-,extend type ServerInfo {
-  """
-  The authentication strategies available on this server.
-  """
-  authStrategies: [AuthStrategy]
-}
-
-type AuthStrategy {
-  id: String!,
-  name: String!,
-  icon: String!,
-  url: String!,
-  color: String
-}
-,extend type User{
-  """
-  Returns a list of your personal api tokens.
-  """
-  apiTokens: [ApiToken]
-    @hasRole(role: "server:user")
-    @hasScope(scope: "tokens:read")
-}
-
-type ApiToken {
-  id: String!
-  name: String!
-  lastChars: String!
-  scopes: [String]!
-  createdAt: DateTime! #date
-  lifespan: BigInt!
-  lastUsed: String! #date
-}
-
-input ApiTokenCreateInput {
-  scopes: [String!]!,
-  name: String!,
-  lifespan: BigInt
-}
-
-extend type Mutation {
-  """
-  Creates an personal api token.
-  """
-  apiTokenCreate(token: ApiTokenCreateInput!):String!
-    @hasRole(role: "server:user")
-    @hasScope(scope: "tokens:write")
-  """
-  Revokes (deletes) an personal api token.
-  """
-  apiTokenRevoke(token: String!):Boolean!
-    @hasRole(role: "server:user")
-    @hasScope(scope: "tokens:write")
-}
-,extend type Stream {
-  commits(limit: Int! = 25, cursor: String): CommitCollection
-  commit(id: String!): Commit
-  branches(limit: Int! = 25, cursor: String): BranchCollection
-  branch(name: String!): Branch
-}
-
-extend type User {
-  commits(limit: Int! = 25, cursor: String): CommitCollectionUser
-}
-
-type Branch {
-  id: String!
-  name: String!
-  author: User!
-  description: String
-  commits(limit: Int! = 25, cursor: String): CommitCollection
-}
-
-type Commit {
-  id: String!
-  referencedObject: String!
-  message: String
-  authorName: String
-  authorId: String
-  createdAt: DateTime
-}
-
-type CommitCollectionUserNode {
-  id: String!
-  referencedObject: String!
-  message: String
-  streamId: String
-  streamName: String
-  createdAt: DateTime
-}
-
-type BranchCollection {
-  totalCount: Int!
-  cursor: String
-  items: [Branch]
-}
-
-type CommitCollection {
-  totalCount: Int!
-  cursor: String
-  items: [Commit]
-}
-
-type CommitCollectionUser {
-  totalCount: Int!
-  cursor: String
-  items: [CommitCollectionUserNode]
-}
-
-extend type Mutation {
-  branchCreate(branch: BranchCreateInput!): String!
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:write")
-  branchUpdate(branch: BranchUpdateInput!): Boolean!
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:write")
-  branchDelete(branch: BranchDeleteInput!): Boolean!
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:write")
-
-  commitCreate(commit: CommitCreateInput!): String!
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:write")
-  commitUpdate(commit: CommitUpdateInput!): Boolean!
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:write")
-  commitDelete(commit: CommitDeleteInput!): Boolean!
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:write")
-}
-
-extend type Subscription {
-  # TODO: auth for these subscriptions
-  """
-  Subscribe to branch created event
-  """
-  branchCreated(streamId: String!): JSONObject
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:read")
-  """
-  Subscribe to branch updated event.
-  """
-  branchUpdated(streamId: String!, branchId: String): JSONObject
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:read")
-  """
-  Subscribe to branch deleted event
-  """
-  branchDeleted(streamId: String!): JSONObject
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:read")
-
-  """
-  Subscribe to commit created event
-  """
-  commitCreated(streamId: String!): JSONObject
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:read")
-  """
-  Subscribe to commit updated event.
-  """
-  commitUpdated(streamId: String!, commitId: String): JSONObject
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:read")
-  """
-  Subscribe to commit deleted event
-  """
-  commitDeleted(streamId: String!): JSONObject
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:read")
-}
-
-input BranchCreateInput {
-  streamId: String!
-  name: String!
-  description: String
-}
-
-input BranchUpdateInput {
-  streamId: String!
-  id: String!
-  name: String
-  description: String
-}
-
-input BranchDeleteInput {
-  streamId: String!
-  id: String!
-}
-
-input CommitCreateInput {
-  streamId: String!
-  branchName: String!
-  objectId: String!
-  message: String
-  previousCommitIds: [String]
-}
-
-input CommitUpdateInput {
-  streamId: String!
-  id: String!
-  message: String!
-}
-
-input CommitDeleteInput {
-  streamId: String!
-  id: String!
-}
-,extend type Stream {
-  object( id: String! ): Object
-}
-
-type Object {
-  id: String! 
-  speckleType: String!
-  applicationId: String
-  createdAt: DateTime
-  totalChildrenCount: Int
-  """
-  The full object, with all its props & other things. **NOTE:** If you're requesting objects for the purpose of recreating & displaying, you probably only want to request this specific field.
-  """
-  data: JSONObject
-  """
-  Get any objects that this object references. In the case of commits, this will give you a commit's constituent objects.
-  **NOTE**: Providing any of the two last arguments ( `query`, `orderBy` ) will trigger a different code branch that executes a much more expensive SQL query. It is not recommended to do so for basic clients that are interested in purely getting all the objects of a given commit.
-  """
-  children(
-    limit: Int! = 100, 
-    depth: Int! = 50, 
-    select: [String], 
-    cursor: String, 
-    query: [JSONObject!],
-    orderBy: JSONObject  ): ObjectCollection!
-}
-
-type ObjectCollection {
-  totalCount: Int!
-  cursor: String
-  objects: [Object]!
-}
-
-extend type Mutation {
-  objectCreate( objectInput: ObjectCreateInput! ): [String]!
-}
-
-input ObjectCreateInput {
-  """
-  The stream against which these objects will be created. 
-  """
-  streamId: String!
-  """
-  The objects you want to create.
-  """
-  objects: [JSONObject]!
-},extend type Query {
-  serverInfo: ServerInfo!
-}
-
-"""
-Information about this server.
-"""
-type ServerInfo {
-  name: String!
-  company: String
-  description: String
-  adminContact: String
-  canonicalUrl: String
-  termsOfService: String
-  roles: [Role]!
-  scopes: [Scope]!
-}
-
-"""
-Available roles.
-"""
-type Role {
-  name: String!
-  description: String!
-  resourceTarget: String!
-}
-
-"""
-Available scopes.
-"""
-type Scope {
-  name: String!
-  description: String!
-}
-
-extend type Mutation {
-  serverInfoUpdate(info: ServerInfoUpdateInput!): Boolean
-    @hasRole(role: "server:admin")
-    @hasScope(scope: "server:setup")
-}
-
-input ServerInfoUpdateInput {
-  name: String!
-  company: String
-  description: String
-  adminContact: String
-  termsOfService: String
-}
-,extend type Query {
-  """
-  Returns a specific stream.
-  """
-  stream( id: String! ): Stream
-
-  """
-  All the streams of the current user, pass in the `query` parameter to seach by name, description or ID.
-  """
-  streams( query: String, limit: Int = 25, cursor: String ): StreamCollection
-    @hasScope(scope: "streams:read")
-}
-
-type Stream {
-  id: String!
-  name: String!
-  description: String
-  isPublic: Boolean!
-  createdAt: DateTime!
-  updatedAt: DateTime!
-  collaborators: [ StreamCollaborator ]!
-}
-
-extend type User {
-  """
-  All the streams that a user has access to.
-  """
-  streams( limit: Int! = 25, cursor: String ): StreamCollection
-}
-
-type StreamCollaborator {
-  id: String!
-  name: String!
-  role: String!
-  company: String
-  avatar: String
-}
-
-type StreamCollection {
-  totalCount: Int!
-  cursor: String
-  items: [ Stream ]
-}
-
-
-extend type Mutation {
-  """
-  Creates a new stream.
-  """
-  streamCreate( stream: StreamCreateInput! ): String
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:write")
-  """
-  Updates an existing stream.
-  """
-  streamUpdate( stream: StreamUpdateInput! ): Boolean!
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:write")
-  """
-  Deletes an existing stream.
-  """
-  streamDelete( id: String! ): Boolean!
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:write")
-  """
-  Grants permissions to a user on a given stream.
-  """
-  streamGrantPermission( permissionParams: StreamGrantPermissionInput! ): Boolean
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:write")
-  """
-  Revokes the permissions of a user on a given stream.
-  """
-  streamRevokePermission( permissionParams: StreamRevokePermissionInput! ): Boolean
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:write")
-}
-
-extend type Subscription {
-
-  #
-  # User bound subscriptions that operate on the stream collection of an user
-  # Example relevant view/usecase: updating the list of streams for a user.
-  #
-
-  """
-  Subscribes to new stream added event for your profile. Use this to display an up-to-date list of streams.
-  **NOTE**: If someone shares a stream with you, this subscription will be triggered with an extra value of `sharedBy` in the payload.
-  """
-  userStreamAdded: JSONObject
-    @hasRole(role: "server:user")
-    @hasScope(scope: "profile:read")
-
-  """
-  Subscribes to stream removed event for your profile. Use this to display an up-to-date list of streams for your profile.
-  **NOTE**: If someone revokes your permissions on a stream, this subscription will be triggered with an extra value of `revokedBy` in the payload.
-  """
-  userStreamRemoved: JSONObject
-    @hasRole(role: "server:user")
-    @hasScope(scope: "profile:read")
-
-  #
-  # Stream bound subscriptions that operate on the stream itself.
-  # Example relevant view/usecase: a single stream connector, or view, or component in a web app
-  #
-
-  """
-  Subscribes to stream updated event. Use this in clients/components that pertain only to this stream.
-  """
-  streamUpdated( streamId: String ): JSONObject
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:read")
-
-  """
-  Subscribes to stream deleted event. Use this in clients/components that pertain only to this stream.
-  """
-  streamDeleted( streamId: String ): JSONObject
-    @hasRole(role: "server:user")
-    @hasScope(scope: "streams:read")
-
-}
-
-input StreamCreateInput {
-  name: String
-  description: String
-  isPublic: Boolean
-}
-
-input StreamUpdateInput {
-  id: String!
-  name: String
-  description: String
-  isPublic: Boolean
-}
-
-input StreamGrantPermissionInput {
-  streamId: String!,
-  userId: String!,
-  role: String!
-}
-
-input StreamRevokePermissionInput {
-  streamId: String!,
-  userId: String!
-}
-,extend type Query {
-  """
-  Gets the profile of a user. If no id argument is provided, will return the current authenticated user's profile (as extracted from the authorization header).
-  """
-  user(id: String): User
-  userSearch(
-    query: String!
-    limit: Int! = 25
-    cursor: String
-  ): UserSearchResultCollection
-  userPwdStrength(pwd: String!): JSONObject
-}
-
-"""
-Base user type.
-"""
-type User {
-  id: String!
-  suuid: String
-  email: String
-  name: String
-  bio: String
-  company: String
-  avatar: String
-  verified: Boolean
-  profiles: JSONObject
-  role: String
-}
-
-type UserSearchResultCollection {
-  cursor: String
-  items: [UserSearchResult]
-}
-
-type UserSearchResult {
-  id: String!
-  name: String
-  bio: String
-  company: String
-  avatar: String
-  verified: Boolean
-}
-
-extend type Mutation {
-  """
-  Edits a user's profile.
-  """
-  userUpdate(user: UserUpdateInput!): Boolean!
-}
-
-input UserUpdateInput {
-  name: String
-  company: String
-  bio: String
-}

specklepy/logging/exceptions.py

@@ -1,30 +0,0 @@
-from typing import Any, List
-
-
-class SpeckleException(Exception):
-    def __init__(self, message: str, exception: Exception = None) -> None:
-        self.message = message
-        self.exception = exception
-
-    def __str__(self) -> str:
-        return f"SpeckleException: {self.message}"
-
-
-class SerializationException(SpeckleException):
-    def __init__(self, message: str, object: Any, exception: Exception = None) -> None:
-        super().__init__(message=message)
-        self.object = object
-        self.unhandled_type = type(object)
-
-    def __str__(self) -> str:
-        return f"SpeckleException: Could not serialize object of type {self.unhandled_type}"
-
-
-class GraphQLException(SpeckleException):
-    def __init__(self, message: str, errors: List, data=None) -> None:
-        super().__init__(message=message)
-        self.errors = errors
-        self.data = data
-
-    def __str__(self) -> str:
-        return f"GraphQLException: {self.message}"

specklepy/objects/__init__.py

@@ -1,5 +0,0 @@
-"""Builtin Speckle object kit."""
-
-from specklepy.objects.base import Base
-
-__all__ = ["Base"]

specklepy/objects/base.py

@@ -1,257 +0,0 @@
-from inspect import getattr_static
-from pydantic import BaseModel, validator
-from pydantic.main import Extra
-from typing import ClassVar, Dict, List, Optional, Any, Set, Type
-from specklepy.transports.memory import MemoryTransport
-from specklepy.logging.exceptions import SpeckleException
-from specklepy.objects.units import get_units_from_string
-
-PRIMITIVES = (int, float, str, bool)
-
-
-class _RegisteringBase(BaseModel):
-    """
-    Private Base model for Speckle types.
-
-    This is an implementation detail, please do not use this outside this module.
-
-    This class provides automatic registration of `speckle_type` into a global,
-    (class level) registry for each subclassing type.
-    The type registry is a base for accurate type based (de)serialization.
-    """
-
-    speckle_type: ClassVar[str]
-    _type_registry: ClassVar[Dict[str, Type["Base"]]] = {}
-
-    class Config:
-        validate_assignment = True
-
-    @classmethod
-    def get_registered_type(cls, speckle_type: str) -> Optional[Type["Base"]]:
-        """Get the registered type from the protected mapping via the `speckle_type`"""
-        return cls._type_registry.get(speckle_type, None)
-
-    def __init_subclass__(
-        cls,
-        speckle_type: Optional[str] = None,
-        **kwargs: Dict[str, Any],
-    ):
-        """
-        Hook into subclass type creation.
-
-        This is provides a mechanism to hook into the event of the subclass type object
-        initialization. This is reused to register each subclassing type into a class
-        level dictionary.
-        """
-        if speckle_type in cls._type_registry:
-            raise ValueError(
-                f"The speckle_type: {speckle_type} is already registered for type: "
-                f"{cls._type_registry[speckle_type].__name__}. "
-                f"Please choose a different type name."
-            )
-        cls.speckle_type = speckle_type or cls.__name__
-        cls._type_registry[cls.speckle_type] = cls  # type: ignore
-        super().__init_subclass__(**kwargs)
-
-
-class Base(_RegisteringBase):
-    id: Optional[str] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[str] = None
-    _units: str = "m"
-    _chunkable: Dict[str, int] = {}  # dict of chunkable props and their max chunk size
-    _chunk_size_default: int = 1000
-    _detachable: Set[str] = set()  # list of defined detachable props
-
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}(id: {self.id}, "
-            f"speckle_type: {self.speckle_type}, "
-            f"totalChildrenCount: {self.totalChildrenCount})"
-        )
-
-    def __str__(self) -> str:
-        return self.__repr__()
-
-    def __setitem__(self, name: str, value: Any) -> None:
-        self.validate_prop_name(name)
-        self.__dict__[name] = value
-
-    def __getitem__(self, name: str) -> Any:
-        return self.__dict__[name]
-
-    def __setattr__(self, name: str, value: Any) -> None:
-        """
-        Guard attribute and property set mechanism.
-
-        The `speckle_type` is a protected class attribute it must not be overridden.
-        """
-        if name != "speckle_type":
-            attr = getattr(self.__class__, name, None)
-            if isinstance(attr, property):
-                try:
-                    attr.__set__(self, value)
-                except AttributeError:
-                    pass  # the prop probably doesn't have a setter
-            super().__setattr__(name, value)
-
-    @classmethod
-    def validate_prop_name(cls, name: str) -> None:
-        """Validator for dynamic attribute names."""
-        if name in ("", "@"):
-            raise ValueError("Invalid Name: Base member names cannot be empty strings")
-        if name.startswith("@@"):
-            raise ValueError(
-                "Invalid Name: Base member names cannot start with more than one '@'",
-            )
-        if "." in name or "/" in name:
-            raise ValueError(
-                "Invalid Name: Base member names cannot contain characters '.' or '/'",
-            )
-
-    def add_chunkable_attrs(self, **kwargs: int) -> None:
-        """
-        Mark defined attributes as chunkable for serialisation
-
-        Arguments:
-            kwargs {int} -- the name of the attribute as the keyword and the chunk size as the arg
-        """
-        chunkable = {k: v for k, v in kwargs.items() if isinstance(v, int)}
-        self._chunkable = dict(self._chunkable, **chunkable)
-
-    def add_detachable_attrs(self, names: Set[str]) -> None:
-        """
-        Mark defined attributes as detachable for serialisation
-
-        Arguments:
-            names {Set[str]} -- the names of the attributes to detach as a set of strings
-        """
-        self._detachable = self._detachable.union(names)
-
-    @property
-    def units(self):
-        return self._units
-
-    @units.setter
-    def units(self, value: str):
-        self._units = get_units_from_string(value)
-
-    def to_dict(self) -> Dict[str, Any]:
-        """Convenience method to view the whole base object as a dict"""
-        base_dict = self.__dict__
-        for key, value in base_dict.items():
-            if not value or isinstance(value, PRIMITIVES):
-                continue
-            else:
-                base_dict[key] = self.__dict_helper(value)
-        return base_dict
-
-    def __dict_helper(self, obj: Any) -> Any:
-        if not obj or isinstance(obj, PRIMITIVES):
-            return obj
-        if isinstance(obj, Base):
-            return self.__dict_helper(obj.__dict__)
-        if isinstance(obj, (list, set)):
-            return [self.__dict_helper(v) for v in obj]
-        if not isinstance(obj, dict):
-            raise SpeckleException(
-                message=f"Could not convert to dict due to unrecognized type: {type(obj)}"
-            )
-
-        for k, v in obj.items():
-            if v and not isinstance(obj, PRIMITIVES):
-                obj[k] = self.__dict_helper(v)
-        return obj
-
-    def get_member_names(self) -> List[str]:
-        """Get all of the property names on this object, dynamic or not"""
-        attrs = list(self.__dict__.keys())
-        properties = [
-            name
-            for name in dir(self)
-            if not name.startswith("_")
-            and name
-            != "fields"  # soon to be removed as this pydantic prop is depreciated
-            and isinstance(getattr(self, name, None), property)
-        ]
-        return attrs + properties
-
-    def get_typed_member_names(self) -> List[str]:
-        """Get all of the names of the defined (typed) properties of this object"""
-        return list(self.__fields__.keys())
-
-    def get_dynamic_member_names(self) -> List[str]:
-        """Get all of the names of the dynamic properties of this object"""
-        return list(set(self.__dict__.keys()) - set(self.__fields__.keys()))
-
-    def get_children_count(self) -> int:
-        """Get the total count of children Base objects"""
-        parsed = []
-        return 1 + self._count_descendants(self, parsed)
-
-    def get_id(self, decompose: bool = False) -> str:
-        """
-        Gets the id (a unique hash) of this object. ⚠️ This method fully serializes the object, which in the case of large objects (with many sub-objects), has a tangible cost. Avoid using it!
-
-        Note: the hash of a decomposed object differs from that of a non-decomposed object
-
-        Arguments:
-            decompose {bool} -- if True, will decompose the object in the process of hashing it
-
-        Returns:
-            str -- the hash (id) of the fully serialized object
-        """
-        from specklepy.serialization.base_object_serializer import (
-            BaseObjectSerializer,
-        )
-
-        serializer = BaseObjectSerializer()
-        if decompose:
-            serializer.write_transports = [MemoryTransport()]
-        return serializer.traverse_base(self)[0]
-
-    def _count_descendants(self, base: "Base", parsed: List) -> int:
-        if base in parsed:
-            return 0
-        parsed.append(base)
-
-        count = 0
-
-        for name, value in base.__dict__.items():
-            if name.startswith("@"):
-                continue
-            else:
-                count += self._handle_object_count(value, parsed)
-
-        return count
-
-    def _handle_object_count(self, obj: Any, parsed: List) -> int:
-        count = 0
-        if obj is None:
-            return count
-        if isinstance(obj, "Base"):
-            count += 1
-            count += self._count_descendants(obj, parsed)
-            return count
-        elif isinstance(obj, list):
-            for item in obj:
-                if isinstance(item, "Base"):
-                    count += 1
-                    count += self._count_descendants(item, parsed)
-                else:
-                    count += self._handle_object_count(item, parsed)
-        elif isinstance(obj, dict):
-            for _, value in obj.items():
-                if isinstance(value, "Base"):
-                    count += 1
-                    count += self._count_descendants(value, parsed)
-                else:
-                    count += self._handle_object_count(value, parsed)
-        return count
-
-    class Config:
-        extra = Extra.allow
-
-
-class DataChunk(Base, speckle_type="Speckle.Core.Models.DataChunk"):
-    data: List[Any] = []

specklepy/objects/fakemesh.py

@@ -1,38 +0,0 @@
-from specklepy.objects.geometry import Point
-from typing import List
-
-from .base import Base
-
-CHUNKABLE_PROPS = {
-    "vertices": 100,
-    "faces": 100,
-    "colors": 100,
-    "textureCoordinates": 100,
-    "test_bases": 10,
-}
-
-DETACHABLE = {"detach_this", "origin", "detached_list"}
-
-
-class FakeMesh(Base):
-    vertices: List[float] = None
-    faces: List[int] = None
-    colors: List[int] = None
-    textureCoordinates: List[float] = None
-    test_bases: List[Base] = None
-    detach_this: Base = None
-    detached_list: List[Base] = None
-    _origin: Point = None
-
-    def __init__(self, **kwargs) -> None:
-        super(FakeMesh, self).__init__(**kwargs)
-        self.add_chunkable_attrs(**CHUNKABLE_PROPS)
-        self.add_detachable_attrs(DETACHABLE)
-
-    @property
-    def origin(self):
-        return self._origin
-
-    @origin.setter
-    def origin(self, value: Point):
-        self._origin = value

specklepy/objects/geometry.py

@@ -1,351 +0,0 @@
-from .base import Base
-from typing import Any, List
-
-GEOMETRY = "Objects.Geometry."
-
-
-class Interval(Base, speckle_type="Objects.Primitive.Interval"):
-    start: float = 0
-    end: float = 0
-
-    def length(self):
-        return abs(self.start - self.end)
-
-
-class Point(Base, speckle_type=GEOMETRY + "Point"):
-    x: float = 0
-    y: float = 0
-    z: float = 0
-
-    def __init__(self, x: float = 0, y: float = 0, z: float = 0, **data: Any) -> None:
-        super().__init__(**data)
-        self.x, self.y, self.z = x, y, z
-
-    def __repr__(self) -> str:
-        return f"{self.__class__.__name__}(x: {self.x}, y: {self.y}, z: {self.z}, id: {self.id}, speckle_type: {self.speckle_type})"
-
-
-class Vector(Point, speckle_type=GEOMETRY + "Vector"):
-    pass
-
-
-class ControlPoint(Point, speckle_type=GEOMETRY + "ControlPoint"):
-    weight: float = None
-
-
-class Plane(Base, speckle_type=GEOMETRY + "Plane"):
-    origin: Point = Point()
-    normal: Vector = Vector()
-    xdir: Vector = Vector()
-    ydir: Vector = Vector()
-
-
-class Box(Base, speckle_type=GEOMETRY + "Box"):
-    basePlane: Plane = Plane()
-    ySize: Interval = Interval()
-    zSize: Interval = Interval()
-    xSize: Interval = Interval()
-    area: float = None
-    volume: float = None
-
-
-class Line(Base, speckle_type=GEOMETRY + "Line"):
-    start: Point = Point()
-    end: Point = None
-    domain: Interval = None
-    bbox: Box = None
-    length: float = None
-
-
-class Arc(Base, speckle_type=GEOMETRY + "Arc"):
-    radius: float = None
-    startAngle: float = None
-    endAngle: float = None
-    angleRadians: float = None
-    plane: Plane = None
-    domain: Interval = None
-    startPoint: Point = None
-    midPoint: Point = None
-    endPoint: Point = None
-    bbox: Box = None
-    area: float = None
-    length: float = None
-
-
-class Circle(Base, speckle_type=GEOMETRY + "Circle"):
-    radius: float = None
-    plane: Plane = None
-    domain: Interval = None
-    bbox: Box = None
-    area: float = None
-    length: float = None
-
-
-class Ellipse(Base, speckle_type=GEOMETRY + "Ellipse"):
-    firstRadius: float = None
-    secondRadius: float = None
-    plane: Plane = None
-    domain: Interval = None
-    trimDomain: Interval = None
-    bbox: Box = None
-    area: float = None
-    length: float = None
-
-
-class Polyline(Base, speckle_type=GEOMETRY + "Polyline"):
-    value: List[float] = None
-    closed: bool = None
-    domain: Interval = None
-    bbox: Box = None
-    area: float = None
-    length: float = None
-
-    def __init__(self, **data: Any) -> None:
-        super().__init__(**data)
-        self.add_chunkable_attrs(value=20000)
-
-    @classmethod
-    def from_points(cls, points: List[Point]):
-        polyline = cls()
-        polyline.units = points[0].units
-        for point in points:
-            polyline.value.extend([point.x, point.y, point.z])
-        return polyline
-
-    # @property
-    # def value(self) -> List[float]:
-    #     return self._value
-
-    # @value.setter
-    # def value(self, coords) -> None:
-    #     if len(coords) % 3:
-    #         coords.extend([0] * (3 - len(coords) % 3))
-    #     self._value = coords
-
-    def as_points(self) -> List[Point]:
-        """Converts the `value` attribute to a list of Points"""
-        if not self.value:
-            return
-
-        if len(self.value) % 3:
-            raise ValueError("Points array malformed: length%3 != 0.")
-
-        values = iter(self.value)
-        return [Point(v, next(values), next(values), units=self.units) for v in values]
-
-
-class Curve(Base, speckle_type=GEOMETRY + "Curve"):
-    degree: int = None
-    periodic: bool = None
-    rational: bool = None
-    points: List[float] = None
-    weights: List[float] = None
-    knots: List[float] = None
-    domain: Interval = None
-    displayValue: Polyline = None
-    closed: bool = None
-    bbox: Box = None
-    area: float = None
-    length: float = None
-
-    def __init__(self, **data: Any) -> None:
-        super().__init__(**data)
-        self.add_chunkable_attrs(points=20000, weights=20000, knots=20000)
-
-    def as_points(self) -> List[Point]:
-        """Converts the `value` attribute to a list of Points"""
-        if not self.points:
-            return
-
-        if len(self.points) % 3:
-            raise ValueError("Points array malformed: length%3 != 0.")
-
-        values = iter(self.points)
-        return [Point(v, next(values), next(values), units=self.units) for v in values]
-
-
-class Polycurve(Base, speckle_type=GEOMETRY + "Polycurve"):
-    segments: List[Base] = []
-    domain: Interval = None
-    closed: bool = None
-    bbox: Box = None
-    area: float = None
-    length: float = None
-
-
-class Extrusion(Base, speckle_type=GEOMETRY + "Extrusion"):
-    capped: bool = None
-    profile: Base = None
-    pathStart: Point = None
-    pathEnd: Point = None
-    pathCurve: Base = None
-    pathTangent: Base = None
-    profiles: List[Base] = None
-    length: float = None
-    area: float = None
-    volume: float = None
-    bbox: Box = None
-
-
-class Mesh(Base, speckle_type=GEOMETRY + "Mesh"):
-    vertices: List[float] = None
-    faces: List[int] = None
-    colors: List[int] = None
-    textureCoordinates: List[float] = None
-    bbox: Box = None
-    area: float = None
-    volume: float = None
-
-    def __init__(self, **data) -> None:
-        super().__init__(**data)
-        self.add_chunkable_attrs(
-            vertices=2000, faces=2000, colors=2000, textureCoordinates=2000
-        )
-
-
-class Surface(Base, speckle_type=GEOMETRY + "Surface"):
-    degreeU: int = None
-    degreeV: int = None
-    rational: bool = None
-    area: float = None
-    pointData: List[float] = None
-    countU: int = None
-    countV: int = None
-    bbox: Box = None
-
-
-class BrepFace(Base, speckle_type=GEOMETRY + "BrepFace"):
-    _Brep: "Brep" = None
-    SurfaceIndex: int = None
-    LoopIndices: List[int] = None
-    OuterLoopIndex: int = None
-    OrientationReversed: bool = None
-
-    @property
-    def _outer_loop(self):
-        return self._Brep.Loops[self.OuterLoopIndex]
-
-    @property
-    def _surface(self):
-        return self._Brep.Surfaces[self.SurfaceIndex]
-
-    @property
-    def _loops(self):
-        return [self._Brep.Loops[index] for index in self.LoopIndices]
-
-
-class BrepEdge(Base, speckle_type=GEOMETRY + "BrepEdge"):
-    _Brep: "Brep" = None
-    Curve3dIndex: int = None
-    TrimIndices: List[int] = None
-    StartIndex: int = None
-    EndIndex: int = None
-    ProxyCurveIsReversed: bool = None
-    Domain: Interval = None
-
-    @property
-    def _start_vertex(self):
-        return self._Brep.Vertices[self.StartIndex]
-
-    @property
-    def _end_vertex(self):
-        return self._Brep.Vertices[self.EndIndex]
-
-    @property
-    def _trims(self):
-        return [self._Brep.Trims[i] for i in self.TrimIndices]
-
-    @property
-    def _curve(self):
-        return self._Brep.Curve3D[self.Curve3dIndex]
-
-
-class BrepLoop(Base, speckle_type=GEOMETRY + "BrepLoop"):
-    _Brep: "Brep" = None
-    FaceIndex: int = None
-    TrimIndices: List[int] = None
-    Type: str = None
-
-    @property
-    def _face(self):
-        return self._Brep.Faces[self.FaceIndex]
-
-    @property
-    def _trims(self):
-        return [self._Brep.Trims[i] for i in self.TrimIndices]
-
-
-class BrepTrim(Base, speckle_type=GEOMETRY + "BrepTrim"):
-    _Brep: "Brep" = None
-    EdgeIndex: int = None
-    StartIndex: int = None
-    EndIndex: int = None
-    FaceIndex: int = None
-    LoopIndex: int = None
-    CurveIndex: int = None
-    IsoStatus: int = None
-    TrimType: str = None
-    IsReversed: bool = None
-    Domain: Interval = None
-
-    @property
-    def _face(self):
-        return self._Brep.Faces[self.FaceIndex]
-
-    @property
-    def _loop(self):
-        return self._Brep.Loops[self.LoopIndex]
-
-    @property
-    def _edge(self):
-        return self._Brep.Edges[self.EdgeIndex] if self.EdgeIndex != -1 else None
-
-    @property
-    def _curve_2d(self):
-        return self._Brep.Curve2D[self.CurveIndex]
-
-
-class Brep(Base, speckle_type=GEOMETRY + "Brep"):
-    provenance: str = None
-    bbox: Box = None
-    area: float = None
-    volume: float = None
-    displayValue: Mesh = None
-    Surfaces: List[Surface] = []
-    Curve3D: List[Base] = []
-    Curve2D: List[Base] = []
-    Vertices: List[Point] = []
-    Edges: List[BrepEdge] = []
-    Loops: List[BrepLoop] = []
-    Trims: List[BrepTrim] = []
-    Faces: List[BrepFace] = []
-    IsClosed: bool = None
-    Orientation: int = 0
-
-    def __init__(self, **data: Any) -> None:
-        super().__init__(**data)
-        self.add_detachable_attrs({"displayValue"})
-        self.add_chunkable_attrs(
-            Surfaces=200,
-            Curve3D=200,
-            Curve2D=200,
-            Vertices=5000,
-            Edges=5000,
-            Loops=5000,
-            Trims=5000,
-            Faces=5000,
-        )
-
-    def __setattr__(self, name: str, value: Any) -> None:
-        if not value:
-            return
-        if name in ["Edges", "Loops", "Trims", "Faces"]:
-            for val in value:
-                val._Brep = self
-        super().__setattr__(name, value)
-
-
-BrepEdge.update_forward_refs()
-BrepLoop.update_forward_refs()
-BrepTrim.update_forward_refs()
-BrepFace.update_forward_refs()

specklepy/objects/other.py

@@ -1,12 +0,0 @@
-from .base import Base
-
-OTHER = "Objects.Other."
-
-
-class RenderMaterial(Base, speckle_type=OTHER + "RenderMaterial"):
-    name: str = None
-    opacity: float = 1
-    metalness: float = 0
-    roughness: float = 1
-    diffuse: int = -2894893  # light gray arbg
-    emissive: int = -16777216  # black arbg

specklepy/objects/units.py

@@ -1,25 +0,0 @@
-from specklepy.logging.exceptions import SpeckleException
-
-UNITS = ["mm", "cm", "m", "in", "ft", "yd", "mi"]
-
-UNITS_STRINGS = {
-    "mm": ["mm", "mil", "millimeters", "millimetres"],
-    "cm": ["cm", "centimetre", "centimeter", "centimetres", "centimeters"],
-    "m": ["m", "meter", "meters", "metre", "metres"],
-    "in": ["in", "inch", "inches"],
-    "ft": ["ft", "foot", "feet"],
-    "yd": ["yd", "yard", "yards"],
-    "mi": ["mi", "mile", "miles"],
-    "none": ["none", "null"],
-}
-
-
-def get_units_from_string(unit: str):
-    unit = str.lower(unit)
-    for name, alternates in UNITS_STRINGS.items():
-        if unit in alternates:
-            return name
-
-    raise SpeckleException(
-        message=f"Could not understand what unit {unit} is referring to. Please enter a valid unit (eg {UNITS})."
-    )

specklepy/transports/server/__init__.py

@@ -1 +0,0 @@
-from .server import ServerTransport

specklepy/transports/server/server.py

@@ -1,119 +0,0 @@
-import json
-import time
-
-import requests
-
-from typing import Any, Dict, List, Type
-
-from specklepy.api.client import SpeckleClient
-from specklepy.logging.exceptions import SpeckleException
-from specklepy.transports.abstract_transport import AbstractTransport
-
-from .batch_sender import BatchSender
-
-
-class ServerTransport(AbstractTransport):
-    _name = "RemoteTransport"
-    url: str = None
-    stream_id: str = None
-    saved_obj_count: int = 0
-    session: requests.Session = None
-
-    def __init__(self, client: SpeckleClient, stream_id: str, **data: Any) -> None:
-        super().__init__(**data)
-        # TODO: replace client with account or some other auth avenue
-        self.url = client.url
-        self.stream_id = stream_id
-
-        token = client.me["token"]
-        self._batch_sender = BatchSender(self.url, self.stream_id, token, max_batch_size_mb=1)
-
-        self.session = requests.Session()
-        self.session.headers.update(
-            {"Authorization": f"Bearer {token}", "Accept": "text/plain"}
-        )
-
-    def begin_write(self) -> None:
-        self.saved_obj_count = 0
-
-    def end_write(self) -> None:
-        self._batch_sender.flush()
-
-    def save_object(self, id: str, serialized_object: str) -> None:
-        self._batch_sender.send_object(id, serialized_object)
-
-    def save_object_from_transport(
-        self, id: str, source_transport: AbstractTransport
-    ) -> None:
-        obj_string = source_transport.get_object(id=id)
-        self.save_object(id=id, serialized_object=obj_string)
-
-    def get_object(self, id: str) -> str:
-        # endpoint = f"{self.url}/objects/{self.stream_id}/{id}/single"
-        # r = self.session.get(endpoint, stream=True)
-
-        # _, obj = next(r.iter_lines().decode("utf-8")).split("\t")
-
-        # return obj
-
-        raise SpeckleException(
-            "Getting a single object using `ServerTransport.get_object()` is not implemented. To get an object from the server, please use the `SpeckleClient.object.get()` route",
-            NotImplementedError,
-        )
-
-    def has_objects(self, id_list: List[str]) -> Dict[str, bool]:
-        return {id: False for id in id_list}
-
-    def copy_object_and_children(
-        self, id: str, target_transport: AbstractTransport
-    ) -> str:
-        endpoint = f"{self.url}/objects/{self.stream_id}/{id}/single"
-        r = self.session.get(endpoint)
-        if r.encoding is None:
-            r.encoding = "utf-8"
-
-        if r.status_code != 200:
-            raise SpeckleException(f"Can't get object {self.stream_id}/{id}: HTTP error {r.status_code} ({r.text[:1000]})")
-        root_obj_serialized = r.text
-        root_obj = json.loads(root_obj_serialized)
-        closures = root_obj.get('__closure', {})
-
-        # Check which children are not already in the target transport
-        children_ids = list(closures.keys())
-        children_found_map = target_transport.has_objects(children_ids)
-        new_children_ids = [id for id in children_found_map if not children_found_map[id]]
-
-        # Get the new children
-        endpoint = f"{self.url}/api/getobjects/{self.stream_id}"
-        r = self.session.post(endpoint, data={"objects": json.dumps(new_children_ids)}, stream=True)
-        if r.encoding is None:
-            r.encoding = "utf-8"
-        lines = r.iter_lines(decode_unicode=True)
-
-        # iter through returned objects saving them as we go
-        for line in lines:
-            if line:
-                hash, obj = line.split("\t")
-                target_transport.save_object(hash, obj)
-
-        target_transport.save_object(id, root_obj_serialized)
-
-        return root_obj_serialized
-
-    # async def stream_res(self, endpoint: str) -> str:
-    #     data = b""
-    #     async with aiohttp.ClientSession() as session:
-    #         session.headers.update(
-    #             {
-    #                 "Authorization": f"{self.session.headers['Authorization']}",
-    #                 "Accept": "text/plain",
-    #             }
-    #         )
-    #         async with session.get(endpoint) as res:
-    #             while True:
-    #                 chunk = await res.content.read(self.chunk_size)
-    #                 if not chunk:
-    #                     break
-    #                 data += chunk
-
-    #     return data.decode("utf-8")

specklepy/transports/sqlite.py

@@ -1,213 +0,0 @@
-import os
-import sys
-import time
-import sched
-import sqlite3
-from typing import Any, List, Dict
-from appdirs import user_data_dir
-from contextlib import closing
-from multiprocessing import Process, Queue
-from specklepy.transports.abstract_transport import AbstractTransport
-from specklepy.logging.exceptions import SpeckleException
-
-
-class SQLiteTransport(AbstractTransport):
-    _name = "SQLite"
-    _base_path: str = None
-    _root_path: str = None
-    _is_writing: bool = False
-    _scheduler = sched.scheduler(time.time, time.sleep)
-    _polling_interval = 0.5  # seconds
-    __connection: sqlite3.Connection = None
-    __queue: Queue = Queue()
-    app_name: str = ""
-    scope: str = ""
-    saved_obj_count: int = 0
-
-    def __init__(
-        self,
-        base_path: str = None,
-        app_name: str = None,
-        scope: str = None,
-        **data: Any,
-    ) -> None:
-        super().__init__(**data)
-        self.app_name = app_name or "Speckle"
-        self.scope = scope or "Objects"
-        self._base_path = base_path or self.__get_base_path()
-
-        os.makedirs(self._base_path, exist_ok=True)
-
-        self._root_path = os.path.join(
-            os.path.join(self._base_path, f"{self.scope}.db")
-        )
-        self.__initialise()
-
-    def __repr__(self) -> str:
-        return f"SQLiteTransport(app: '{self.app_name}', scope: '{self.scope}')"
-
-    # def __write_timer_elapsed(self):
-    #     print("WRITE TIMER ELAPSED")
-    #     proc = Process(target=_run_queue, args=(self.__queue, self._root_path))
-    #     proc.start()
-    #     proc.join()
-
-    def __get_base_path(self):
-        # from appdirs https://github.com/ActiveState/appdirs/blob/master/appdirs.py
-        # default mac path is not the one we use (we use unix path), so using special case for this
-        system = sys.platform
-        if system.startswith("java"):
-            import platform
-
-            os_name = platform.java_ver()[3][0]
-            if os_name.startswith("Mac"):
-                system = "darwin"
-
-        if system == "darwin":
-            path = os.path.expanduser("~/.config/")
-            return os.path.join(path, self.app_name)
-        else:
-            return user_data_dir(appname=self.app_name, appauthor=False, roaming=True)
-
-    def __consume_queue(self):
-        if self._is_writing or self.__queue.empty():
-            return
-        print("CONSUME QUEUE")
-        self._is_writing = True
-        while not self.__queue.empty():
-            data = self.__queue.get()
-            self.save_object(data[0], data[1])
-        self._is_writing = False
-
-        self._scheduler.enter(
-            delay=self._polling_interval, priority=1, action=self.__consume_queue
-        )
-        self._scheduler.run(blocking=True)
-
-    # def save_object(self, id: str, serialized_object: str) -> None:
-    #     """Adds an object to the queue and schedules it to be saved.
-
-    #     Arguments:
-    #         id {str} -- the object id
-    #         serialized_object {str} -- the full string representation of the object
-    #     """
-    #     print("SAVE OBJECT")
-    #     self.__queue.put((id, serialized_object))
-
-    #     self._scheduler.enter(
-    #         delay=self._polling_interval, priority=1, action=self.__consume_queue
-    #     )
-    #     self._scheduler.run(blocking=True)
-
-    def save_object_from_transport(
-        self, id: str, source_transport: AbstractTransport
-    ) -> None:
-        """Adds an object from the given transport to the queue and schedules it to be saved.
-
-        Arguments:
-            id {str} -- the object id
-            source_transport {AbstractTransport) -- the transport through which the object can be found
-        """
-        serialized_object = source_transport.get_object(id)
-        self.__queue.put((id, serialized_object))
-        raise NotImplementedError
-
-    def save_object(self, id: str, serialized_object: str) -> None:
-        """Directly saves an object into the database.
-
-        Arguments:
-            id {str} -- the object id
-            serialized_object {str} -- the full string representation of the object
-        """
-        self.__check_connection()
-        try:
-            with closing(self.__connection.cursor()) as c:
-                c.execute(
-                    "INSERT OR IGNORE INTO objects(hash, content) VALUES(?,?)",
-                    (id, serialized_object),
-                )
-                self.__connection.commit()
-        except Exception as ex:
-            raise SpeckleException(
-                f"Could not save the object to the local db. Inner exception: {ex}", ex
-            )
-
-    def get_object(self, id: str) -> str or None:
-        self.__check_connection()
-        with closing(self.__connection.cursor()) as c:
-            row = c.execute(
-                "SELECT * FROM objects WHERE hash = ? LIMIT 1", (id,)
-            ).fetchone()
-        return row[1] if row else None
-
-    def has_objects(self, id_list: List[str]) -> Dict[str, bool]:
-        ret = {}
-        self.__check_connection()
-        with closing(self.__connection.cursor()) as c:
-            for id in id_list:
-                row = c.execute(
-                    "SELECT 1 FROM objects WHERE hash = ? LIMIT 1", (id,)
-                ).fetchone()
-                ret[id] = bool(row)
-        return ret
-
-    def begin_write(self):
-        self.saved_obj_count = 0
-
-    def end_write(self):
-        pass
-
-    def copy_object_and_children(
-        self, id: str, target_transport: AbstractTransport
-    ) -> str:
-        raise NotImplementedError
-
-    def get_all_objects(self):
-        """Returns all the objects in the store. NOTE: do not use for large collections!"""
-        self.__check_connection()
-        with closing(self.__connection.cursor()) as c:
-            rows = c.execute("SELECT * FROM objects").fetchall()
-        return rows
-
-    def close(self):
-        """Close the connection to the database"""
-        if self.__connection:
-            self.__connection.close()
-            self.__connection = None
-
-    def __initialise(self) -> None:
-        self.__connection = sqlite3.connect(self._root_path)
-        with closing(self.__connection.cursor()) as c:
-            c.execute(
-                """ CREATE TABLE IF NOT EXISTS objects(
-                      hash TEXT PRIMARY KEY,
-                      content TEXT
-                    ) WITHOUT ROWID;"""
-            )
-            c.execute("PRAGMA journal_mode='wal';")
-            c.execute("PRAGMA count_changes=OFF;")
-            c.execute("PRAGMA temp_store=MEMORY;")
-            self.__connection.commit()
-
-    def __check_connection(self):
-        if not self.__connection:
-            self.__connection = sqlite3.connect(self._root_path)
-
-    def __del__(self):
-        self.__connection.close()
-
-
-# def _run_queue(queue: Queue, root_path: str):
-#     if queue.empty():
-#         return
-#     print("RUN QUEUE")
-#     conn = sqlite3.connect(root_path)
-#     while not queue.empty():
-#         data = queue.get()
-#         with closing(conn.cursor()) as c:
-#             c.execute(
-#                 "INSERT OR IGNORE INTO objects(hash, content) VALUES(?,?)",
-#                 (data[0], data[1]),
-#             )
-#             conn.commit()
-#     conn.close()

src/specklepy/api/client.py

@@ -0,0 +1,235 @@
+import re
+from typing import Dict
+from warnings import warn
+
+from deprecated import deprecated
+from gql import Client
+from gql.transport.requests import RequestsHTTPTransport
+from gql.transport.websockets import WebsocketsTransport
+
+from specklepy.api import resources
+from specklepy.api.credentials import Account, get_account_from_token
+from specklepy.api.resources import (
+    active_user,
+    branch,
+    commit,
+    object,
+    other_user,
+    server,
+    stream,
+    subscriptions,
+    user,
+)
+from specklepy.logging import metrics
+from specklepy.logging.exceptions import SpeckleException, SpeckleWarning
+
+
+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:"
+            f" {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",
+            "apollographql-client-name": metrics.HOST_APP,
+            "apollographql-client-version": metrics.HOST_APP_VERSION,
+        }
+        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(
+                    "Possibly invalid token - could not authenticate Speckle Client"
+                    f" for server {self.url}"
+                )
+            )
+
+    def execute_query(self, query: str) -> Dict:
+        return self.httpclient.execute(query)
+
+    def _init_resources(self) -> None:
+        self.server = server.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        server_version = None
+        try:
+            server_version = self.server.version()
+        except Exception:
+            pass
+        self.user = user.Resource(
+            account=self.account,
+            basepath=self.url,
+            client=self.httpclient,
+            server_version=server_version,
+        )
+        self.other_user = other_user.Resource(
+            account=self.account,
+            basepath=self.url,
+            client=self.httpclient,
+            server_version=server_version,
+        )
+        self.active_user = active_user.Resource(
+            account=self.account,
+            basepath=self.url,
+            client=self.httpclient,
+            server_version=server_version,
+        )
+        self.stream = stream.Resource(
+            account=self.account,
+            basepath=self.url,
+            client=self.httpclient,
+            server_version=server_version,
+        )
+        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.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 AttributeError:
+            raise SpeckleException(
+                f"Method {name} is not supported by the SpeckleClient class"
+            )

src/specklepy/api/credentials.py

@@ -0,0 +1,160 @@
+import os
+from typing import List, Optional
+
+from pydantic import BaseModel, Field  # pylint: disable=no-name-in-module
+
+from specklepy.api.models import ServerInfo
+from specklepy.core.helpers import speckle_path_provider
+from specklepy.logging import metrics
+from specklepy.logging.exceptions import SpeckleException
+from specklepy.transports.sqlite import SQLiteTransport
+
+
+class UserInfo(BaseModel):
+    name: Optional[str] = None
+    email: Optional[str] = None
+    company: Optional[str] = None
+    id: Optional[str] = None
+
+
+class Account(BaseModel):
+    isDefault: bool = False
+    token: Optional[str] = None
+    refreshToken: Optional[str] = None
+    serverInfo: ServerInfo = Field(default_factory=ServerInfo)
+    userInfo: UserInfo = Field(default_factory=UserInfo)
+    id: Optional[str] = None
+
+    def __repr__(self) -> str:
+        return (
+            f"Account(email: {self.userInfo.email}, server: {self.serverInfo.url},"
+            f" 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: Optional[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
+    """
+    accounts: List[Account] = []
+    try:
+        account_storage = SQLiteTransport(scope="Accounts", base_path=base_path)
+        res = account_storage.get_all_objects()
+        account_storage.close()
+        if res:
+            accounts.extend(Account.parse_raw(r[1]) for r in res)
+    except SpeckleException:
+        # cannot open SQLiteTransport, probably because of the lack
+        # of disk write permissions
+        pass
+
+    json_acct_files = []
+    json_path = str(speckle_path_provider.accounts_folder_path())
+    try:
+        os.makedirs(json_path, exist_ok=True)
+        json_acct_files.extend(
+            file for file in os.listdir(json_path) if file.endswith(".json")
+        )
+
+    except Exception:
+        # cannot find or get the json account paths
+        pass
+
+    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,
+            ) from 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: Optional[str] = None) -> Optional[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(),
+        )

src/specklepy/api/host_applications.py

@@ -0,0 +1,116 @@
+from dataclasses import dataclass
+from enum import Enum
+from unicodedata import name
+
+
+class HostAppVersion(Enum):
+    v = "v"
+    v6 = "v6"
+    v7 = "v7"
+    v2019 = "v2019"
+    v2020 = "v2020"
+    v2021 = "v2021"
+    v2022 = "v2022"
+    v2023 = "v2023"
+    v2024 = "v2024"
+    v2025 = "v2025"
+    vSandbox = "vSandbox"
+    vRevit = "vRevit"
+    vRevit2021 = "vRevit2021"
+    vRevit2022 = "vRevit2022"
+    vRevit2023 = "vRevit2023"
+    vRevit2024 = "vRevit2024"
+    vRevit2025 = "vRevit2025"
+    v25 = "v25"
+    v26 = "v26"
+
+    def __repr__(self) -> str:
+        return self.value
+
+    def __str__(self) -> str:
+        return self.value
+
+
+@dataclass
+class HostApplication:
+    name: str
+    slug: str
+
+    def get_version(self, version: HostAppVersion) -> str:
+        return f"{name.replace(' ', '')}{str(version).strip('v')}"
+
+
+RHINO = HostApplication("Rhino", "rhino")
+GRASSHOPPER = HostApplication("Grasshopper", "grasshopper")
+REVIT = HostApplication("Revit", "revit")
+DYNAMO = HostApplication("Dynamo", "dynamo")
+UNITY = HostApplication("Unity", "unity")
+GSA = HostApplication("GSA", "gsa")
+CIVIL = HostApplication("Civil 3D", "civil3d")
+AUTOCAD = HostApplication("AutoCAD", "autocad")
+MICROSTATION = HostApplication("MicroStation", "microstation")
+OPENROADS = HostApplication("OpenRoads", "openroads")
+OPENRAIL = HostApplication("OpenRail", "openrail")
+OPENBUILDINGS = HostApplication("OpenBuildings", "openbuildings")
+ETABS = HostApplication("ETABS", "etabs")
+SAP2000 = HostApplication("SAP2000", "sap2000")
+CSIBRIDGE = HostApplication("CSIBridge", "csibridge")
+SAFE = HostApplication("SAFE", "safe")
+TEKLASTRUCTURES = HostApplication("Tekla Structures", "teklastructures")
+DXF = HostApplication("DXF Converter", "dxf")
+EXCEL = HostApplication("Excel", "excel")
+UNREAL = HostApplication("Unreal", "unreal")
+POWERBI = HostApplication("Power BI", "powerbi")
+BLENDER = HostApplication("Blender", "blender")
+QGIS = HostApplication("QGIS", "qgis")
+ARCGIS = HostApplication("ArcGIS", "arcgis")
+SKETCHUP = HostApplication("SketchUp", "sketchup")
+ARCHICAD = HostApplication("Archicad", "archicad")
+TOPSOLID = HostApplication("TopSolid", "topsolid")
+PYTHON = HostApplication("Python", "python")
+NET = HostApplication(".NET", "net")
+OTHER = HostApplication("Other", "other")
+
+_app_name_host_app_mapping = {
+    "dynamo": DYNAMO,
+    "revit": REVIT,
+    "autocad": AUTOCAD,
+    "civil": CIVIL,
+    "rhino": RHINO,
+    "grasshopper": GRASSHOPPER,
+    "unity": UNITY,
+    "gsa": GSA,
+    "microstation": MICROSTATION,
+    "openroads": OPENROADS,
+    "openrail": OPENRAIL,
+    "openbuildings": OPENBUILDINGS,
+    "etabs": ETABS,
+    "sap": SAP2000,
+    "csibridge": CSIBRIDGE,
+    "safe": SAFE,
+    "teklastructures": TEKLASTRUCTURES,
+    "dxf": DXF,
+    "excel": EXCEL,
+    "unreal": UNREAL,
+    "powerbi": POWERBI,
+    "blender": BLENDER,
+    "qgis": QGIS,
+    "arcgis": ARCGIS,
+    "sketchup": SKETCHUP,
+    "archicad": ARCHICAD,
+    "topsolid": TOPSOLID,
+    "python": PYTHON,
+    "net": NET,
+}
+
+
+def get_host_app_from_string(app_name: str) -> HostApplication:
+    app_name = app_name.lower().replace(" ", "")
+    for partial_app_name, host_app in _app_name_host_app_mapping.items():
+        if partial_app_name in app_name:
+            return host_app
+    return HostApplication(app_name, app_name)
+
+
+if __name__ == "__main__":
+    print(HostAppVersion.v)

src/specklepy/api/models.py

@@ -0,0 +1,198 @@
+from datetime import datetime
+from typing import List, Optional
+
+from pydantic import BaseModel, Field
+
+
+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:"
+            f" {self.referencedObject}, authorName: {self.authorName}, branchName:"
+            f" {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] = None
+    name: Optional[str]
+    role: Optional[str] = None
+    isPublic: Optional[bool] = None
+    description: Optional[str] = None
+    createdAt: Optional[datetime] = None
+    updatedAt: Optional[datetime] = None
+    collaborators: List[Collaborator] = Field(default_factory=list)
+    branches: Optional[Branches] = None
+    commit: Optional[Commit] = None
+    object: Optional[Object] = None
+    commentCount: Optional[int] = None
+    favoritedDate: Optional[datetime] = None
+    favoritesCount: Optional[int] = None
+
+    def __repr__(self):
+        return (
+            f"Stream( id: {self.id}, name: {self.name}, description:"
+            f" {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:"
+            f" {self.company} )"
+        )
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+
+class LimitedUser(BaseModel):
+    """Limited user type, for showing public info about a user to another user."""
+
+    id: str
+    name: Optional[str]
+    bio: Optional[str]
+    company: Optional[str]
+    avatar: Optional[str]
+    verified: Optional[bool]
+    role: Optional[str]
+
+
+class PendingStreamCollaborator(BaseModel):
+    id: Optional[str]
+    inviteId: Optional[str]
+    streamId: Optional[str]
+    streamName: Optional[str]
+    title: Optional[str]
+    role: Optional[str]
+    invitedBy: Optional[User]
+    user: Optional[User]
+    token: Optional[str]
+
+    def __repr__(self):
+        return (
+            f"PendingStreamCollaborator( inviteId: {self.inviteId}, streamId:"
+            f" {self.streamId}, role: {self.role}, title: {self.title}, invitedBy:"
+            f" {self.user.name if self.user else None})"
+        )
+
+    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},"
+            f" 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:"
+            f" {len(self.items) if self.items else 0}, cursor:"
+            f" {self.cursor.isoformat() if self.cursor else None} )"
+        )
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+
+class ServerInfo(BaseModel):
+    name: Optional[str] = None
+    company: Optional[str] = None
+    url: Optional[str] = None
+    description: Optional[str] = None
+    adminContact: Optional[str] = None
+    canonicalUrl: Optional[str] = None
+    roles: Optional[List[dict]] = None
+    scopes: Optional[List[dict]] = None
+    authStrategies: Optional[List[dict]] = None
+    version: Optional[str] = None

src/specklepy/api/operations.py

@@ -1,16 +1,16 @@
-import json
-from typing import List
-from specklepy.objects.base import Base
-from specklepy.transports.sqlite import SQLiteTransport
-from specklepy.transports.server import ServerTransport
+from typing import List, Optional
+
+from specklepy.logging import metrics
 from specklepy.logging.exceptions import SpeckleException
-from specklepy.transports.abstract_transport import AbstractTransport
+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
 
 
 def send(
     base: Base,
-    transports: List[AbstractTransport] = [],
+    transports: Optional[List[AbstractTransport]] = None,
     use_default_cache: bool = True,
 ):
     """Sends an object via the provided transports. Defaults to the local cache.
@@ -18,59 +18,81 @@ 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
     """
+
     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())
 
     serializer = BaseObjectSerializer(write_transports=transports)
 
-    for t in transports:
-        t.begin_write()
-    hash, _ = serializer.write_json(base=base)
+    obj_hash, _ = serializer.write_json(base=base)
 
-    for t in transports:
-        t.end_write()
-
-    return hash
+    return obj_hash
 
 
 def receive(
     obj_id: str,
-    remote_transport: AbstractTransport = None,
-    local_transport: AbstractTransport = None,
+    remote_transport: Optional[AbstractTransport] = None,
+    local_transport: Optional[AbstractTransport] = None,
+) -> Base:
+    metrics.track(metrics.RECEIVE, getattr(remote_transport, "account", None))
+    return _untracked_receive(obj_id, remote_transport, local_transport)
+
+
+def _untracked_receive(
+    obj_id: str,
+    remote_transport: Optional[AbstractTransport] = None,
+    local_transport: Optional[AbstractTransport] = None,
 ) -> Base:
     """Receives an object from a transport.
 
     Arguments:
         obj_id {str} -- the id of the object to receive
         remote_transport {Transport} -- the transport to receive from
-        local_transport {Transport} -- the transport to send from
+        local_transport {Transport} -- the local cache to check for existing objects
+                                       (defaults to `SQLiteTransport`)
 
     Returns:
         Base -- the base object
     """
-
     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 wth deserialisation using the 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
     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(
@@ -82,35 +104,50 @@ def receive(
 
 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
     """
+    metrics.track(metrics.SERIALIZE)
     serializer = BaseObjectSerializer(write_transports=write_transports)
 
     return serializer.write_json(base)[1]
 
 
 def deserialize(
-    obj_string: str, read_transport: AbstractTransport = SQLiteTransport()
+    obj_string: str, read_transport: Optional[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"]

src/specklepy/api/resource.py

@@ -0,0 +1,128 @@
+from typing import Any, Dict, List, Optional, Tuple, Type, Union
+
+from gql.client import Client
+from gql.transport.exceptions import TransportQueryError
+from graphql import DocumentNode
+
+from specklepy.api.credentials import Account
+from specklepy.logging.exceptions import (
+    GraphQLException,
+    SpeckleException,
+    UnsupportedException,
+)
+from specklepy.serialization.base_object_serializer import BaseObjectSerializer
+from specklepy.transports.sqlite import SQLiteTransport
+
+
+class ResourceBase(object):
+    def __init__(
+        self,
+        account: Account,
+        basepath: str,
+        client: Client,
+        name: str,
+        server_version: Optional[Tuple[Any, ...]] = None,
+    ) -> None:
+        self.account = account
+        self.basepath = basepath
+        self.client = client
+        self.name = name
+        self.server_version = server_version
+        self.schema: Optional[Type] = None
+
+    def _step_into_response(self, response: dict, return_type: Union[str, List, None]):
+        """Step into the dict to get the relevant data"""
+        if return_type is None:
+            return response
+        if isinstance(return_type, str):
+            return response[return_type]
+        if isinstance(return_type, List):
+            for key in return_type:
+                response = response[key]
+            return response
+
+    def _parse_response(self, response: Union[dict, list, None], schema=None):
+        """Try to create a class instance from the response"""
+        if response is None:
+            return None
+        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 Exception:
+                s = BaseObjectSerializer(read_transport=SQLiteTransport())
+                return s.recompose_base(response)
+        else:
+            return response
+
+    def make_request(
+        self,
+        query: DocumentNode,
+        params: Optional[Dict] = None,
+        return_type: Union[str, List, None] = None,
+        schema=None,
+        parse_response: bool = True,
+    ) -> Any:
+        """Executes the GraphQL query"""
+        try:
+            response = self.client.execute(query, variable_values=params)
+        except Exception as ex:
+            if isinstance(ex, TransportQueryError):
+                return GraphQLException(
+                    message=(
+                        f"Failed to execute the GraphQL {self.name} request. Errors:"
+                        f" {ex.errors}"
+                    ),
+                    errors=ex.errors,
+                    data=ex.data,
+                )
+            else:
+                return SpeckleException(
+                    message=(
+                        f"Failed to execute the GraphQL {self.name} request. Inner"
+                        f" exception: {ex}"
+                    ),
+                    exception=ex,
+                )
+
+        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
+
+    def _check_server_version_at_least(
+        self, target_version: Tuple[Any, ...], unsupported_message: Optional[str] = None
+    ):
+        """Use this check to guard against making unsupported requests on older servers.
+
+        Arguments:
+            target_version {tuple}
+            the minimum 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
+        """
+        if not unsupported_message:
+            unsupported_message = (
+                "The client method used is not supported on Speckle Server versions"
+                f" prior to v{'.'.join(target_version)}"
+            )
+        # if version is dev, it should be supported... (or not)
+        if self.server_version == ("dev",):
+            return
+        if self.server_version and self.server_version < target_version:
+            raise UnsupportedException(unsupported_message)
+
+    def _check_invites_supported(self):
+        """Invites are only supported for Speckle Server >= 2.6.4.
+        Use this check to guard against making unsupported requests on older servers.
+        """
+        self._check_server_version_at_least(
+            (2, 6, 4),
+            "Stream invites are only supported as of Speckle Server v2.6.4. Please"
+            " update your Speckle Server to use this method or use the"
+            " `grant_permission` flow instead.",
+        )

src/specklepy/api/resources/__init__.py

@@ -1,12 +1,8 @@
-from pathlib import Path
-import sys
-import inspect
 import pkgutil
+import sys
 from importlib import import_module
 
-
-for (_, name, _) in pkgutil.iter_modules(__path__):
-
+for _, name, _ in pkgutil.iter_modules(__path__):
     imported_module = import_module("." + name, package=__name__)
 
     if hasattr(imported_module, "Resource"):

src/specklepy/api/resources/active_user.py

@@ -0,0 +1,269 @@
+from datetime import datetime, timezone
+from typing import List, Optional
+
+from gql import gql
+
+from specklepy.api.models import ActivityCollection, PendingStreamCollaborator, User
+from specklepy.api.resource import ResourceBase
+from specklepy.logging import metrics
+from specklepy.logging.exceptions import SpeckleException
+
+NAME = "active_user"
+
+
+class Resource(ResourceBase):
+    """API Access class for users"""
+
+    def __init__(self, account, basepath, client, server_version) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+            server_version=server_version,
+        )
+        self.schema = User
+
+    def get(self) -> User:
+        """Gets the profile of a user. If no id argument is provided,
+        will return the current authenticated user's profile
+        (as extracted from the authorization header).
+
+        Arguments:
+            id {str} -- the user id
+
+        Returns:
+            User -- the retrieved user
+        """
+        metrics.track(metrics.USER, self.account, {"name": "get"})
+        query = gql(
+            """
+            query User {
+                activeUser {
+                    id
+                    email
+                    name
+                    bio
+                    company
+                    avatar
+                    verified
+                    profiles
+                    role
+                }
+            }
+          """
+        )
+
+        params = {}
+
+        return self.make_request(query=query, params=params, return_type="activeUser")
+
+    def update(
+        self,
+        name: Optional[str] = None,
+        company: Optional[str] = None,
+        bio: Optional[str] = None,
+        avatar: Optional[str] = None,
+    ):
+        """Updates your user profile. All arguments are optional.
+
+        Arguments:
+            name {str} -- your name
+            company {str} -- the company you may or may not work for
+            bio {str} -- tell us about yourself
+            avatar {str} -- a nice photo of yourself
+
+        Returns    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT):
+            bool -- True if your profile was updated successfully
+        """
+        metrics.track(metrics.USER, self.account, {"name": "update"})
+        query = gql(
+            """
+            mutation UserUpdate($user: UserUpdateInput!) {
+                userUpdate(user: $user)
+            }
+            """
+        )
+        params = {"name": name, "company": company, "bio": bio, "avatar": avatar}
+
+        params = {"user": {k: v for k, v in params.items() if v is not None}}
+
+        if not params["user"]:
+            return SpeckleException(
+                message=(
+                    "You must provide at least one field to update your user profile"
+                )
+            )
+
+        return self.make_request(
+            query=query, params=params, return_type="userUpdate", parse_response=False
+        )
+
+    def activity(
+        self,
+        limit: int = 20,
+        action_type: Optional[str] = None,
+        before: Optional[datetime] = None,
+        after: Optional[datetime] = None,
+        cursor: Optional[datetime] = None,
+    ):
+        """
+        Get the activity from a given stream in an Activity collection.
+        Step into the activity `items` for the list of activity.
+        If no id argument is provided, will return the current authenticated user's
+        activity (as extracted from the authorization header).
+
+        Note: all timestamps arguments should be `datetime` of any tz as they will be
+        converted to UTC ISO format strings
+
+        user_id {str} -- the id of the user to get the 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 UserActivity(
+                $action_type: String,
+                $before:DateTime,
+                $after: DateTime,
+                $cursor: DateTime,
+                $limit: Int
+                ){
+                activeUser {
+                    activity(
+                        actionType: $action_type,
+                        before: $before,
+                        after: $after,
+                        cursor: $cursor,
+                        limit: $limit
+                        ) {
+                        totalCount
+                        cursor
+                        items {
+                            actionType
+                            info
+                            userId
+                            streamId
+                            resourceId
+                            resourceType
+                            message
+                            time
+                        }
+                    }
+                }
+            }
+            """
+        )
+
+        params = {
+            "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,
+        }
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type=["activeUser", "activity"],
+            schema=ActivityCollection,
+        )
+
+    def get_all_pending_invites(self) -> List[PendingStreamCollaborator]:
+        """Get all of the active user's pending stream invites
+
+        Requires Speckle Server version >= 2.6.4
+
+        Returns:
+            List[PendingStreamCollaborator]
+            -- a list of pending invites for the current user
+        """
+        metrics.track(metrics.INVITE, self.account, {"name": "get"})
+        self._check_invites_supported()
+
+        query = gql(
+            """
+            query StreamInvites {
+                streamInvites{
+                    id
+                    token
+                    inviteId
+                    streamId
+                    streamName
+                    title
+                    role
+                    invitedBy {
+                        id
+                        name
+                        company
+                        avatar
+                    }
+                }
+            }
+            """
+        )
+
+        return self.make_request(
+            query=query,
+            return_type="streamInvites",
+            schema=PendingStreamCollaborator,
+        )
+
+    def get_pending_invite(
+        self, stream_id: str, token: Optional[str] = None
+    ) -> Optional[PendingStreamCollaborator]:
+        """Get a particular pending invite for the active user on a given stream.
+        If no invite_id is provided, any valid invite will be returned.
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream to look for invites on
+            token {str} -- the token of the invite to look for (optional)
+
+        Returns:
+            PendingStreamCollaborator
+            -- the invite for the given stream (or None if it isn't found)
+        """
+        metrics.track(metrics.INVITE, self.account, {"name": "get"})
+        self._check_invites_supported()
+
+        query = gql(
+            """
+            query StreamInvite($streamId: String!, $token: String) {
+                streamInvite(streamId: $streamId, token: $token) {
+                    id
+                    token
+                    streamId
+                    streamName
+                    title
+                    role
+                    invitedBy {
+                        id
+                        name
+                        company
+                        avatar
+                    }
+                }
+            }
+            """
+        )
+
+        params = {"streamId": stream_id}
+        if token:
+            params["token"] = token
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamInvite",
+            schema=PendingStreamCollaborator,
+        )

src/specklepy/api/resources/branch.py

@@ -1,20 +1,23 @@
-from specklepy.api.resources import stream
-from typing import List, Optional
+from typing import Optional
+
 from gql import gql
-from pydantic.main import BaseModel
-from specklepy.api.resource import ResourceBase
+
 from specklepy.api.models import Branch
+from specklepy.api.resource import ResourceBase
+from specklepy.logging import metrics
 
 NAME = "branch"
-METHODS = ["create"]
 
 
 class Resource(ResourceBase):
     """API Access class for branches"""
 
-    def __init__(self, me, basepath, client) -> None:
+    def __init__(self, account, basepath, client) -> None:
         super().__init__(
-            me=me, basepath=basepath, client=client, name=NAME, methods=METHODS
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
         )
         self.schema = Branch
 
@@ -30,7 +33,7 @@ class Resource(ResourceBase):
         Returns:
             id {str} -- the newly created branch's id
         """
-
+        metrics.track(metrics.BRANCH, self.account, {"name": "create"})
         query = gql(
             """
             mutation BranchCreate($branch: BranchCreateInput!) {
@@ -61,7 +64,7 @@ class Resource(ResourceBase):
         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!) {
@@ -86,7 +89,7 @@ class Resource(ResourceBase):
                               createdAt
                             }
                         }
-                    }                      
+                    }
                 }
             }
             """
@@ -109,9 +112,14 @@ class Resource(ResourceBase):
         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!) {
+            query BranchesGet(
+                    $stream_id: String!,
+                    $branches_limit: Int!,
+                    $commits_limit: Int!
+                ) {
                 stream(id: $stream_id) {
                     branches(limit: $branches_limit) {
                         items {
@@ -150,7 +158,11 @@ class Resource(ResourceBase):
         )
 
     def update(
-        self, stream_id: str, branch_id: str, name: str = None, description: str = None
+        self,
+        stream_id: str,
+        branch_id: str,
+        name: Optional[str] = None,
+        description: Optional[str] = None,
     ):
         """Update a branch
 
@@ -161,8 +173,9 @@ class Resource(ResourceBase):
             description {str} -- optional: the updated branch description
 
         Returns:
-            bool -- True if update is successfull
+            bool -- True if update is successful
         """
+        metrics.track(metrics.BRANCH, self.account, {"name": "update"})
         query = gql(
             """
             mutation  BranchUpdate($branch: BranchUpdateInput!) {
@@ -196,7 +209,7 @@ class Resource(ResourceBase):
         Returns:
             bool -- True if deletion is successful
         """
-
+        metrics.track(metrics.BRANCH, self.account, {"name": "delete"})
         query = gql(
             """
             mutation BranchDelete($branch: BranchDeleteInput!) {

src/specklepy/api/resources/commit.py

@@ -1,20 +1,23 @@
-from typing import Optional, List
-from gql import gql
-from pydantic.main import BaseModel
-from specklepy.api.resource import ResourceBase
-from specklepy.api.models import Commit
+from typing import List, Optional
 
+from gql import gql
+
+from specklepy.api.models import Commit
+from specklepy.api.resource import ResourceBase
+from specklepy.logging import metrics
 
 NAME = "commit"
-METHODS = []
 
 
 class Resource(ResourceBase):
     """API Access class for commits"""
 
-    def __init__(self, me, basepath, client) -> None:
+    def __init__(self, account, basepath, client) -> None:
         super().__init__(
-            me=me, basepath=basepath, client=client, name=NAME, methods=METHODS
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
         )
         self.schema = Commit
 
@@ -35,11 +38,12 @@ class Resource(ResourceBase):
                 stream(id: $stream_id) {
                     commit(id: $commit_id) {
                         id
-                        referencedObject
                         message
+                        referencedObject
                         authorId
                         authorName
                         authorAvatar
+                        branchName
                         createdAt
                         sourceApplication
                         totalChildrenCount
@@ -66,6 +70,7 @@ class Resource(ResourceBase):
         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!) {
@@ -79,6 +84,7 @@ class Resource(ResourceBase):
                             authorId
                             authorName
                             authorAvatar
+                            branchName
                             createdAt
                             sourceApplication
                             totalChildrenCount
@@ -110,17 +116,23 @@ class Resource(ResourceBase):
         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")
+            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)}
+            mutation CommitCreate ($commit: CommitCreateInput!)
+                { commitCreate(commit: $commit)}
             """
         )
         params = {
@@ -144,16 +156,19 @@ class Resource(ResourceBase):
         Update a commit
 
         Arguments:
-            stream_id {str} -- the id of the stream that contains the commit you'd like to update
+            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)}
+            mutation CommitUpdate($commit: CommitUpdateInput!)
+                { commitUpdate(commit: $commit)}
             """
         )
         params = {
@@ -169,15 +184,18 @@ class Resource(ResourceBase):
         Delete a commit
 
         Arguments:
-            stream_id {str} -- the id of the stream that contains the commit you'd like to delete
+            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)}
+            mutation CommitDelete($commit: CommitDeleteInput!)
+                { commitDelete(commit: $commit)}
             """
         )
         params = {"commit": {"streamId": stream_id, "id": commit_id}}
@@ -185,3 +203,41 @@ class Resource(ResourceBase):
         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

src/specklepy/api/resources/object.py

@@ -1,19 +1,22 @@
 from typing import Dict, List
+
 from gql import gql
-from graphql.language import parser
+
 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, me, basepath, client) -> None:
+    def __init__(self, account, basepath, client) -> None:
         super().__init__(
-            me=me, basepath=basepath, client=client, name=NAME, methods=METHODS
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
         )
         self.schema = Base
 
@@ -49,28 +52,37 @@ class Resource(ResourceBase):
         params = {"stream_id": stream_id, "object_id": object_id}
 
         return self.make_request(
-            query=query, params=params, return_type=["stream", "object", "data"]
+            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.
+        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
+        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)
+            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) }
+          mutation ObjectCreate($object_input: ObjectCreateInput!) {
+            objectCreate(objectInput: $object_input)
+        }
           """
         )
         params = {"object_input": {"streamId": stream_id, "objects": objects}}

src/specklepy/api/resources/other_user.py

@@ -0,0 +1,175 @@
+from datetime import datetime, timezone
+from typing import List, Optional, Union
+
+from gql import gql
+
+from specklepy.api.models import ActivityCollection, LimitedUser
+from specklepy.api.resource import ResourceBase
+from specklepy.logging import metrics
+from specklepy.logging.exceptions import SpeckleException
+
+NAME = "other_user"
+
+
+class Resource(ResourceBase):
+    """API Access class for other users, that are not the currently active user."""
+
+    def __init__(self, account, basepath, client, server_version) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+            server_version=server_version,
+        )
+        self.schema = LimitedUser
+
+    def get(self, id: str) -> LimitedUser:
+        """
+        Gets the profile of another user.
+
+        Arguments:
+            id {str} -- the user id
+
+        Returns:
+            LimitedUser -- the retrieved profile of another user
+        """
+        metrics.track(metrics.OTHER_USER, self.account, {"name": "get"})
+        query = gql(
+            """
+            query OtherUser($id: String!) {
+                otherUser(id: $id) {
+                    id
+                    name
+                    bio
+                    company
+                    avatar
+                    verified
+                    role
+                }
+            }
+          """
+        )
+
+        params = {"id": id}
+
+        return self.make_request(query=query, params=params, return_type="otherUser")
+
+    def search(
+        self, search_query: str, limit: int = 25
+    ) -> Union[List[LimitedUser], SpeckleException]:
+        """Searches for user by name or email. The search query must be at least
+        3 characters long
+
+        Arguments:
+            search_query {str} -- a string to search for
+            limit {int} -- the maximum number of results to return
+        Returns:
+            List[LimitedUser] -- a list of User objects that match the search query
+        """
+        if len(search_query) < 3:
+            return SpeckleException(
+                message="User search query must be at least 3 characters"
+            )
+
+        metrics.track(metrics.OTHER_USER, self.account, {"name": "search"})
+        query = gql(
+            """
+            query UserSearch($search_query: String!, $limit: Int!) {
+                userSearch(query: $search_query, limit: $limit) {
+                    items {
+                        id
+                        name
+                        bio
+                        company
+                        avatar
+                        verified
+                    }
+                }
+            }
+          """
+        )
+        params = {"search_query": search_query, "limit": limit}
+
+        return self.make_request(
+            query=query, params=params, return_type=["userSearch", "items"]
+        )
+
+    def activity(
+        self,
+        user_id: str,
+        limit: int = 20,
+        action_type: Optional[str] = None,
+        before: Optional[datetime] = None,
+        after: Optional[datetime] = None,
+        cursor: Optional[datetime] = None,
+    ) -> ActivityCollection:
+        """
+        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
+
+        user_id {str} -- the id of the user to get the 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 UserActivity(
+                $user_id: String!,
+                $action_type: String,
+                $before:DateTime,
+                $after: DateTime,
+                $cursor: DateTime,
+                $limit: Int
+                ){
+                otherUser(id: $user_id) {
+                    activity(
+                        actionType: $action_type,
+                        before: $before,
+                        after: $after,
+                        cursor: $cursor,
+                        limit: $limit
+                        ) {
+                        totalCount
+                        cursor
+                        items {
+                            actionType
+                            info
+                            userId
+                            streamId
+                            resourceId
+                            resourceType
+                            message
+                            time
+                        }
+                    }
+                }
+            }
+            """
+        )
+
+        params = {
+            "user_id": user_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,
+        }
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type=["otherUser", "activity"],
+            schema=ActivityCollection,
+        )

src/specklepy/api/resources/server.py

@@ -1,20 +1,25 @@
-from typing import Dict, List
+import re
+from typing import Any, Dict, List, Tuple
+
 from gql import gql
-from gql.client import Client
+
 from specklepy.api.models import ServerInfo
 from specklepy.api.resource import ResourceBase
-
+from specklepy.logging import metrics
+from specklepy.logging.exceptions import GraphQLException
 
 NAME = "server"
-METHODS = ["get", "apps"]
 
 
 class Resource(ResourceBase):
     """API Access class for the server"""
 
-    def __init__(self, me, basepath, client) -> None:
+    def __init__(self, account, basepath, client) -> None:
         super().__init__(
-            me=me, basepath=basepath, client=client, name=NAME, methods=METHODS
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
         )
 
     def get(self) -> ServerInfo:
@@ -23,6 +28,7 @@ class Resource(ResourceBase):
         Returns:
             dict -- the server info in dictionary form
         """
+        metrics.track(metrics.SERVER, self.account, {"name": "get"})
         query = gql(
             """
             query Server {
@@ -56,12 +62,46 @@ class Resource(ResourceBase):
             query=query, return_type="serverInfo", schema=ServerInfo
         )
 
+    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 {
@@ -95,6 +135,7 @@ class Resource(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!) {
@@ -120,6 +161,7 @@ class Resource(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!) {

src/specklepy/api/resources/stream.py

@@ -0,0 +1,825 @@
+from datetime import datetime, timezone
+from typing import List, Optional
+
+from deprecated import deprecated
+from gql import gql
+
+from specklepy.api.models import ActivityCollection, PendingStreamCollaborator, Stream
+from specklepy.api.resource import ResourceBase
+from specklepy.logging import metrics
+from specklepy.logging.exceptions import SpeckleException, UnsupportedException
+
+NAME = "stream"
+
+
+class Resource(ResourceBase):
+    """API Access class for streams"""
+
+    def __init__(self, account, basepath, client, server_version) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+            server_version=server_version,
+        )
+
+        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: Optional[str] = None,
+        description: Optional[str] = None,
+        is_public: Optional[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"]
+        )
+
+    @deprecated(
+        version="2.6.4",
+        reason=(
+            "As of Speckle Server v2.6.4, this method is deprecated. Users need to be"
+            " invited and accept the invite before being added to a stream"
+        ),
+    )
+    def grant_permission(self, stream_id: str, user_id: str, role: str):
+        """Grant permissions to a user on a given stream
+
+        Valid for Speckle Server version < 2.6.4
+
+        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})
+        # we're checking for the actual version info, and if the version is 'dev' we treat it
+        # as an up to date instance
+        if self.server_version and (
+            self.server_version == ("dev",) or self.server_version >= (2, 6, 4)
+        ):
+            raise UnsupportedException(
+                "Server mutation `grant_permission` is no longer supported as of"
+                " Speckle Server v2.6.4. Please use the new `update_permission` method"
+                " to change an existing user's permission or use the `invite` method to"
+                " invite a user to a stream."
+            )
+
+        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 get_all_pending_invites(
+        self, stream_id: str
+    ) -> List[PendingStreamCollaborator]:
+        """Get all of the pending invites on a stream.
+        You must be a `stream:owner` to query this.
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the stream id from which to get the pending invites
+
+        Returns:
+            List[PendingStreamCollaborator]
+                -- a list of pending invites for the specified stream
+        """
+        metrics.track(metrics.INVITE, self.account, {"name": "get"})
+        self._check_invites_supported()
+
+        query = gql(
+            """
+            query StreamInvites($streamId: String!) {
+                stream(id: $streamId){
+                    pendingCollaborators {
+                        id
+                        token
+                        inviteId
+                        streamId
+                        streamName
+                        title
+                        role
+                        invitedBy{
+                            id
+                            name
+                            company
+                            avatar
+                        }
+                        user {
+                            id
+                            name
+                            company
+                            avatar
+                        }
+                    }
+                }
+            }
+            """
+        )
+        params = {"streamId": stream_id}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type=["stream", "pendingCollaborators"],
+            schema=PendingStreamCollaborator,
+        )
+
+    def invite(
+        self,
+        stream_id: str,
+        email: Optional[str] = None,
+        user_id: Optional[str] = None,
+        role: str = "stream:contributor",  # should default be reviewer?
+        message: Optional[str] = None,
+    ):
+        """Invite someone to a stream using either their email or user id
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream to invite the user to
+            email {str} -- the email of the user to invite (use this OR `user_id`)
+            user_id {str} -- the id of the user to invite (use this OR `email`)
+            role {str}
+                -- the role to assign to the user (defaults to `stream:contributor`)
+            message {str}
+                -- a message to send along with this invite to the specified user
+
+        Returns:
+            bool -- True if the operation was successful
+        """
+        metrics.track(metrics.INVITE, self.account, {"name": "create"})
+        self._check_invites_supported()
+
+        if email is None and user_id is None:
+            raise SpeckleException(
+                "You must provide either an email or a user id to use the"
+                " `stream.invite` method"
+            )
+
+        query = gql(
+            """
+            mutation StreamInviteCreate($input: StreamInviteCreateInput!) {
+                streamInviteCreate(input: $input)
+            }
+            """
+        )
+
+        params = {
+            "email": email,
+            "userId": user_id,
+            "streamId": stream_id,
+            "message": message,
+            "role": role,
+        }
+        params = {"input": {k: v for k, v in params.items() if v is not None}}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamInviteCreate",
+            parse_response=False,
+        )
+
+    def invite_batch(
+        self,
+        stream_id: str,
+        emails: Optional[List[str]] = None,
+        user_ids: Optional[List[None]] = None,
+        message: Optional[str] = None,
+    ) -> bool:
+        """Invite a batch of users to a specified stream.
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream to invite the user to
+            emails {List[str]}
+                -- the email of the user to invite (use this and/or `user_ids`)
+            user_id {List[str]}
+                -- the id of the user to invite (use this and/or `emails`)
+            message {str}
+                -- a message to send along with this invite to the specified user
+
+        Returns:
+            bool -- True if the operation was successful
+        """
+        metrics.track(metrics.INVITE, self.account, {"name": "batch create"})
+        self._check_invites_supported()
+        if emails is None and user_ids is None:
+            raise SpeckleException(
+                "You must provide either an email or a user id to use the"
+                " `stream.invite` method"
+            )
+
+        query = gql(
+            """
+            mutation StreamInviteBatchCreate($input: [StreamInviteCreateInput!]!) {
+                streamInviteBatchCreate(input: $input)
+            }
+            """
+        )
+
+        email_invites = [
+            {"streamId": stream_id, "message": message, "email": email}
+            for email in emails
+            if emails is not None
+        ]
+
+        user_invites = [
+            {"streamId": stream_id, "message": message, "userId": user_id}
+            for user_id in user_ids
+            if user_ids is not None
+        ]
+
+        params = {"input": [*email_invites, *user_invites]}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamInviteBatchCreate",
+            parse_response=False,
+        )
+
+    def invite_cancel(self, stream_id: str, invite_id: str) -> bool:
+        """Cancel an existing stream invite
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream invite
+            invite_id {str} -- the id of the invite to use
+
+        Returns:
+            bool -- true if the operation was successful
+        """
+        metrics.track(metrics.INVITE, self.account, {"name": "cancel"})
+        self._check_invites_supported()
+
+        query = gql(
+            """
+            mutation StreamInviteCancel($streamId: String!, $inviteId: String!) {
+                streamInviteCancel(streamId: $streamId, inviteId: $inviteId)
+            }
+            """
+        )
+
+        params = {"streamId": stream_id, "inviteId": invite_id}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamInviteCancel",
+            parse_response=False,
+        )
+
+    def invite_use(self, stream_id: str, token: str, accept: bool = True) -> bool:
+        """Accept or decline a stream invite
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str}
+                -- the id of the stream for which the user has a pending invite
+            token {str} -- the token of the invite to use
+            accept {bool} -- whether or not to accept the invite (defaults to True)
+
+        Returns:
+            bool -- true if the operation was successful
+        """
+        metrics.track(metrics.INVITE, self.account, {"name": "use"})
+        self._check_invites_supported()
+
+        query = gql(
+            """
+            mutation StreamInviteUse(
+                $accept: Boolean!,
+                $streamId: String!,
+                $token: String!
+                ) {
+                streamInviteUse(accept: $accept, streamId: $streamId, token: $token)
+            }
+            """
+        )
+
+        params = {"streamId": stream_id, "token": token, "accept": accept}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamInviteUse",
+            parse_response=False,
+        )
+
+    def update_permission(self, stream_id: str, user_id: str, role: str):
+        """Updates permissions for a user on a given stream
+
+        Valid for Speckle Server >=2.6.4
+
+        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": "update", "role": role}
+        )
+        if self.server_version and (
+            self.server_version != ("dev",) and self.server_version < (2, 6, 4)
+        ):
+            raise UnsupportedException(
+                "Server mutation `update_permission` is only supported as of Speckle"
+                " Server v2.6.4. Please update your Speckle Server to use this method"
+                " or use the `grant_permission` method instead."
+            )
+        query = gql(
+            """
+            mutation StreamUpdatePermission(
+                $permission_params: StreamUpdatePermissionInput!
+                ) {
+                streamUpdatePermission(permissionParams: $permission_params)
+            }
+            """
+        )
+
+        params = {
+            "permission_params": {
+                "streamId": stream_id,
+                "userId": user_id,
+                "role": role,
+            }
+        }
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamUpdatePermission",
+            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: Optional[str] = None,
+        limit: int = 20,
+        before: Optional[datetime] = None,
+        after: Optional[datetime] = None,
+        cursor: Optional[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,
+        )

src/specklepy/api/resources/subscriptions.py

@@ -1,16 +1,14 @@
-from typing import Callable, Dict, List, Optional, Any
 from functools import wraps
+from typing import Callable, Dict, List, Optional, Union
+
 from gql import gql
+from graphql import DocumentNode
+
 from specklepy.api.resource import ResourceBase
 from specklepy.api.resources.stream import Stream
-from specklepy.logging.exceptions import GraphQLException, SpeckleException
+from specklepy.logging.exceptions import SpeckleException
 
 NAME = "subscribe"
-METHODS = [
-    "stream_added",
-    "stream_updated",
-    "stream_removed",
-]
 
 
 def check_wsclient(function):
@@ -29,17 +27,22 @@ def check_wsclient(function):
 class Resource(ResourceBase):
     """API Access class for subscriptions"""
 
-    def __init__(self, me, basepath, client) -> None:
+    def __init__(self, account, basepath, client) -> None:
         super().__init__(
-            me=me, basepath=basepath, client=client, name=NAME, methods=METHODS
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
         )
 
     @check_wsclient
-    async def stream_added(self, callback: Callable = None):
-        """Subscribes to new stream added event for your profile. Use this to display an up-to-date list of streams.
+    async def stream_added(self, callback: Optional[Callable] = None):
+        """Subscribes to new stream added event for your profile.
+        Use this to display an up-to-date list of streams.
 
         Arguments:
-            callback {Callable[Stream]} -- a function that takes the updated stream as an argument and executes each time a stream is added
+            callback {Callable[Stream]} -- a function that takes the updated stream
+            as an argument and executes each time a stream is added
 
         Returns:
             Stream -- the update stream
@@ -54,12 +57,16 @@ class Resource(ResourceBase):
         )
 
     @check_wsclient
-    async def stream_updated(self, id: str, callback: Callable = None):
-        """Subscribes to stream updated event. Use this in clients/components that pertain only to this stream.
+    async def stream_updated(self, id: str, callback: Optional[Callable] = None):
+        """
+        Subscribes to stream updated event.
+        Use this in clients/components that pertain only to this stream.
 
         Arguments:
             id {str} -- the stream id of the stream to subscribe to
-            callback {Callable[Stream]} -- a function that takes the updated stream as an argument and executes each time the stream is updated
+            callback {Callable[Stream]}
+            -- a function that takes the updated stream
+            as an argument and executes each time the stream is updated
 
         Returns:
             Stream -- the update stream
@@ -80,11 +87,17 @@ class Resource(ResourceBase):
         )
 
     @check_wsclient
-    async def stream_removed(self, callback: Callable = None):
-        """Subscribes to stream removed event for your profile. Use this to display an up-to-date list of streams for your profile. NOTE: If someone revokes your permissions on a stream, this subscription will be triggered with an extra value of revokedBy in the payload.
+    async def stream_removed(self, callback: Optional[Callable] = None):
+        """Subscribes to stream removed event for your profile.
+        Use this to display an up-to-date list of streams for your profile.
+        NOTE: If someone revokes your permissions on a stream,
+        this subscription will be triggered with an extra value of revokedBy
+        in the payload.
 
         Arguments:
-            callback {Callable[Dict]} -- a function that takes the returned dict as an argument and executes each time a stream is removed
+            callback {Callable[Dict]}
+            -- a function that takes the returned dict as an argument
+            and executes each time a stream is removed
 
         Returns:
             dict -- dict containing 'id' of stream removed and optionally 'revokedBy'
@@ -105,15 +118,15 @@ class Resource(ResourceBase):
     @check_wsclient
     async def subscribe(
         self,
-        query: gql,
-        params: Dict = None,
-        callback: Callable = None,
-        return_type: str or List = None,
+        query: DocumentNode,
+        params: Optional[Dict] = None,
+        callback: Optional[Callable] = None,
+        return_type: Optional[Union[str, List]] = None,
         schema=None,
         parse_response: bool = True,
     ):
         # if self.client.transport.websocket is None:
-        #     TODO: add multiple subs to the same ws connection
+        # TODO: add multiple subs to the same ws connection
         async with self.client as session:
             async for res in session.subscribe(query, variable_values=params):
                 res = self._step_into_response(response=res, return_type=return_type)

src/specklepy/api/resources/user.py

@@ -0,0 +1,327 @@
+from datetime import datetime, timezone
+from typing import List, Optional, Union
+
+from deprecated import deprecated
+from gql import gql
+
+from specklepy.api.models import ActivityCollection, PendingStreamCollaborator, User
+from specklepy.api.resource import ResourceBase
+from specklepy.logging import metrics
+from specklepy.logging.exceptions import SpeckleException
+
+NAME = "user"
+
+DEPRECATION_VERSION = "2.9.0"
+DEPRECATION_TEXT = (
+    "The user resource is deprecated, please use the active_user or other_user"
+    " resources"
+)
+
+
+class Resource(ResourceBase):
+    """API Access class for users"""
+
+    def __init__(self, account, basepath, client, server_version) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+            server_version=server_version,
+        )
+        self.schema = User
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def get(self, id: Optional[str] = None) -> User:
+        """
+        Gets the profile of a user.
+        If no id argument is provided, will return the current authenticated
+        user's profile (as extracted from the authorization header).
+
+        Arguments:
+            id {str} -- the user id
+
+        Returns:
+            User -- the retrieved user
+        """
+        metrics.track(metrics.USER, self.account, {"name": "get"})
+        query = gql(
+            """
+            query User($id: String) {
+                user(id: $id) {
+                    id
+                    email
+                    name
+                    bio
+                    company
+                    avatar
+                    verified
+                    profiles
+                    role
+                }
+            }
+          """
+        )
+
+        params = {"id": id}
+
+        return self.make_request(query=query, params=params, return_type="user")
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def search(
+        self, search_query: str, limit: int = 25
+    ) -> Union[List[User], SpeckleException]:
+        """
+        Searches for user by name or email.
+        The search query must be at least 3 characters long
+
+        Arguments:
+            search_query {str} -- a string to search for
+            limit {int} -- the maximum number of results to return
+        Returns:
+            List[User] -- a list of User objects that match the search query
+        """
+        if len(search_query) < 3:
+            return SpeckleException(
+                message="User search query must be at least 3 characters"
+            )
+
+        metrics.track(metrics.USER, self.account, {"name": "search"})
+        query = gql(
+            """
+            query UserSearch($search_query: String!, $limit: Int!) {
+                userSearch(query: $search_query, limit: $limit) {
+                    items {
+                        id
+                        name
+                        bio
+                        company
+                        avatar
+                        verified
+                    }
+                }
+            }
+          """
+        )
+        params = {"search_query": search_query, "limit": limit}
+
+        return self.make_request(
+            query=query, params=params, return_type=["userSearch", "items"]
+        )
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def update(
+        self,
+        name: Optional[str] = None,
+        company: Optional[str] = None,
+        bio: Optional[str] = None,
+        avatar: Optional[str] = None,
+    ):
+        """Updates your user profile. All arguments are optional.
+
+        Arguments:
+            name {str} -- your name
+            company {str} -- the company you may or may not work for
+            bio {str} -- tell us about yourself
+            avatar {str} -- a nice photo of yourself
+
+        Returns:
+            bool -- True if your profile was updated successfully
+        """
+        metrics.track(metrics.USER, self.account, {"name": "update"})
+        query = gql(
+            """
+            mutation UserUpdate($user: UserUpdateInput!) {
+                userUpdate(user: $user)
+            }
+            """
+        )
+        params = {"name": name, "company": company, "bio": bio, "avatar": avatar}
+
+        params = {"user": {k: v for k, v in params.items() if v is not None}}
+
+        if not params["user"]:
+            return SpeckleException(
+                message=(
+                    "You must provide at least one field to update your user profile"
+                )
+            )
+
+        return self.make_request(
+            query=query, params=params, return_type="userUpdate", parse_response=False
+        )
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def activity(
+        self,
+        user_id: Optional[str] = None,
+        limit: int = 20,
+        action_type: Optional[str] = None,
+        before: Optional[datetime] = None,
+        after: Optional[datetime] = None,
+        cursor: Optional[datetime] = None,
+    ):
+        """
+        Get the activity from a given stream in an Activity collection.
+        Step into the activity `items` for the list of activity.
+        If no id argument is provided, will return the current authenticated
+        user's activity (as extracted from the authorization header).
+
+        Note: all timestamps arguments should be `datetime` of any tz as
+        they will be converted to UTC ISO format strings
+
+        user_id {str} -- the id of the user to get the 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 UserActivity(
+                $user_id: String,
+                $action_type: String,
+                $before:DateTime,
+                $after: DateTime,
+                $cursor: DateTime,
+                $limit: Int
+                ){
+                user(id: $user_id) {
+                    activity(
+                        actionType: $action_type,
+                        before: $before,
+                        after: $after,
+                        cursor: $cursor,
+                        limit: $limit
+                        ) {
+                        totalCount
+                        cursor
+                        items {
+                            actionType
+                            info
+                            userId
+                            streamId
+                            resourceId
+                            resourceType
+                            message
+                            time
+                        }
+                    }
+                }
+            }
+            """
+        )
+
+        params = {
+            "user_id": user_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,
+        }
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type=["user", "activity"],
+            schema=ActivityCollection,
+        )
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def get_all_pending_invites(self) -> List[PendingStreamCollaborator]:
+        """Get all of the active user's pending stream invites
+
+        Requires Speckle Server version >= 2.6.4
+
+        Returns:
+            List[PendingStreamCollaborator]
+                -- a list of pending invites for the current user
+        """
+        metrics.track(metrics.INVITE, self.account, {"name": "get"})
+        self._check_invites_supported()
+
+        query = gql(
+            """
+            query StreamInvites {
+                streamInvites{
+                    id
+                    token
+                    inviteId
+                    streamId
+                    streamName
+                    title
+                    role
+                    invitedBy {
+                        id
+                        name
+                        company
+                        avatar
+                    }
+                }
+            }
+            """
+        )
+
+        return self.make_request(
+            query=query,
+            return_type="streamInvites",
+            schema=PendingStreamCollaborator,
+        )
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def get_pending_invite(
+        self, stream_id: str, token: Optional[str] = None
+    ) -> Optional[PendingStreamCollaborator]:
+        """Get a particular pending invite for the active user on a given stream.
+        If no invite_id is provided, any valid invite will be returned.
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream to look for invites on
+            token {str} -- the token of the invite to look for (optional)
+
+        Returns:
+            PendingStreamCollaborator
+                -- the invite for the given stream (or None if it isn't found)
+        """
+        metrics.track(metrics.INVITE, self.account, {"name": "get"})
+        self._check_invites_supported()
+
+        query = gql(
+            """
+            query StreamInvite($streamId: String!, $token: String) {
+                streamInvite(streamId: $streamId, token: $token) {
+                    id
+                    token
+                    streamId
+                    streamName
+                    title
+                    role
+                    invitedBy {
+                        id
+                        name
+                        company
+                        avatar
+                    }
+                }
+            }
+            """
+        )
+
+        params = {"streamId": stream_id}
+        if token:
+            params["token"] = token
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamInvite",
+            schema=PendingStreamCollaborator,
+        )

src/specklepy/api/wrapper.py

@@ -0,0 +1,188 @@
+from urllib.parse import unquote, urlparse
+from warnings import warn
+
+from specklepy.api.client import SpeckleClient
+from specklepy.api.credentials import (
+    Account,
+    get_account_from_token,
+    get_local_accounts,
+)
+from specklepy.logging import metrics
+from specklepy.logging.exceptions import SpeckleException, SpeckleWarning
+from specklepy.transports.server.server import ServerTransport
+
+
+class StreamWrapper:
+    """
+    The `StreamWrapper` gives you some handy helpers to deal with urls and
+    get authenticated clients and transports.
+
+    Construct a `StreamWrapper` with a stream, branch, commit, or object URL.
+    The corresponding ids will be stored
+    in the wrapper. If you have local accounts on the machine,
+    you can use the `get_account` and `get_client` methods
+    to get a local account for the server. You can also pass a token into `get_client`
+    if you don't have a corresponding
+    local account for the server.
+
+    ```py
+    from specklepy.api.wrapper import StreamWrapper
+
+    # provide any stream, branch, commit, object, or globals url
+    wrapper = StreamWrapper("https://speckle.xyz/streams/3073b96e86/commits/604bea8cc6")
+
+    # get an authenticated SpeckleClient if you have a local account for the server
+    client = wrapper.get_client()
+
+    # get an authenticated ServerTransport if you have a local account for the server
+    transport = wrapper.get_transport()
+    ```
+    """
+
+    stream_url: str = None
+    use_ssl: bool = True
+    host: str = None
+    stream_id: str = None
+    commit_id: str = None
+    object_id: str = None
+    branch_name: str = None
+    _client: SpeckleClient = None
+    _account: Account = None
+
+    def __repr__(self):
+        return (
+            f"StreamWrapper( server: {self.host}, stream_id: {self.stream_id}, type:"
+            f" {self.type} )"
+        )
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+    @property
+    def type(self) -> str:
+        if self.object_id:
+            return "object"
+        elif self.commit_id:
+            return "commit"
+        elif self.branch_name:
+            return "branch"
+        else:
+            return "stream" if self.stream_id else "invalid"
+
+    def __init__(self, url: str) -> None:
+        self.stream_url = url
+        parsed = urlparse(url)
+        self.host = parsed.netloc
+        self.use_ssl = parsed.scheme == "https"
+        segments = parsed.path.strip("/").split("/", 3)
+        metrics.track(metrics.STREAM_WRAPPER, self.get_account())
+
+        if not segments or len(segments) < 2:
+            raise SpeckleException(
+                f"Cannot parse {url} into a stream wrapper class - invalid URL"
+                " provided."
+            )
+
+        while segments:
+            segment = segments.pop(0)
+            if segments and segment.lower() == "streams":
+                self.stream_id = segments.pop(0)
+            elif segments and segment.lower() == "commits":
+                self.commit_id = segments.pop(0)
+            elif segments and segment.lower() == "branches":
+                self.branch_name = unquote(segments.pop(0))
+            elif segments and segment.lower() == "objects":
+                self.object_id = segments.pop(0)
+            elif segment.lower() == "globals":
+                self.branch_name = "globals"
+                if segments:
+                    self.commit_id = segments.pop(0)
+            else:
+                raise SpeckleException(
+                    f"Cannot parse {url} into a stream wrapper class - invalid URL"
+                    " provided."
+                )
+
+        if not self.stream_id:
+            raise SpeckleException(
+                f"Cannot parse {url} into a stream wrapper class - no stream id found."
+            )
+
+    @property
+    def server_url(self):
+        return f"{'https' if self.use_ssl else 'http'}://{self.host}"
+
+    def get_account(self, token: str = None) -> Account:
+        """
+        Gets an account object for this server from the local accounts db
+        (added via Speckle Manager or a json file)
+        """
+        if self._account and self._account.token:
+            return self._account
+
+        self._account = next(
+            (
+                a
+                for a in get_local_accounts()
+                if self.host == urlparse(a.serverInfo.url).netloc
+            ),
+            None,
+        )
+
+        if not self._account:
+            self._account = get_account_from_token(token, self.server_url)
+
+        if self._client:
+            self._client.authenticate_with_account(self._account)
+
+        return self._account
+
+    def get_client(self, token: str = None) -> SpeckleClient:
+        """
+        Gets an authenticated client for this server.
+        You may provide a token if there aren't any local accounts on this
+        machine. If no account is found and no token is provided,
+        an unauthenticated client is returned.
+
+        Arguments:
+            token {str}
+            -- optional token if no local account is available (defaults to None)
+
+        Returns:
+            SpeckleClient
+            -- authenticated with a corresponding local account or the provided token
+        """
+        if self._client and token is None:
+            return self._client
+
+        if not self._account or not self._account.token:
+            self.get_account(token)
+
+        if not self._client:
+            self._client = SpeckleClient(host=self.host, use_ssl=self.use_ssl)
+
+        if self._account.token is None and token is None:
+            warn(f"No local account found for server {self.host}", SpeckleWarning)
+            return self._client
+
+        if self._account.token:
+            self._client.authenticate_with_account(self._account)
+        else:
+            self._client.authenticate_with_token(token)
+
+        return self._client
+
+    def get_transport(self, token: str = None) -> ServerTransport:
+        """
+        Gets a server transport for this stream using an authenticated client.
+        If there is no local account for this
+        server and the client was not authenticated with a token,
+        this will throw an exception.
+
+        Returns:
+            ServerTransport -- constructed for this stream
+            with a pre-authenticated client
+        """
+        if not self._account or not self._account.token:
+            self.get_account(token)
+        return ServerTransport(self.stream_id, account=self._account)

src/specklepy/core/__init__.py

@@ -0,0 +1,6 @@
+"""
+This is the Core SDK module of `specklepy`.
+
+This module should be kept in sync with the functionalities of our other SDKs especially
+C# Core https://github.com/specklesystems/speckle-sharp/tree/main/Core/Core
+"""

src/specklepy/core/helpers/__init__.py

@@ -0,0 +1 @@
+"""Common helpers module for Core."""

src/specklepy/core/helpers/speckle_path_provider.py

@@ -0,0 +1,115 @@
+"""
+Provides uniform and consistent path helpers for `specklepy`
+"""
+import os
+import sys
+from pathlib import Path
+from typing import Optional
+
+from specklepy.logging.exceptions import SpeckleException
+
+_user_data_env_var = "SPECKLE_USERDATA_PATH"
+
+
+def _path() -> Optional[Path]:
+    """Read the user data path override setting."""
+    path_override = os.environ.get(_user_data_env_var)
+    if path_override:
+        return Path(path_override)
+    return None
+
+
+_application_name = "Speckle"
+
+
+def override_application_name(application_name: str) -> None:
+    """Override the global Speckle application name."""
+    global _application_name
+    _application_name = application_name
+
+
+def override_application_data_path(path: Optional[str]) -> None:
+    """
+    Override the global Speckle application data path.
+
+    If the value of path is `None` the environment variable gets deleted.
+    """
+    if path:
+        os.environ[_user_data_env_var] = path
+    else:
+        os.environ.pop(_user_data_env_var, None)
+
+
+_blob_folder_name = "Blobs"
+
+
+def override_blob_storage_folder(blob_folder_name: str) -> None:
+    """Override the global Blob storage folder name."""
+    global _blob_folder_name
+    _blob_folder_name = blob_folder_name
+
+
+_accounts_folder_name = "Accounts"
+
+
+def override_accounts_folder_name(accounts_folder_name: str) -> None:
+    """Override the global Accounts folder name."""
+    global _accounts_folder_name
+    _accounts_folder_name = accounts_folder_name
+
+
+_objects_folder_name = "Objects"
+
+
+def override_objects_folder_name(objects_folder_name: str) -> None:
+    """Override global Objects folder name."""
+    global _objects_folder_name
+    _objects_folder_name = objects_folder_name
+
+
+def _ensure_folder_exists(base_path: Path, folder_name: str) -> Path:
+    path = base_path.joinpath(folder_name)
+    path.mkdir(exist_ok=True, parents=True)
+    return path
+
+
+def user_application_data_path() -> Path:
+    """Get the platform specific user configuration folder path"""
+    path_override = _path()
+    if path_override:
+        return path_override
+
+    try:
+        if sys.platform.startswith("win"):
+            app_data_path = os.getenv("APPDATA")
+            if not app_data_path:
+                raise SpeckleException(
+                    message="Cannot get appdata path from environment."
+                )
+            return Path(app_data_path)
+        else:
+            # try getting the standard XDG_DATA_HOME value
+            # as that is used as an override
+            app_data_path = os.getenv("XDG_DATA_HOME")
+            if app_data_path:
+                return Path(app_data_path)
+            else:
+                return _ensure_folder_exists(Path.home(), ".config")
+    except Exception as ex:
+        raise SpeckleException(
+            message="Failed to initialize user application data path.", exception=ex
+        )
+
+
+def user_speckle_folder_path() -> Path:
+    """Get the folder where the user's Speckle data should be stored."""
+    return _ensure_folder_exists(user_application_data_path(), _application_name)
+
+
+def accounts_folder_path() -> Path:
+    """Get the folder where the Speckle accounts data should be stored."""
+    return _ensure_folder_exists(user_speckle_folder_path(), _accounts_folder_name)
+
+
+def blob_storage_path(path: Optional[Path] = None) -> Path:
+    return _ensure_folder_exists(path or user_speckle_folder_path(), _blob_folder_name)

src/specklepy/logging/exceptions.py

@@ -0,0 +1,60 @@
+from typing import Any, List, Optional
+
+
+class SpeckleException(Exception):
+    def __init__(self, message: str, exception: Exception = None) -> None:
+        super().__init__()
+        self.message = message
+        self.exception = exception
+
+    def __str__(self) -> str:
+        return f"SpeckleException: {self.message}"
+
+
+class SpeckleInvalidUnitException(SpeckleException):
+    def __init__(self, invalid_unit: Any) -> None:
+        super().__init__(
+            message=(
+                "Invalid units: expected type str but received"
+                f" {type(invalid_unit)} ({invalid_unit})."
+            ),
+            exception=None,
+        )
+
+
+class SerializationException(SpeckleException):
+    def __init__(self, message: str, obj: Any, exception: Exception = None) -> None:
+        super().__init__(message=message, exception=exception)
+        self.obj = obj
+        self.unhandled_type = type(obj)
+
+    def __str__(self) -> str:
+        return (
+            "SpeckleException: Could not serialize object of type"
+            f" {self.unhandled_type}"
+        )
+
+
+class GraphQLException(SpeckleException):
+    def __init__(
+        self, message: str, errors: Optional[List[Any]] = None, data=None
+    ) -> None:
+        super().__init__(message=message)
+        self.errors = errors
+        self.data = data
+
+    def __str__(self) -> str:
+        return f"GraphQLException: {self.message}"
+
+
+class UnsupportedException(SpeckleException):
+    def __init__(self, message: str) -> None:
+        super().__init__(message=message)
+
+    def __str__(self) -> str:
+        return f"UnsupportedException: {self.message}"
+
+
+class SpeckleWarning(Warning):
+    def __init__(self, *args: object) -> None:
+        super().__init__(*args)

src/specklepy/logging/metrics.py

@@ -0,0 +1,154 @@
+import contextlib
+import getpass
+import hashlib
+import logging
+import platform
+import queue
+import sys
+import threading
+from typing import Optional
+
+import requests
+
+"""
+Anonymous telemetry to help us understand how to make a better Speckle.
+This really helps us to deliver a better open source project and product!
+"""
+TRACK = True
+HOST_APP = "python"
+HOST_APP_VERSION = f"python {'.'.join(map(str, sys.version_info[:2]))}"
+PLATFORMS = {"win32": "Windows", "cygwin": "Windows", "darwin": "Mac OS X"}
+
+LOG = logging.getLogger(__name__)
+METRICS_TRACKER = None
+
+# actions
+RECEIVE = "Receive"
+SEND = "Send"
+STREAM = "Stream Action"
+PERMISSION = "Permission Action"
+INVITE = "Invite Action"
+COMMIT = "Commit Action"
+BRANCH = "Branch Action"
+USER = "User Action"
+OTHER_USER = "Other User Action"
+SERVER = "Server Action"
+CLIENT = "Speckle Client"
+STREAM_WRAPPER = "Stream Wrapper"
+
+ACCOUNTS = "Get Local Accounts"
+
+SERIALIZE = "serialization/serialize"
+DESERIALIZE = "serialization/deserialize"
+
+
+def disable():
+    global TRACK
+    TRACK = False
+
+
+def enable():
+    global TRACK
+    TRACK = True
+
+
+def set_host_app(host_app: str, host_app_version: Optional[str] = None):
+    global HOST_APP, HOST_APP_VERSION
+    HOST_APP = host_app
+    HOST_APP_VERSION = host_app_version or HOST_APP_VERSION
+
+
+def track(
+    action: str,
+    account=None,
+    custom_props: Optional[dict] = None,
+):
+    if not TRACK:
+        return
+    try:
+        initialise_tracker(account)
+        event_params = {
+            "event": action,
+            "properties": {
+                "distinct_id": METRICS_TRACKER.last_user,
+                "server_id": METRICS_TRACKER.last_server,
+                "token": METRICS_TRACKER.analytics_token,
+                "hostApp": HOST_APP,
+                "hostAppVersion": HOST_APP_VERSION,
+                "$os": METRICS_TRACKER.platform,
+                "type": "action",
+            },
+        }
+        if custom_props:
+            event_params["properties"].update(custom_props)
+
+        METRICS_TRACKER.queue.put_nowait(event_params)
+    except Exception as ex:
+        # wrapping this whole thing in a try except as we never want a failure here to annoy users!
+        LOG.debug(f"Error queueing metrics request: {str(ex)}")
+
+
+def initialise_tracker(account=None):
+    global METRICS_TRACKER
+    if not METRICS_TRACKER:
+        METRICS_TRACKER = MetricsTracker()
+
+    if account and account.userInfo.email:
+        METRICS_TRACKER.set_last_user(account.userInfo.email)
+    if account and account.serverInfo.url:
+        METRICS_TRACKER.set_last_server(account.userInfo.email)
+
+
+class Singleton(type):
+    _instances = {}
+
+    def __call__(cls, *args, **kwargs):
+        if cls not in cls._instances:
+            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)
+        return cls._instances[cls]
+
+
+class MetricsTracker(metaclass=Singleton):
+    analytics_url = "https://analytics.speckle.systems/track?ip=1"
+    analytics_token = "acd87c5a50b56df91a795e999812a3a4"
+    last_user = ""
+    last_server = None
+    platform = None
+    sending_thread = None
+    queue = queue.Queue(1000)
+
+    def __init__(self) -> None:
+        self.sending_thread = threading.Thread(
+            target=self._send_tracking_requests, daemon=True
+        )
+        self.platform = PLATFORMS.get(sys.platform, "linux")
+        self.sending_thread.start()
+        with contextlib.suppress(Exception):
+            node, user = platform.node(), getpass.getuser()
+            if node and user:
+                self.last_user = f"@{self.hash(f'{node}-{user}')}"
+
+    def set_last_user(self, email: str):
+        if not email:
+            return
+        self.last_user = f"@{self.hash(email)}"
+
+    def set_last_server(self, server: str):
+        if not server:
+            return
+        self.last_server = self.hash(server)
+
+    def hash(self, value: str):
+        return hashlib.md5(value.lower().encode("utf-8")).hexdigest().upper()
+
+    def _send_tracking_requests(self):
+        session = requests.Session()
+        while True:
+            event_params = [self.queue.get()]
+
+            try:
+                session.post(self.analytics_url, json=event_params)
+            except Exception as ex:
+                LOG.debug(f"Error sending metrics request: {str(ex)}")
+
+            self.queue.task_done()

src/specklepy/objects/__init__.py

@@ -0,0 +1,6 @@
+"""Builtin Speckle object kit."""
+
+from specklepy.objects import encoding, geometry, other, primitive, structural, units
+from specklepy.objects.base import Base
+
+__all__ = ["Base", "encoding", "geometry", "other", "units", "structural", "primitive"]

src/specklepy/objects/base.py

@@ -0,0 +1,562 @@
+import contextlib
+from enum import Enum
+from inspect import isclass
+from typing import (
+    Any,
+    ClassVar,
+    Dict,
+    List,
+    Optional,
+    Set,
+    Tuple,
+    Type,
+    Union,
+    get_type_hints,
+)
+from warnings import warn
+
+from stringcase import pascalcase
+
+from specklepy.logging.exceptions import SpeckleException
+from specklepy.objects.units import Units, get_units_from_string
+from specklepy.transports.memory import MemoryTransport
+
+PRIMITIVES = (int, float, str, bool)
+
+# to remove from dir() when calling get_member_names()
+REMOVE_FROM_DIR = {
+    "Config",
+    "_Base__dict_helper",
+    "__annotations__",
+    "__class__",
+    "__delattr__",
+    "__dict__",
+    "__dir__",
+    "__doc__",
+    "__eq__",
+    "__format__",
+    "__ge__",
+    "__getattribute__",
+    "__getitem__",
+    "__gt__",
+    "__hash__",
+    "__init__",
+    "__init_subclass__",
+    "__le__",
+    "__lt__",
+    "__module__",
+    "__ne__",
+    "__new__",
+    "__reduce__",
+    "__reduce_ex__",
+    "__repr__",
+    "__setattr__",
+    "__setitem__",
+    "__sizeof__",
+    "__str__",
+    "__subclasshook__",
+    "__weakref__",
+    "_chunk_size_default",
+    "_chunkable",
+    "_count_descendants",
+    "_attr_types",
+    "_detachable",
+    "_handle_object_count",
+    "_type_check",
+    "_type_registry",
+    "_units",
+    "add_chunkable_attrs",
+    "add_detachable_attrs",
+    "get_children_count",
+    "get_dynamic_member_names",
+    "get_id",
+    "get_member_names",
+    "get_registered_type",
+    "get_typed_member_names",
+    "to_dict",
+    "update_forward_refs",
+    "validate_prop_name",
+    "from_list",
+    "to_list",
+}
+
+
+class _RegisteringBase:
+    """
+    Private Base model for Speckle types.
+
+    This is an implementation detail, please do not use this outside this module.
+
+    This class provides automatic registration of `speckle_type` into a global,
+    (class level) registry for each subclassing type.
+    The type registry is a base for accurate type based (de)serialization.
+    """
+
+    speckle_type: ClassVar[str]
+    _speckle_type_override: ClassVar[Optional[str]] = None
+    _speckle_namespace: ClassVar[Optional[str]] = None
+    _type_registry: ClassVar[Dict[str, Type["Base"]]] = {}
+    _attr_types: ClassVar[Dict[str, Type]] = {}
+    # dict of chunkable props and their max chunk size
+    _chunkable: Dict[str, int] = {}
+    _chunk_size_default: int = 1000
+    _detachable: Set[str] = set()  # list of defined detachable props
+    _serialize_ignore: Set[str] = set()
+
+    @classmethod
+    def get_registered_type(cls, speckle_type: str) -> Optional[Type["Base"]]:
+        """Get the registered type from the protected mapping via the `speckle_type`"""
+        for full_name in reversed(speckle_type.split(":")):
+            maybe_type = cls._type_registry.get(full_name, None)
+            if maybe_type:
+                return maybe_type
+        return None
+
+    @classmethod
+    def _determine_speckle_type(cls) -> str:
+        """
+        This method brings the speckle_type construction in par with peckle-sharp/Core.
+
+        The implementation differs, because in Core the basis of the speckle_type if
+        type.FullName, which includes the dotnet namespace name too.
+        Copying that behavior is hard in python, where the concept of namespaces
+        means something entirely different.
+
+        So we enabled a speckle_type override mechanism, that enables
+        """
+        base_name = "Base"
+        if cls.__name__ == base_name:
+            return base_name
+
+        bases = [
+            b._full_name()
+            for b in reversed(cls.mro())
+            if issubclass(b, Base) and b.__name__ != base_name
+        ]
+        return ":".join(bases)
+
+    @classmethod
+    def _full_name(cls) -> str:
+        base_name = "Base"
+        if cls.__name__ == base_name:
+            return base_name
+
+        if cls._speckle_type_override:
+            return cls._speckle_type_override
+
+        # convert the module names to PascalCase to match c# namespace naming convention
+        # also drop specklepy from the beginning
+        namespace = ".".join(
+            pascalcase(m)
+            for m in filter(lambda name: name != "specklepy", cls.__module__.split("."))
+        )
+        return f"{namespace}.{cls.__name__}"
+
+    def __init_subclass__(
+        cls,
+        speckle_type: Optional[str] = None,
+        chunkable: Optional[Dict[str, int]] = None,
+        detachable: Optional[Set[str]] = None,
+        serialize_ignore: Optional[Set[str]] = None,
+        **kwargs: Dict[str, Any],
+    ):
+        """
+        Hook into subclass type creation.
+
+        This is provides a mechanism to hook into the event of the subclass type object
+        initialization. This is reused to register each subclassing type into a class
+        level dictionary.
+        """
+        cls._speckle_type_override = speckle_type
+        cls.speckle_type = cls._determine_speckle_type()
+        if cls._full_name() in cls._type_registry:
+            raise ValueError(
+                f"The speckle_type: {speckle_type} is already registered for type: "
+                f"{cls._type_registry[cls._full_name()].__name__}. "
+                "Please choose a different type name."
+            )
+        cls._type_registry[cls._full_name()] = cls  # type: ignore
+        try:
+            cls._attr_types = get_type_hints(cls)
+        except Exception:
+            cls._attr_types = getattr(cls, "__annotations__", {})
+        if chunkable:
+            chunkable = {k: v for k, v in chunkable.items() if isinstance(v, int)}
+            cls._chunkable = dict(cls._chunkable, **chunkable)
+        if detachable:
+            cls._detachable = cls._detachable.union(detachable)
+        if serialize_ignore:
+            cls._serialize_ignore = cls._serialize_ignore.union(serialize_ignore)
+        super().__init_subclass__(**kwargs)
+
+
+# T = TypeVar("T")
+
+# how i wish the code below would be correct, but we're also parsing into floats
+# and converting into strings if the original type is string, but the value isn't
+# def _validate_type(t: type, value: T) -> Tuple[bool, T]:
+
+
+def _validate_type(t: Optional[type], value: Any) -> Tuple[bool, Any]:
+    # this should be reworked. Its only ok to return null for Optionals...
+    # if t is None and value is None:
+    if value is None:
+        return True, value
+
+    # after fixing the None t above, this should be
+    # if t is Any:
+    # if t is None:
+
+    if t is None or t is Any:
+        return True, value
+
+    if isclass(t) and issubclass(t, Enum):
+        if isinstance(value, t):
+            return True, value
+        if value in t._value2member_map_:
+            return True, t(value)
+
+    if getattr(t, "__module__", None) == "typing":
+        origin = getattr(t, "__origin__")
+        # below is what in nicer for >= py38
+        # origin = get_origin(t)
+
+        # recursive validation for Unions on both types preferring the fist type
+        if origin is Union:
+            t_1, t_2 = t.__args__  # type: ignore
+            # below is what in nicer for >= py38
+            # t_1, t_2 = get_args(t)
+            t_1_success, t_1_value = _validate_type(t_1, value)
+            if t_1_success:
+                return True, t_1_value
+            return _validate_type(t_2, value)
+        if origin is dict:
+            if not isinstance(value, dict):
+                return False, value
+            if value == {}:
+                return True, value
+            if not getattr(t, "__args__", None):
+                return True, value
+            t_key, t_value = t.__args__  # type: ignore
+
+            if (
+                getattr(t_key, "__name__", None),
+                getattr(t_value, "__name__", None),
+            ) == ("KT", "VT"):
+                return True, value
+            # we're only checking the first item, but the for loop and return after
+            # evaluating the first item is the fastest way
+            for dict_key, dict_value in value.items():
+                valid_key, _ = _validate_type(t_key, dict_key)
+                valid_value, _ = _validate_type(t_value, dict_value)
+
+                if valid_key and valid_value:
+                    return True, value
+                return False, value
+
+        if origin is list:
+            if not isinstance(value, list):
+                return False, value
+            if value == []:
+                return True, value
+            if not hasattr(t, "__args__"):
+                return True, value
+            t_items = t.__args__[0]  # type: ignore
+            if getattr(t_items, "__name__", None) == "T":
+                return True, value
+            first_item_valid, _ = _validate_type(t_items, value[0])
+            if first_item_valid:
+                return True, value
+            return False, value
+
+        if origin is tuple:
+            if not isinstance(value, tuple):
+                return False, value
+            if not hasattr(t, "__args__"):
+                return True, value
+            args = t.__args__  # type: ignore
+            if args == tuple():
+                return True, value
+            # we're not checking for empty tuple, cause tuple lengths must match
+            if len(args) != len(value):
+                return False, value
+            values = []
+            for t_item, v_item in zip(args, value):
+                item_valid, item_value = _validate_type(t_item, v_item)
+                if not item_valid:
+                    return False, value
+                values.append(item_value)
+            return True, tuple(values)
+
+    if isinstance(value, t):
+        return True, value
+
+    with contextlib.suppress(ValueError):
+        if t is float and value is not None:
+            return True, float(value)
+        # TODO: dafuq, i had to add this not list check
+        # but it would also fail for objects and other complex values
+        if t is str and value and not isinstance(value, list):
+            return True, str(value)
+
+    return False, value
+
+
+class Base(_RegisteringBase):
+    id: Union[str, None] = None
+    totalChildrenCount: Union[int, None] = None
+    applicationId: Union[str, None] = None
+    _units: Union[Units, None] = None
+
+    def __init__(self, **kwargs) -> None:
+        super().__init__()
+        for k, v in kwargs.items():
+            self.__setattr__(k, v)
+
+    def __repr__(self) -> str:
+        return (
+            f"{self.__class__.__name__}(id: {self.id}, "
+            f"speckle_type: {self.speckle_type}, "
+            f"totalChildrenCount: {self.totalChildrenCount})"
+        )
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+    @classmethod
+    def of_type(cls, speckle_type: str, **kwargs) -> "Base":
+        """
+        Get a plain Base object with a specified speckle_type.
+
+        The speckle_type is protected and cannot be overwritten on a class instance.
+        This is to prevent problems with receiving in other platforms or connectors.
+        However, if you really need a base with a different type, here is a helper
+        to do that for you.
+
+        This is used in the deserialisation of unknown types so their speckle_type
+        can be preserved.
+        """
+        b = cls(**kwargs)
+        b.__dict__.update(speckle_type=speckle_type)
+        return b
+
+    def __setitem__(self, name: str, value: Any) -> None:
+        self.validate_prop_name(name)
+        self.__dict__[name] = value
+
+    def __getitem__(self, name: str) -> Any:
+        return self.__dict__[name]
+
+    def __setattr__(self, name: str, value: Any) -> None:
+        """
+        Type checking, guard attribute, and property set mechanism.
+
+        The `speckle_type` is a protected class attribute it must not be overridden.
+
+        This also performs a type check if the attribute is type hinted.
+        """
+        if name == "speckle_type":
+            # not sure if we should raise an exception here??
+            # raise SpeckleException(
+            #     "Cannot override the `speckle_type`. This is set manually by the class or on deserialisation"
+            # )
+            return
+        # if value is not None:
+        value = self._type_check(name, value)
+        attr = getattr(self.__class__, name, None)
+        if isinstance(attr, property):
+            try:
+                attr.__set__(self, value)
+            except AttributeError:
+                return  # the prop probably doesn't have a setter
+        super().__setattr__(name, value)
+
+    @classmethod
+    def update_forward_refs(cls) -> None:
+        """
+        Attempts to populate the internal defined types dict for type checking
+        sometime after defining the class.
+        This is already done when defining the class, but can be called
+        again if references to undefined types were
+        included.
+
+        See `objects.geometry` for an example of how this is used with
+        the Brep class definitions.
+        """
+        try:
+            cls._attr_types = get_type_hints(cls)
+        except Exception as e:
+            warn(f"Could not update forward refs for class {cls.__name__}: {e}")
+
+    @classmethod
+    def validate_prop_name(cls, name: str) -> None:
+        """Validator for dynamic attribute names."""
+        if name in {"", "@"}:
+            raise ValueError("Invalid Name: Base member names cannot be empty strings")
+        if name.startswith("@@"):
+            raise ValueError(
+                "Invalid Name: Base member names cannot start with more than one '@'",
+            )
+        if "." in name or "/" in name:
+            raise ValueError(
+                "Invalid Name: Base member names cannot contain characters '.' or '/'",
+            )
+
+    def _type_check(self, name: str, value: Any) -> Any:
+        """
+        Lightweight type checking of values before setting them
+
+        NOTE: Does not check subscripted types within generics as the performance hit
+        of checking each item within a given collection isn't worth it.
+        Eg if you have a type Dict[str, float],
+        we will only check if the value you're trying to set is a dict.
+        """
+        types = getattr(self, "_attr_types", {})
+        t = types.get(name, None)
+
+        valid, checked_value = _validate_type(t, value)
+
+        if valid:
+            return checked_value
+
+        raise SpeckleException(
+            f"Cannot set '{self.__class__.__name__}.{name}':"
+            f"it expects type '{str(t)}',"
+            f"but received type '{type(value).__name__}'"
+        )
+
+    def add_chunkable_attrs(self, **kwargs: int) -> None:
+        """
+        Mark defined attributes as chunkable for serialisation
+
+        Arguments:
+            kwargs {int} -- the name of the attribute as the keyword
+            and the chunk size as the arg
+        """
+        chunkable = {k: v for k, v in kwargs.items() if isinstance(v, int)}
+        self._chunkable = dict(self._chunkable, **chunkable)
+
+    def add_detachable_attrs(self, names: Set[str]) -> None:
+        """
+        Mark defined attributes as detachable for serialisation
+
+        Arguments:
+            names {Set[str]} -- the names of the attributes to detach as a set of string
+        """
+        self._detachable = self._detachable.union(names)
+
+    @property
+    def units(self) -> Union[str, None]:
+        if self._units:
+            return self._units.value
+        return None
+
+    @units.setter
+    def units(self, value: Union[str, Units, None]):
+        if value is None:
+            units = value
+        elif isinstance(value, Units):
+            units: Units = value
+        else:
+            units = get_units_from_string(value)
+        self._units = units
+        # except SpeckleInvalidUnitException as ex:
+        #     warn(f"Units are reset to None. Reason {ex.message}")
+        #     self._units = None
+
+    def get_member_names(self) -> List[str]:
+        """Get all of the property names on this object, dynamic or not"""
+        attr_dir = list(set(dir(self)) - REMOVE_FROM_DIR)
+        return [
+            name
+            for name in attr_dir
+            if not name.startswith("_") and not callable(getattr(self, name))
+        ]
+
+    def get_serializable_attributes(self) -> List[str]:
+        """Get the attributes that should be serialized"""
+        return sorted(list(set(self.get_member_names()) - self._serialize_ignore))
+
+    def get_typed_member_names(self) -> List[str]:
+        """Get all of the names of the defined (typed) properties of this object"""
+        return list(self._attr_types.keys())
+
+    def get_dynamic_member_names(self) -> List[str]:
+        """Get all of the names of the dynamic properties of this object"""
+        return list(set(self.__dict__.keys()) - set(self._attr_types.keys()))
+
+    def get_children_count(self) -> int:
+        """Get the total count of children Base objects"""
+        parsed = []
+        return 1 + self._count_descendants(self, parsed)
+
+    def get_id(self, decompose: bool = False) -> str:
+        """
+        Gets the id (a unique hash) of this object.
+        ⚠️ This method fully serializes the object which,
+        in the case of large objects (with many sub-objects), has a tangible cost.
+        Avoid using it!
+
+        Note: the hash of a decomposed object differs from that of a
+        non-decomposed object
+
+        Arguments:
+            decompose {bool} -- if True, will decompose the object in
+            the process of hashing it
+
+        Returns:
+            str -- the hash (id) of the fully serialized object
+        """
+        from specklepy.serialization.base_object_serializer import BaseObjectSerializer
+
+        serializer = BaseObjectSerializer()
+        if decompose:
+            serializer.write_transports = [MemoryTransport()]
+        return serializer.traverse_base(self)[0]
+
+    def _count_descendants(self, base: "Base", parsed: List) -> int:
+        if base in parsed:
+            return 0
+        parsed.append(base)
+
+        return sum(
+            self._handle_object_count(value, parsed)
+            for name, value in base.get_member_names()
+            if not name.startswith("@")
+        )
+
+    def _handle_object_count(self, obj: Any, parsed: List) -> int:
+        # pylint: disable=isinstance-second-argument-not-valid-type
+        count = 0
+        if obj is None:
+            return count
+        if isinstance(obj, "Base"):
+            count += 1
+            count += self._count_descendants(obj, parsed)
+            return count
+        elif isinstance(obj, list):
+            for item in obj:
+                if isinstance(item, "Base"):
+                    count += 1
+                    count += self._count_descendants(item, parsed)
+                else:
+                    count += self._handle_object_count(item, parsed)
+        elif isinstance(obj, dict):
+            for _, value in obj.items():
+                if isinstance(value, "Base"):
+                    count += 1
+                    count += self._count_descendants(value, parsed)
+                else:
+                    count += self._handle_object_count(value, parsed)
+        return count
+
+
+Base.update_forward_refs()
+
+
+class DataChunk(Base, speckle_type="Speckle.Core.Models.DataChunk"):
+    data: Union[List[Any], None] = None
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.data = []

src/specklepy/objects/encoding.py

@@ -0,0 +1,131 @@
+from enum import Enum
+from typing import Any, Callable, Dict, List, Optional, Type
+
+from specklepy.logging.exceptions import SpeckleException
+from specklepy.objects.base import Base
+
+
+class CurveTypeEncoding(int, Enum):
+    Arc = 0
+    Circle = 1
+    Curve = 2
+    Ellipse = 3
+    Line = 4
+    Polyline = 5
+    Polycurve = 6
+
+    @property
+    def object_class(self) -> Type:
+        from . import geometry
+
+        if self == self.Arc:
+            return geometry.Arc
+        elif self == self.Circle:
+            return geometry.Circle
+        elif self == self.Curve:
+            return geometry.Curve
+        elif self == self.Ellipse:
+            return geometry.Ellipse
+        elif self == self.Line:
+            return geometry.Line
+        elif self == self.Polyline:
+            return geometry.Polyline
+        elif self == self.Polycurve:
+            return geometry.Polycurve
+        raise SpeckleException(
+            f"No corresponding object class for CurveTypeEncoding: {self}"
+        )
+
+
+def curve_from_list(args: List[float]):
+    curve_type = CurveTypeEncoding(args[0])
+    return curve_type.object_class.from_list(args)
+
+
+class ObjectArray:
+    def __init__(self, data: Optional[list] = None) -> None:
+        self.data = data or []
+
+    @classmethod
+    def from_objects(cls, objects: List[Base]) -> "ObjectArray":
+        data_list = cls()
+        if not objects:
+            return data_list
+
+        speckle_type = objects[0].speckle_type
+
+        for obj in objects:
+            if speckle_type != obj.speckle_type:
+                raise SpeckleException(
+                    "All objects in chunk should have the same speckle_type. "
+                    f"Found {speckle_type} and {obj.speckle_type}"
+                )
+            data_list.encode_object(obj=obj)
+
+        return data_list
+
+    @staticmethod
+    def decode_data(
+        data: List[Any], decoder: Callable[[List[Any]], Base], **kwargs: Dict[str, Any]
+    ) -> List[Base]:
+        bases: List[Base] = []
+        if not data:
+            return bases
+        index = 0
+        while index < len(data):
+            item_length = int(data[index])
+            item_start = index + 1
+            item_end = item_start + item_length
+            item_data = data[item_start:item_end]
+            index = item_end
+            decoded_data = decoder(item_data, **kwargs)
+            bases.append(decoded_data)
+
+        return bases
+
+    def decode(self, decoder: Callable[[List[Any]], Any], **kwargs: Dict[str, Any]):
+        return self.decode_data(data=self.data, decoder=decoder, **kwargs)
+
+    def encode_object(self, obj: Base):
+        encoded = obj.to_list()
+        encoded.insert(0, len(encoded))
+        self.data.extend(encoded)
+
+
+class CurveArray(ObjectArray):
+    @classmethod
+    def from_curve(cls, curve: Base) -> "CurveArray":
+        crv_array = cls()
+        crv_array.data = curve.to_list()
+        return crv_array
+
+    @classmethod
+    def from_curves(cls, curves: List[Base]) -> "CurveArray":
+        data = []
+        for curve in curves:
+            curve_list = curve.to_list()
+            curve_list.insert(0, len(curve_list))
+            data.extend(curve_list)
+        crv_array = cls()
+        crv_array.data = data
+        return crv_array
+
+    @staticmethod
+    def curve_from_list(args: List[float]) -> Base:
+        curve_type = CurveTypeEncoding(args[0])
+        return curve_type.object_class.from_list(args)
+
+    @property
+    def type(self) -> CurveTypeEncoding:
+        return CurveTypeEncoding(self.data[0])
+
+    def to_curve(self) -> Base:
+        return self.type.object_class.from_list(self.data)
+
+    @classmethod
+    def _curve_decoder(cls, data: List[float]) -> Base:
+        crv_array = cls(data)
+        return crv_array.to_curve()
+
+    def to_curves(self) -> List[Base]:
+        return self.decode(decoder=self._curve_decoder)

src/specklepy/objects/fakemesh.py

@@ -0,0 +1,53 @@
+from enum import Enum
+from typing import List, Optional
+
+from specklepy.objects.geometry import Point
+
+from .base import Base
+
+CHUNKABLE_PROPS = {
+    "vertices": 100,
+    "faces": 100,
+    "colors": 100,
+    "textureCoordinates": 100,
+    "test_bases": 10,
+}
+
+DETACHABLE = {"detach_this", "origin", "detached_list"}
+
+
+class FakeGeo(Base, chunkable={"dots": 50}, detachable={"pointslist"}):
+    pointslist: Optional[List[Base]] = None
+    dots: Optional[List[int]] = None
+
+
+class FakeDirection(Enum):
+    NORTH = 1
+    EAST = 2
+    SOUTH = 3
+    WEST = 4
+
+
+class FakeMesh(FakeGeo, chunkable=CHUNKABLE_PROPS, detachable=DETACHABLE):
+    vertices: Optional[List[float]] = None
+    faces: Optional[List[int]] = None
+    colors: Optional[List[int]] = None
+    textureCoordinates: Optional[List[float]] = None
+    cardinal_dir: Optional[FakeDirection] = None
+    test_bases: Optional[List[Base]] = None
+    detach_this: Optional[Base] = None
+    detached_list: Optional[List[Base]] = None
+    _origin: Optional[Point] = None
+
+    # def __init__(self, **kwargs) -> None:
+    #     super(FakeMesh, self).__init__(**kwargs)
+    #     self.add_chunkable_attrs(**CHUNKABLE_PROPS)
+    #     self.add_detachable_attrs(DETACHABLE)
+
+    @property
+    def origin(self):
+        return self._origin
+
+    @origin.setter
+    def origin(self, value: Point):
+        self._origin = value

src/specklepy/objects/geometry.py

@@ -0,0 +1,942 @@
+from enum import Enum
+from typing import Any, List, Optional
+
+from specklepy.objects.base import Base
+from specklepy.objects.encoding import CurveArray, CurveTypeEncoding, ObjectArray
+from specklepy.objects.primitive import Interval
+from specklepy.objects.units import get_encoding_from_units, get_units_from_encoding
+
+GEOMETRY = "Objects.Geometry."
+
+
+class Point(Base, speckle_type=GEOMETRY + "Point"):
+    x: float = 0.0
+    y: float = 0.0
+    z: float = 0.0
+
+    def __repr__(self) -> str:
+        return (
+            f"{self.__class__.__name__}(x: {self.x}, y: {self.y}, z: {self.z}, id:"
+            f" {self.id}, speckle_type: {self.speckle_type})"
+        )
+
+    @classmethod
+    def from_list(cls, args: List[float]) -> "Point":
+        """
+        Create a new Point from a list of three floats
+        representing the x, y, and z coordinates
+        """
+        return cls(x=args[0], y=args[1], z=args[2])
+
+    def to_list(self) -> List[Any]:
+        return [self.x, self.y, self.z]
+
+    @classmethod
+    def from_coords(cls, x: float = 0.0, y: float = 0.0, z: float = 0.0):
+        """Create a new Point from x, y, and z values"""
+        pt = Point()
+        pt.x, pt.y, pt.z = x, y, z
+        return pt
+
+
+class Pointcloud(Base, speckle_type=GEOMETRY + "Pointcloud"):
+    points: Optional[List[float]] = None
+    colors: Optional[List[int]] = None
+    sizes: Optional[List[float]] = None
+    bbox: Optional["Box"] = None
+
+
+class Vector(Base, speckle_type=GEOMETRY + "Vector"):
+    x: float = 0.0
+    y: float = 0.0
+    z: float = 0.0
+    applicationId: Optional[str] = None
+
+    def __repr__(self) -> str:
+        return (
+            f"{self.__class__.__name__} "
+            "(x: {self.x}, y: {self.y}, z: {self.z}, id: {self.id}, "
+            "speckle_type: {self.speckle_type})"
+        )
+
+    @classmethod
+    def from_list(cls, args: List[float]) -> "Vector":
+        """
+        Create from a list of three floats representing the x, y, and z coordinates.
+        """
+        return cls(x=args[0], y=args[1], z=args[2])
+
+    def to_list(self) -> List[float]:
+        return [self.x, self.y, self.z]
+
+    @classmethod
+    def from_coords(cls, x: float = 0.0, y: float = 0.0, z: float = 0.0) -> "Vector":
+        """Create a new Point from x, y, and z values"""
+        v = Vector()
+        v.x, v.y, v.z = x, y, z
+        return v
+
+
+class ControlPoint(Point, speckle_type=GEOMETRY + "ControlPoint"):
+    weight: Optional[float] = None
+
+
+class Plane(Base, speckle_type=GEOMETRY + "Plane"):
+    origin: Point = Point()
+    normal: Vector = Vector()
+    xdir: Vector = Vector()
+    ydir: Vector = Vector()
+
+    @classmethod
+    def from_list(cls, args: List[Any]) -> "Plane":
+        return cls(
+            origin=Point.from_list(args[:3]),
+            normal=Vector.from_list(args[3:6]),
+            xdir=Vector.from_list(args[6:9]),
+            ydir=Vector.from_list(args[9:12]),
+            units=get_units_from_encoding(args[-1]),
+        )
+
+    def to_list(self) -> List[Any]:
+        return [
+            *self.origin.to_list(),
+            *self.normal.to_list(),
+            *self.xdir.to_list(),
+            *self.ydir.to_list(),
+            get_encoding_from_units(self._units),
+        ]
+
+
+class Box(Base, speckle_type=GEOMETRY + "Box"):
+    basePlane: Plane = Plane()
+    xSize: Interval = Interval()
+    ySize: Interval = Interval()
+    zSize: Interval = Interval()
+    area: Optional[float] = None
+    volume: Optional[float] = None
+
+
+class Line(Base, speckle_type=GEOMETRY + "Line"):
+    start: Point = Point()
+    end: Optional[Point] = None
+    domain: Optional[Interval] = None
+    bbox: Optional[Box] = None
+    length: Optional[float] = None
+
+    @classmethod
+    def from_list(cls, args: List[Any]) -> "Line":
+        return cls(
+            start=Point.from_list(args[1:4]),
+            end=Point.from_list(args[4:7]),
+            domain=Interval.from_list(args[7:10]),
+            units=get_units_from_encoding(args[-1]),
+        )
+
+    def to_list(self) -> List[Any]:
+        domain = self.domain.to_list() if self.domain else [0, 1]
+        return [
+            CurveTypeEncoding.Line.value,
+            *self.start.to_list(),
+            *self.end.to_list(),
+            *domain,
+            get_encoding_from_units(self._units),
+        ]
+
+
+class Arc(Base, speckle_type=GEOMETRY + "Arc"):
+    radius: Optional[float] = None
+    startAngle: Optional[float] = None
+    endAngle: Optional[float] = None
+    angleRadians: Optional[float] = None
+    plane: Optional[Plane] = None
+    domain: Optional[Interval] = None
+    startPoint: Optional[Point] = None
+    midPoint: Optional[Point] = None
+    endPoint: Optional[Point] = None
+    bbox: Optional[Box] = None
+    area: Optional[float] = None
+    length: Optional[float] = None
+
+    @classmethod
+    def from_list(cls, args: List[Any]) -> "Arc":
+        return cls(
+            radius=args[1],
+            startAngle=args[2],
+            endAngle=args[3],
+            angleRadians=args[4],
+            domain=Interval.from_list(args[5:7]),
+            plane=Plane.from_list(args[7:20]),
+            startPoint=Point.from_list(args[20:23]),
+            midPoint=Point.from_list(args[23:26]),
+            endPoint=Point.from_list(args[26:29]),
+            units=get_units_from_encoding(args[-1]),
+        )
+
+    def to_list(self) -> List[Any]:
+        return [
+            CurveTypeEncoding.Arc.value,
+            self.radius,
+            self.startAngle,
+            self.endAngle,
+            self.angleRadians,
+            *self.domain.to_list(),
+            *self.plane.to_list(),
+            *self.startPoint.to_list(),
+            *self.midPoint.to_list(),
+            *self.endPoint.to_list(),
+            get_encoding_from_units(self._units),
+        ]
+
+
+class Circle(Base, speckle_type=GEOMETRY + "Circle"):
+    radius: Optional[float] = None
+    plane: Optional[Plane] = None
+    domain: Optional[Interval] = None
+    bbox: Optional[Box] = None
+    area: Optional[float] = None
+    length: Optional[float] = None
+
+    @classmethod
+    def from_list(cls, args: List[Any]) -> "Circle":
+        return cls(
+            radius=args[1],
+            domain=Interval.from_list(args[2:4]),
+            plane=Plane.from_list(args[4:17]),
+            units=get_units_from_encoding(args[-1]),
+        )
+
+    def to_list(self) -> List[Any]:
+        return [
+            CurveTypeEncoding.Circle.value,
+            self.radius,
+            *self.domain.to_list(),
+            *self.plane.to_list(),
+            get_encoding_from_units(self._units),
+        ]
+
+
+class Ellipse(Base, speckle_type=GEOMETRY + "Ellipse"):
+    firstRadius: Optional[float] = None
+    secondRadius: Optional[float] = None
+    plane: Optional[Plane] = None
+    domain: Optional[Interval] = None
+    trimDomain: Optional[Interval] = None
+    bbox: Optional[Box] = None
+    area: Optional[float] = None
+    length: Optional[float] = None
+
+    @classmethod
+    def from_list(cls, args: List[Any]) -> "Ellipse":
+        return cls(
+            firstRadius=args[1],
+            secondRadius=args[2],
+            domain=Interval.from_list(args[3:5]),
+            plane=Plane.from_list(args[5:18]),
+            units=get_units_from_encoding(args[-1]),
+        )
+
+    def to_list(self) -> List[Any]:
+        return [
+            CurveTypeEncoding.Ellipse.value,
+            self.firstRadius,
+            self.secondRadius,
+            *self.domain.to_list(),
+            *self.plane.to_list(),
+            get_encoding_from_units(self._units),
+        ]
+
+
+class Polyline(Base, speckle_type=GEOMETRY + "Polyline", chunkable={"value": 20000}):
+    value: Optional[List[float]] = None
+    closed: Optional[bool] = None
+    domain: Optional[Interval] = None
+    bbox: Optional[Box] = None
+    area: Optional[float] = None
+    length: Optional[float] = None
+
+    @classmethod
+    def from_points(cls, points: List[Point]):
+        """Create a new Polyline from a list of Points"""
+        polyline = cls()
+        polyline.units = points[0].units
+        polyline.value = []
+        for point in points:
+            polyline.value.extend([point.x, point.y, point.z])
+        return polyline
+
+    @classmethod
+    def from_list(cls, args: List[Any]) -> "Polyline":
+        point_count = args[4]
+        return cls(
+            closed=bool(args[1]),
+            domain=Interval.from_list(args[2:4]),
+            value=args[5 : 5 + point_count],
+            units=get_units_from_encoding(args[-1]),
+        )
+
+    def to_list(self) -> List[Any]:
+        return [
+            CurveTypeEncoding.Polyline.value,
+            int(self.closed),
+            *self.domain.to_list(),
+            len(self.value),
+            *self.value,
+            get_encoding_from_units(self._units),
+        ]
+
+    def as_points(self) -> List[Point]:
+        """Converts the `value` attribute to a list of Points"""
+        if not self.value:
+            return
+
+        if len(self.value) % 3:
+            raise ValueError("Points array malformed: length%3 != 0.")
+
+        values = iter(self.value)
+        return [
+            Point(x=v, y=next(values), z=next(values), units=self.units) for v in values
+        ]
+
+
+class SpiralType(Enum):
+    Biquadratic = (0,)
+    BiquadraticParabola = (1,)
+    Bloss = (2,)
+    Clothoid = (3,)
+    Cosine = (4,)
+    Cubic = (5,)
+    CubicParabola = (6,)
+    Radioid = (7,)
+    Sinusoid = (8,)
+    Unknown = 9
+
+
+class Spiral(Base, speckle_type=GEOMETRY + "Spiral", detachable={"displayValue"}):
+    startPoint: Optional[Point] = None
+    endPoint: Optional[Point]
+    plane: Optional[Plane]
+    turns: Optional[int]
+    pitchAxis: Optional[Vector] = Vector()
+    pitch: float = 0
+    spiralType: Optional[SpiralType] = None
+    displayValue: Optional[Polyline] = None
+    bbox: Optional[Box] = None
+    length: Optional[float] = None
+    domain: Optional[Interval] = None
+
+
+class Curve(
+    Base,
+    speckle_type=GEOMETRY + "Curve",
+    chunkable={"points": 20000, "weights": 20000, "knots": 20000},
+):
+    degree: Optional[int] = None
+    periodic: Optional[bool] = None
+    rational: Optional[bool] = None
+    points: Optional[List[float]] = None
+    weights: Optional[List[float]] = None
+    knots: Optional[List[float]] = None
+    domain: Optional[Interval] = None
+    displayValue: Optional[Polyline] = None
+    closed: Optional[bool] = None
+    bbox: Optional[Box] = None
+    area: Optional[float] = None
+    length: Optional[float] = None
+
+    def as_points(self) -> List[Point]:
+        """Converts the `value` attribute to a list of Points"""
+        if not self.points:
+            return
+
+        if len(self.points) % 3:
+            raise ValueError("Points array malformed: length%3 != 0.")
+
+        values = iter(self.points)
+        return [
+            Point(x=v, y=next(values), z=next(values), units=self.units) for v in values
+        ]
+
+    @classmethod
+    def from_list(cls, args: List[Any]) -> "Curve":
+        point_count = int(args[7])
+        weights_count = int(args[8])
+        knots_count = int(args[9])
+
+        points_start = 10
+        weights_start = 10 + point_count
+        knots_start = weights_start + weights_count
+        knots_end = knots_start + knots_count
+
+        return cls(
+            degree=int(args[1]),
+            periodic=bool(args[2]),
+            rational=bool(args[3]),
+            closed=bool(args[4]),
+            domain=Interval.from_list(args[5:7]),
+            points=args[points_start:weights_start],
+            weights=args[weights_start:knots_start],
+            knots=args[knots_start:knots_end],
+            units=get_units_from_encoding(args[-1]),
+        )
+
+    def to_list(self) -> List[Any]:
+        return [
+            CurveTypeEncoding.Curve.value,
+            self.degree,
+            int(self.periodic),
+            int(self.rational),
+            int(self.closed),
+            *self.domain.to_list(),
+            len(self.points),
+            len(self.weights),
+            len(self.knots),
+            *self.points,
+            *self.weights,
+            *self.knots,
+            get_encoding_from_units(self._units),
+        ]
+
+
+class Polycurve(Base, speckle_type=GEOMETRY + "Polycurve"):
+    segments: Optional[List[Base]] = None
+    domain: Optional[Interval] = None
+    closed: Optional[bool] = None
+    bbox: Optional[Box] = None
+    area: Optional[float] = None
+    length: Optional[float] = None
+
+    @classmethod
+    def from_list(cls, args: List[Any]) -> "Polycurve":
+        curve_arrays = CurveArray(args[5:-1])
+        return cls(
+            closed=bool(args[1]),
+            domain=Interval.from_list(args[2:4]),
+            segments=curve_arrays.to_curves(),
+            units=get_units_from_encoding(args[-1]),
+        )
+
+    def to_list(self) -> List[Any]:
+        curve_array = CurveArray.from_curves(self.segments).data
+        return [
+            CurveTypeEncoding.Polycurve.value,
+            int(self.closed),
+            *self.domain.to_list(),
+            len(curve_array),
+            *curve_array,
+            get_encoding_from_units(self._units),
+        ]
+
+
+class Extrusion(Base, speckle_type=GEOMETRY + "Extrusion"):
+    capped: Optional[bool] = None
+    profile: Optional[Base] = None
+    pathStart: Optional[Point] = None
+    pathEnd: Optional[Point] = None
+    pathCurve: Optional[Base] = None
+    pathTangent: Optional[Base] = None
+    profiles: Optional[List[Base]] = None
+    length: Optional[float] = None
+    area: Optional[float] = None
+    volume: Optional[float] = None
+    bbox: Optional[Box] = None
+
+
+class Mesh(
+    Base,
+    speckle_type=GEOMETRY + "Mesh",
+    chunkable={
+        "vertices": 2000,
+        "faces": 2000,
+        "colors": 2000,
+        "textureCoordinates": 2000,
+    },
+):
+    vertices: Optional[List[float]] = None
+    faces: Optional[List[int]] = None
+    colors: Optional[List[int]] = None
+    textureCoordinates: Optional[List[float]] = None
+    bbox: Optional[Box] = None
+    area: Optional[float] = None
+    volume: Optional[float] = None
+
+    @classmethod
+    def create(
+        cls,
+        vertices: List[float],
+        faces: List[int],
+        colors: Optional[List[int]] = None,
+        texture_coordinates: Optional[List[float]] = None,
+    ) -> "Mesh":
+        """
+        Create a new Mesh from lists representing its vertices, faces,
+        colors (optional), and texture coordinates (optional).
+
+        This will initialise empty lists for colors and texture coordinates
+        if you do not provide any.
+        """
+        return cls(
+            vertices=vertices,
+            faces=faces,
+            colors=colors or [],
+            textureCoordinates=texture_coordinates or [],
+        )
+
+
+class Surface(Base, speckle_type=GEOMETRY + "Surface"):
+    degreeU: Optional[int] = None
+    degreeV: Optional[int] = None
+    rational: Optional[bool] = None
+    area: Optional[float] = None
+    pointData: Optional[List[float]] = None
+    countU: Optional[int] = None
+    countV: Optional[int] = None
+    bbox: Optional[Box] = None
+    closedU: Optional[bool] = None
+    closedV: Optional[bool] = None
+    domainU: Optional[Interval] = None
+    domainV: Optional[Interval] = None
+    knotsU: Optional[List[float]] = None
+    knotsV: Optional[List[float]] = None
+
+    @classmethod
+    def from_list(cls, args: List[Any]) -> "Surface":
+        point_count = int(args[11])
+        knots_u_count = int(args[12])
+        knots_v_count = int(args[13])
+
+        start_point_data = 14
+        start_knots_u = start_point_data + point_count
+        start_knots_v = start_knots_u + knots_u_count
+
+        return cls(
+            degreeU=int(args[0]),
+            degreeV=int(args[1]),
+            countU=int(args[2]),
+            countV=int(args[3]),
+            rational=bool(args[4]),
+            closedU=bool(args[5]),
+            closedV=bool(args[6]),
+            domainU=Interval(start=args[7], end=args[8]),
+            domainV=Interval(start=args[9], end=args[10]),
+            pointData=args[start_point_data:start_knots_u],
+            knotsU=args[start_knots_u:start_knots_v],
+            knotsV=args[start_knots_v : start_knots_v + knots_v_count],
+            units=get_units_from_encoding(args[-1]),
+        )
+
+    def to_list(self) -> List[Any]:
+        return [
+            self.degreeU,
+            self.degreeV,
+            self.countU,
+            self.countV,
+            int(self.rational),
+            int(self.closedU),
+            int(self.closedV),
+            *self.domainU.to_list(),
+            *self.domainV.to_list(),
+            len(self.pointData),
+            len(self.knotsU),
+            len(self.knotsV),
+            *self.pointData,
+            *self.knotsU,
+            *self.knotsV,
+            get_encoding_from_units(self._units),
+        ]
+
+
+class BrepFace(Base, speckle_type=GEOMETRY + "BrepFace"):
+    _Brep: Optional["Brep"] = None
+    SurfaceIndex: Optional[int] = None
+    OuterLoopIndex: Optional[int] = None
+    OrientationReversed: Optional[bool] = None
+    LoopIndices: Optional[List[int]] = None
+
+    @property
+    def _outer_loop(self):
+        return self._Brep.Loops[self.OuterLoopIndex]  # pylint: disable=no-member
+
+    @property
+    def _surface(self):
+        return self._Brep.Surfaces[self.SurfaceIndex]  # pylint: disable=no-member
+
+    @property
+    def _loops(self):
+        if self.LoopIndices:
+            # pylint: disable=not-an-iterable, no-member
+            return [self._Brep.Loops[i] for i in self.LoopIndices]
+
+    @classmethod
+    def from_list(cls, args: List[Any], brep: "Brep" = None) -> "BrepFace":
+        return cls(
+            _Brep=brep,
+            SurfaceIndex=args[0],
+            OuterLoopIndex=args[1],
+            OrientationReversed=bool(args[2]),
+            LoopIndices=args[3:],
+        )
+
+    def to_list(self) -> List[Any]:
+        return [
+            self.SurfaceIndex,
+            self.OuterLoopIndex,
+            int(self.OrientationReversed),
+            *self.LoopIndices,
+        ]
+
+
+class BrepEdge(Base, speckle_type=GEOMETRY + "BrepEdge"):
+    _Brep: Optional["Brep"] = None
+    Curve3dIndex: Optional[int] = None
+    TrimIndices: Optional[List[int]] = None
+    StartIndex: Optional[int] = None
+    EndIndex: Optional[int] = None
+    ProxyCurveIsReversed: Optional[bool] = None
+    Domain: Optional[Interval] = None
+
+    @property
+    def _start_vertex(self):
+        return self._Brep.Vertices[self.StartIndex]
+
+    @property
+    def _end_vertex(self):
+        return self._Brep.Vertices[self.EndIndex]
+
+    @property
+    def _trims(self):
+        if self.TrimIndices:
+            # pylint: disable=not-an-iterable
+            return [self._Brep.Trims[i] for i in self.TrimIndices]
+
+    @property
+    def _curve(self):
+        return self._Brep.Curve3D[self.Curve3dIndex]
+
+    @classmethod
+    def from_list(cls, args: List[Any], brep: "Brep" = None) -> "BrepEdge":
+        domain_start = args[4]
+        domain_end = args[5]
+        domain = (
+            Interval(start=domain_start, end=domain_end)
+            if None not in (domain_start, domain_end)
+            else None
+        )
+        return cls(
+            _Brep=brep,
+            Curve3dIndex=int(args[0]),
+            TrimIndices=[int(t) for t in args[6:]],
+            StartIndex=int(args[1]),
+            EndIndex=int(args[2]),
+            ProxyCurveIsReversed=bool(args[3]),
+            Domain=domain,
+        )
+
+    def to_list(self) -> List[Any]:
+        return [
+            self.Curve3dIndex,
+            self.StartIndex,
+            self.EndIndex,
+            int(self.ProxyCurveIsReversed),
+            self.Domain.start,
+            self.Domain.end,
+            *self.TrimIndices,
+        ]
+
+
+class BrepLoopType(int, Enum):
+    Unknown = 0
+    Outer = 1
+    Inner = 2
+    Slit = 3
+    CurveOnSurface = 4
+    PointOnSurface = 5
+
+
+class BrepLoop(Base, speckle_type=GEOMETRY + "BrepLoop"):
+    _Brep: Optional["Brep"] = None
+    FaceIndex: Optional[Optional[int]] = None
+    TrimIndices: Optional[List[int]] = None
+    Type: Optional[BrepLoopType] = None
+
+    @property
+    def _face(self):
+        return self._Brep.Faces[self.FaceIndex]
+
+    @property
+    def _trims(self):
+        if self.TrimIndices:
+            # pylint: disable=not-an-iterable
+            return [self._Brep.Trims[i] for i in self.TrimIndices]
+
+    @classmethod
+    def from_list(cls, args: List[any], brep: "Brep" = None):
+        return cls(
+            _Brep=brep,
+            FaceIndex=args[0],
+            Type=BrepLoopType(args[1]),
+            TrimIndices=args[2:],
+        )
+
+    def to_list(self) -> List[int]:
+        return [
+            self.FaceIndex,
+            self.Type.value,
+            *self.TrimIndices,
+        ]
+
+
+class BrepTrimType(int, Enum):
+    Unknown = 0
+    Boundary = 1
+    Mated = 2
+    Seam = 3
+    Singular = 4
+    CurveOnSurface = 5
+    PointOnSurface = 6
+    Slit = 7
+
+
+class BrepTrim(Base, speckle_type=GEOMETRY + "BrepTrim"):
+    _Brep: Optional["Brep"] = None
+    EdgeIndex: Optional[int] = None
+    StartIndex: Optional[int] = None
+    EndIndex: Optional[int] = None
+    FaceIndex: Optional[int] = None
+    LoopIndex: Optional[int] = None
+    CurveIndex: Optional[int] = None
+    IsoStatus: Optional[int] = None
+    TrimType: Optional[BrepTrimType] = None
+    IsReversed: Optional[bool] = None
+    Domain: Optional[Interval] = None
+
+    @property
+    def _face(self):
+        if self._Brep:
+            return self._Brep.Faces[self.FaceIndex]  # pylint: disable=no-member
+
+    @property
+    def _loop(self):
+        if self._Brep:
+            return self._Brep.Loops[self.LoopIndex]  # pylint: disable=no-member
+
+    @property
+    def _edge(self):
+        if self._Brep:
+            # pylint: disable=no-member
+            return self._Brep.Edges[self.EdgeIndex] if self.EdgeIndex != -1 else None
+
+    @property
+    def _curve_2d(self):
+        if self._Brep:
+            return self._Brep.Curve2D[self.CurveIndex]  # pylint: disable=no-member
+
+    @classmethod
+    def from_list(cls, args: List[Any], brep: "Brep" = None) -> "BrepTrim":
+        return cls(
+            _Brep=brep,
+            EdgeIndex=args[0],
+            StartIndex=args[1],
+            EndIndex=args[2],
+            FaceIndex=args[3],
+            LoopIndex=args[4],
+            CurveIndex=args[5],
+            IsoStatus=args[6],
+            TrimType=BrepTrimType(args[7]),
+            IsReversed=bool(args[8]),
+        )
+
+    def to_list(self) -> List[Any]:
+        return [
+            self.EdgeIndex,
+            self.StartIndex,
+            self.EndIndex,
+            self.FaceIndex,
+            self.LoopIndex,
+            self.CurveIndex,
+            self.IsoStatus,
+            self.TrimType.value,
+            int(self.IsReversed),
+        ]
+
+
+class Brep(
+    Base,
+    speckle_type=GEOMETRY + "Brep",
+    chunkable={
+        "SurfacesValue": 31250,
+        "Curve3DValues": 31250,
+        "Curve2DValues": 31250,
+        "VerticesValue": 31250,
+        "EdgesValue": 62500,
+        "LoopsValue": 62500,
+        "FacesValue": 62500,
+        "TrimsValue": 62500,
+    },
+    detachable={"displayValue"},
+    serialize_ignore={
+        "Surfaces",
+        "Curve3D",
+        "Curve2D",
+        "Vertices",
+        "Trims",
+        "Edges",
+        "Loops",
+        "Faces",
+    },
+):
+    provenance: Optional[str] = None
+    bbox: Optional[Box] = None
+    area: Optional[float] = None
+    volume: Optional[float] = None
+    _displayValue: Optional[List[Mesh]] = None
+    Surfaces: Optional[List[Surface]] = None
+    Curve3D: Optional[List[Base]] = None
+    Curve2D: Optional[List[Base]] = None
+    Vertices: Optional[List[Point]] = None
+    Edges: Optional[List[BrepEdge]] = None
+    Loops: Optional[List[BrepLoop]] = None
+    Faces: Optional[List[BrepFace]] = None
+    Trims: Optional[List[BrepTrim]] = None
+    IsClosed: Optional[bool] = None
+    Orientation: Optional[int] = None
+
+    def _inject_self_into_children(self, children: Optional[List[Base]]) -> List[Base]:
+        if children is None:
+            return children
+
+        for child in children:
+            child._Brep = self  # pylint: disable=protected-access
+        return children
+
+    # set as prop for now for backwards compatibility
+    @property
+    def displayValue(self) -> List[Mesh]:
+        return self._displayValue
+
+    @displayValue.setter
+    def displayValue(self, value):
+        if isinstance(value, Mesh):
+            self._displayValue = [value]
+        elif isinstance(value, list):
+            self._displayValue = value
+
+    @property
+    def EdgesValue(self) -> List[BrepEdge]:
+        return None if self.Edges is None else ObjectArray.from_objects(self.Edges).data
+
+    @EdgesValue.setter
+    def EdgesValue(self, value: List[float]):
+        if not value:
+            return
+
+        self.Edges = ObjectArray.decode_data(value, BrepEdge.from_list, brep=self)
+
+    @property
+    def LoopsValue(self) -> List[BrepLoop]:
+        return None if self.Loops is None else ObjectArray.from_objects(self.Loops).data
+
+    @LoopsValue.setter
+    def LoopsValue(self, value: List[int]):
+        if not value:
+            return
+
+        self.Loops = ObjectArray.decode_data(value, BrepLoop.from_list, brep=self)
+
+    @property
+    def FacesValue(self) -> List[int]:
+        return None if self.Faces is None else ObjectArray.from_objects(self.Faces).data
+
+    @FacesValue.setter
+    def FacesValue(self, value: List[int]):
+        if not value:
+            return
+
+        self.Faces = ObjectArray.decode_data(value, BrepFace.from_list, brep=self)
+
+    @property
+    def SurfacesValue(self) -> List[float]:
+        return (
+            None
+            if self.Surfaces is None
+            else ObjectArray.from_objects(self.Surfaces).data
+        )
+
+    @SurfacesValue.setter
+    def SurfacesValue(self, value: List[float]):
+        if not value:
+            return
+
+        self.Surfaces = ObjectArray.decode_data(value, Surface.from_list)
+
+    @property
+    def Curve3DValues(self) -> List[float]:
+        return (
+            None if self.Curve3D is None else CurveArray.from_curves(self.Curve3D).data
+        )
+
+    @Curve3DValues.setter
+    def Curve3DValues(self, value: List[float]):
+        crv_array = CurveArray(value)
+        self.Curve3D = crv_array.to_curves()
+
+    @property
+    def Curve2DValues(self) -> List[Base]:
+        return (
+            None if self.Curve2D is None else CurveArray.from_curves(self.Curve2D).data
+        )
+
+    @Curve2DValues.setter
+    def Curve2DValues(self, value: List[float]):
+        crv_array = CurveArray(value)
+        self.Curve2D = crv_array.to_curves()
+
+    @property
+    def VerticesValue(self) -> List[Point]:
+        if self.Vertices is None:
+            return None
+        encoded_unit = get_encoding_from_units(self.Vertices[0]._units)
+        values = [encoded_unit]
+        for vertex in self.Vertices:
+            values.extend(vertex.to_list())
+        return values
+
+    @VerticesValue.setter
+    def VerticesValue(self, value: List[float]):
+        value = value.copy()
+        units = get_units_from_encoding(value.pop(0))
+
+        vertices = []
+
+        for i in range(0, len(value), 3):
+            vertex = Point.from_list(value[i : i + 3])
+            vertex._units = units
+            vertices.append(vertex)
+
+        self.Vertices = vertices
+
+    # TODO: can this be consistent with loops, edges, faces, curves, etc and prepend with the chunk list? needs to happen in sharp first
+    @property
+    def TrimsValue(self) -> List[float]:
+        # return None if self.Trims is None else ObjectArray.from_objects(self.Trims).data
+        if not self.Trims:
+            return
+        value = []
+        for trim in self.Trims:
+            value.extend(trim.to_list())
+        return value
+
+    @TrimsValue.setter
+    def TrimsValue(self, value: List[float]):
+        if not value:
+            return
+
+        # self.Trims = ObjectArray.decode_data(value, BrepTrim.from_list, brep=self)
+        self.Trims = [
+            BrepTrim.from_list(value[i : i + 9], self) for i in range(0, len(value), 9)
+        ]
+
+
+BrepEdge.update_forward_refs()
+BrepLoop.update_forward_refs()
+BrepTrim.update_forward_refs()
+BrepFace.update_forward_refs()

src/specklepy/objects/other.py

@@ -0,0 +1,257 @@
+from typing import Any, List, Optional
+
+from specklepy.objects.geometry import Point, Vector
+
+from .base import Base
+
+OTHER = "Objects.Other."
+
+IDENTITY_TRANSFORM = [
+    1.0,
+    0.0,
+    0.0,
+    0.0,
+    0.0,
+    1.0,
+    0.0,
+    0.0,
+    0.0,
+    0.0,
+    1.0,
+    0.0,
+    0.0,
+    0.0,
+    0.0,
+    1.0,
+]
+
+
+class Material(Base, speckle_type=OTHER + "Material"):
+    """Generic class for materials containing generic parameters."""
+
+    name: Optional[str] = None
+
+
+class RevitMaterial(Material, speckle_type="Objects.Other.Revit." + "RevitMaterial"):
+    materialCategory: Optional[str] = None
+    materialClass: Optional[str] = None
+    shininess: Optional[int] = None
+    smoothness: Optional[int] = None
+    transparency: Optional[int] = None
+    parameters: Optional[Base] = None
+
+
+class RenderMaterial(Base, speckle_type=OTHER + "RenderMaterial"):
+    name: Optional[str] = None
+    opacity: float = 1
+    metalness: float = 0
+    roughness: float = 1
+    diffuse: int = -2894893  # light gray arbg
+    emissive: int = -16777216  # black arbg
+
+
+class MaterialQuantity(Base, speckle_type=OTHER + "MaterialQuantity"):
+    material: Optional[Material] = None
+    volume: Optional[float] = None
+    area: Optional[float] = None
+
+
+class DisplayStyle(Base, speckle_type=OTHER + "DisplayStyle"):
+    """
+    Minimal display style class.
+    Developed primarily for display styles in Rhino and AutoCAD.
+    Rhino object attributes uses OpenNURBS definition for linetypes and lineweights.
+    """
+
+    name: Optional[str] = None
+    color: int = -2894893  # light gray arbg
+    linetype: Optional[str] = None
+    lineweight: float = 0
+
+
+class Transform(
+    Base,
+    speckle_type=OTHER + "Transform",
+    serialize_ignore={"translation", "scaling", "is_identity"},
+):
+    """The 4x4 transformation matrix
+
+    The 3x3 sub-matrix determines scaling.
+    The 4th column defines translation,
+    where the last value is a divisor (usually equal to 1).
+    """
+
+    _value: Optional[List[float]] = None
+
+    @property
+    def value(self) -> List[float]:
+        """The transform matrix represented as a flat list of 16 floats"""
+        return self._value
+
+    @value.setter
+    def value(self, value: List[float]) -> None:
+        try:
+            value = [float(x) for x in value]
+        except (ValueError, TypeError) as error:
+            raise ValueError(
+                "Could not create a Transform object with the requested value. Input"
+                f" must be a 16 element list of numbers. Value provided: {value}"
+            ) from error
+
+        if len(value) != 16:
+            raise ValueError(
+                "Could not create a Transform object: input list should be 16 floats"
+                f" long, but was {len(value)} long"
+            )
+
+        self._value = value
+
+    @property
+    def translation(self) -> List[float]:
+        """The final column of the matrix which defines the translation"""
+        return [self._value[i] for i in (3, 7, 11, 15)]
+
+    @property
+    def scaling(self) -> List[float]:
+        """The 3x3 scaling sub-matrix"""
+        return [self._value[i] for i in (0, 1, 2, 4, 5, 6, 8, 9, 10)]
+
+    @property
+    def is_identity(self) -> bool:
+        return self.value == IDENTITY_TRANSFORM
+
+    def apply_to_point(self, point: Point) -> Point:
+        """Transform a single speckle Point
+
+        Arguments:
+            point {Point} -- the speckle Point to transform
+
+        Returns:
+            Point -- a new transformed point
+        """
+        coords = self.apply_to_point_value([point.x, point.y, point.z])
+        return Point(x=coords[0], y=coords[1], z=coords[2], units=point.units)
+
+    def apply_to_point_value(self, point_value: List[float]) -> List[float]:
+        """Transform a list of three floats representing a point
+
+        Arguments:
+            point_value {List[float]} -- a list of 3 floats
+
+        Returns:
+            List[float] -- the list with the transform applied
+        """
+        transformed = [
+            point_value[0] * self._value[i]
+            + point_value[1] * self._value[i + 1]
+            + point_value[2] * self._value[i + 2]
+            + self._value[i + 3]
+            for i in range(0, 15, 4)
+        ]
+
+        return [transformed[i] / transformed[3] for i in range(3)]
+
+    def apply_to_points(self, points: List[Point]) -> List[Point]:
+        """Transform a list of speckle Points
+
+        Arguments:
+            points {List[Point]} -- the list of speckle Points to transform
+
+        Returns:
+            List[Point] -- a new list of transformed points
+        """
+        return [self.apply_to_point(point) for point in points]
+
+    def apply_to_points_values(self, points_value: List[float]) -> List[float]:
+        """Transform a list of speckle Points
+
+        Arguments:
+            points {List[float]}
+            -- a flat list of floats representing points to transform
+
+        Returns:
+            List[float] -- a new transformed list
+        """
+        if len(points_value) % 3 != 0:
+            raise ValueError(
+                "Cannot apply transform as the points list is malformed: expected"
+                " length to be multiple of 3"
+            )
+        transformed = []
+        for i in range(0, len(points_value), 3):
+            transformed.extend(self.apply_to_point_value(points_value[i : i + 3]))
+
+        return transformed
+
+    def apply_to_vector(self, vector: Vector) -> Vector:
+        """Transform a single speckle Vector
+
+        Arguments:
+            point {Vector} -- the speckle Vector to transform
+
+        Returns:
+            Vector -- a new transformed point
+        """
+        coords = self.apply_to_vector_value([vector.x, vector.y, vector.z])
+        return Vector(x=coords[0], y=coords[1], z=coords[2], units=vector.units)
+
+    def apply_to_vector_value(self, vector_value: List[float]) -> List[float]:
+        """Transform a list of three floats representing a vector
+
+        Arguments:
+            vector_value {List[float]} -- a list of 3 floats
+
+        Returns:
+            List[float] -- the list with the transform applied
+        """
+        return [
+            vector_value[0] * self._value[i]
+            + vector_value[1] * self._value[i + 1]
+            + vector_value[2] * self._value[i + 2]
+            for i in range(0, 15, 4)
+        ][:3]
+
+    @classmethod
+    def from_list(cls, value: Optional[List[float]] = None) -> "Transform":
+        """Returns a Transform object from a list of 16 numbers.
+        If no value is provided, an identity transform will be returned.
+
+        Arguments:
+            value {List[float]} -- the matrix as a flat list of 16 numbers
+            (defaults to the identity transform)
+
+        Returns:
+            Transform -- a complete transform object
+        """
+        if not value:
+            value = IDENTITY_TRANSFORM
+        return cls(value=value)
+
+
+class BlockDefinition(
+    Base, speckle_type=OTHER + "BlockDefinition", detachable={"geometry"}
+):
+    name: Optional[str] = None
+    basePoint: Optional[Point] = None
+    geometry: Optional[List[Base]] = None
+
+
+class BlockInstance(
+    Base, speckle_type=OTHER + "BlockInstance", detachable={"blockDefinition"}
+):
+    blockDefinition: Optional[BlockDefinition] = None
+    transform: Optional[Transform] = None
+
+
+# TODO: prob move this into a built elements module, but just trialling this for now
+class RevitParameter(Base, speckle_type="Objects.BuiltElements.Revit.Parameter"):
+    name: Optional[str] = None
+    value: Any = None
+    applicationUnitType: Optional[str] = None  # eg UnitType UT_Length
+    applicationUnit: Optional[str] = None  # DisplayUnitType eg DUT_MILLIMITERS
+    applicationInternalName: Optional[
+        str
+    ] = None  # BuiltInParameterName or GUID for shared parameter
+    isShared: bool = False
+    isReadOnly: bool = False
+    isTypeParameter: bool = False

src/specklepy/objects/primitive.py

@@ -0,0 +1,25 @@
+from typing import Any, List
+
+from specklepy.objects.base import Base
+
+NAMESPACE = "Objects.Primitive"
+
+
+class Interval(Base, speckle_type=f"{NAMESPACE}.Interval"):
+    start: float = 0.0
+    end: float = 0.0
+
+    def length(self):
+        return abs(self.start - self.end)
+
+    @classmethod
+    def from_list(cls, args: List[Any]) -> "Interval":
+        return cls(start=args[0], end=args[1])
+
+    def to_list(self) -> List[Any]:
+        return [self.start, self.end]
+
+
+class Interval2d(Base, speckle_type=f"{NAMESPACE}.Interval2d"):
+    u: Interval
+    v: Interval

src/specklepy/objects/structural/__init__.py

@@ -0,0 +1,141 @@
+"""Builtin Speckle object kit."""
+
+from specklepy.objects.structural.analysis import (
+    Model,
+    ModelInfo,
+    ModelSettings,
+    ModelUnits,
+)
+from specklepy.objects.structural.axis import Axis
+from specklepy.objects.structural.geometry import (
+    Element1D,
+    Element2D,
+    Element3D,
+    ElementType1D,
+    ElementType2D,
+    ElementType3D,
+    Node,
+    Restraint,
+)
+from specklepy.objects.structural.loading import (
+    ActionType,
+    BeamLoadType,
+    CombinationType,
+    FaceLoadType,
+    Load,
+    LoadAxisType,
+    LoadBeam,
+    LoadCase,
+    LoadCombinations,
+    LoadDirection,
+    LoadDirection2D,
+    LoadFace,
+    LoadGravity,
+    LoadNode,
+    LoadType,
+)
+from specklepy.objects.structural.materials import (
+    Concrete,
+    MaterialType,
+    Steel,
+    StructuralMaterial,
+    Timber,
+)
+from specklepy.objects.structural.properties import (
+    BaseReferencePoint,
+    MemberType,
+    Property,
+    Property1D,
+    Property2D,
+    Property3D,
+    PropertyDamper,
+    PropertyMass,
+    PropertySpring,
+    PropertyType2D,
+    PropertyType3D,
+    PropertyTypeDamper,
+    PropertyTypeSpring,
+    ReferenceSurface,
+    ReferenceSurfaceEnum,
+    SectionProfile,
+    ShapeType,
+    shapeType,
+)
+from specklepy.objects.structural.results import (
+    Result,
+    Result1D,
+    Result2D,
+    Result3D,
+    ResultGlobal,
+    ResultNode,
+    ResultSet1D,
+    ResultSet2D,
+    ResultSet3D,
+    ResultSetAll,
+    ResultSetNode,
+)
+
+__all__ = [
+    "Element1D",
+    "Element2D",
+    "Element3D",
+    "ElementType1D",
+    "ElementType2D",
+    "ElementType3D",
+    "Axis",
+    "Node",
+    "Restraint",
+    "Load",
+    "LoadType",
+    "ActionType",
+    "BeamLoadType",
+    "FaceLoadType",
+    "LoadDirection",
+    "LoadDirection2D",
+    "LoadAxisType",
+    "CombinationType",
+    "LoadBeam",
+    "LoadCase",
+    "LoadCombinations",
+    "LoadFace",
+    "LoadGravity",
+    "LoadNode",
+    "Model",
+    "ModelInfo",
+    "ModelSettings",
+    "ModelUnits",
+    "MaterialType",
+    "Concrete",
+    "StructuralMaterial",
+    "Steel",
+    "Timber",
+    "Property",
+    "Property1D",
+    "Property2D",
+    "Property3D",
+    "PropertyDamper",
+    "PropertyMass",
+    "PropertySpring",
+    "SectionProfile",
+    "MemberType",
+    "BaseReferencePoint",
+    "ReferenceSurface",
+    "PropertyType2D",
+    "PropertyType3D",
+    "ShapeType",
+    "PropertyTypeSpring",
+    "PropertyTypeDamper",
+    "ReferenceSurfaceEnum",
+    "shapeType",
+    "Result",
+    "Result1D",
+    "ResultSet1D",
+    "Result2D",
+    "ResultSet2D",
+    "Result3D",
+    "ResultSet3D",
+    "ResultGlobal",
+    "ResultSetNode",
+    "ResultNode",
+    "ResultSetAll",
+]

src/specklepy/objects/structural/analysis.py

@@ -0,0 +1,49 @@
+from typing import List, Optional
+
+from specklepy.objects.base import Base
+
+STRUCTURAL_ANALYSIS = "Objects.Structural.Analysis."
+
+
+class ModelUnits(Base, speckle_type=STRUCTURAL_ANALYSIS + "ModelUnits"):
+    length: Optional[str] = None
+    sections: Optional[str] = None
+    displacements: Optional[str] = None
+    stress: Optional[str] = None
+    force: Optional[str] = None
+    mass: Optional[str] = None
+    time: Optional[str] = None
+    temperature: Optional[str] = None
+    velocity: Optional[str] = None
+    acceleration: Optional[str] = None
+    energy: Optional[str] = None
+    angle: Optional[str] = None
+    strain: Optional[str] = None
+
+
+class ModelSettings(Base, speckle_type=STRUCTURAL_ANALYSIS + "ModelSettings"):
+    modelUnits: Optional[ModelUnits] = None
+    steelCode: Optional[str] = None
+    concreteCode: Optional[str] = None
+    coincidenceTolerance: float = 0.0
+
+
+class ModelInfo(Base, speckle_type=STRUCTURAL_ANALYSIS + "ModelInfo"):
+    name: Optional[str] = None
+    description: Optional[str] = None
+    projectNumber: Optional[str] = None
+    projectName: Optional[str] = None
+    settings: Optional[ModelSettings] = None
+    initials: Optional[str] = None
+    application: Optional[str] = None
+
+
+class Model(Base, speckle_type=STRUCTURAL_ANALYSIS + "Model"):
+    specs: Optional[ModelInfo] = None
+    nodes: Optional[List] = None
+    elements: Optional[List] = None
+    loads: Optional[List] = None
+    restraints: Optional[List] = None
+    properties: Optional[List] = None
+    materials: Optional[List] = None
+    layerDescription: Optional[str] = None

src/specklepy/objects/structural/axis.py

@@ -0,0 +1,10 @@
+from typing import Optional
+
+from specklepy.objects.base import Base
+from specklepy.objects.geometry import Plane
+
+
+class Axis(Base, speckle_type="Objects.Structural.Geometry.Axis"):
+    name: Optional[str] = None
+    axisType: Optional[str] = None
+    plane: Optional[Plane] = None

src/specklepy/objects/structural/geometry.py

@@ -0,0 +1,110 @@
+from enum import Enum
+from typing import List, Optional
+
+from specklepy.objects.base import Base
+from specklepy.objects.geometry import Line, Mesh, Plane, Point, Vector
+from specklepy.objects.structural.axis import Axis
+from specklepy.objects.structural.properties import (
+    Property1D,
+    Property2D,
+    Property3D,
+    PropertyDamper,
+    PropertyMass,
+    PropertySpring,
+)
+
+STRUCTURAL_GEOMETRY = "Objects.Structural.Geometry"
+
+
+class ElementType1D(int, Enum):
+    Beam = 0
+    Brace = 1
+    Bar = 2
+    Column = 3
+    Rod = 4
+    Spring = 5
+    Tie = 6
+    Strut = 7
+    Link = 8
+    Damper = 9
+    Cable = 10
+    Spacer = 11
+    Other = 12
+    Null = 13
+
+
+class ElementType2D(int, Enum):
+    Quad4 = 0
+    Quad8 = 1
+    Triangle3 = 2
+    Triangle6 = 3
+
+
+class ElementType3D(int, Enum):
+    Brick8 = 0
+    Wedge6 = 1
+    Pyramid5 = 2
+    Tetra4 = 3
+
+
+class Restraint(Base, speckle_type=STRUCTURAL_GEOMETRY + ".Restraint"):
+    code: Optional[str] = None
+    stiffnessX: float = 0.0
+    stiffnessY: float = 0.0
+    stiffnessZ: float = 0.0
+    stiffnessXX: float = 0.0
+    stiffnessYY: float = 0.0
+    stiffnessZZ: float = 0.0
+
+
+class Node(Base, speckle_type=STRUCTURAL_GEOMETRY + ".Node"):
+    name: Optional[str] = None
+    basePoint: Optional[Point] = None
+    constraintAxis: Optional[Axis] = None
+    restraint: Optional[Restraint] = None
+    springProperty: Optional[PropertySpring] = None
+    massProperty: Optional[PropertyMass] = None
+    damperProperty: Optional[PropertyDamper] = None
+
+
+class Element1D(Base, speckle_type=STRUCTURAL_GEOMETRY + ".Element1D"):
+    name: Optional[str] = None
+    baseLine: Optional[Line] = None
+    property: Optional[Property1D] = None
+    type: Optional[ElementType1D] = None
+    end1Releases: Optional[Restraint] = None
+    end2Releases: Optional[Restraint] = None
+    end1Offset: Optional[Vector] = None
+    end2Offset: Optional[Vector] = None
+    orientationNode: Optional[Node] = None
+    orinetationAngle: float = 0.0
+    localAxis: Optional[Plane] = None
+    parent: Optional[Base] = None
+    end1Node: Optional[Node] = None
+    end2Node: Optional[Node] = None
+    topology: Optional[List] = None
+    displayMesh: Optional[Mesh] = None
+
+
+class Element2D(Base, speckle_type=STRUCTURAL_GEOMETRY + ".Element2D"):
+    name: Optional[str] = None
+    property: Optional[Property2D] = None
+    type: Optional[ElementType2D] = None
+    offset: float = 0.0
+    orientationAngle: float = 0.0
+    parent: Optional[Base] = None
+    topology: Optional[List] = None
+    displayMesh: Optional[Mesh] = None
+
+
+class Element3D(Base, speckle_type=STRUCTURAL_GEOMETRY + ".Element3D"):
+    name: Optional[str] = None
+    baseMesh: Optional[Mesh] = None
+    property: Optional[Property3D] = None
+    type: Optional[ElementType3D] = None
+    orientationAngle: float = 0.0
+    parent: Optional[Base] = None
+    topology: List
+
+
+# class Storey needs ependency on built elements first

src/specklepy/objects/structural/loading.py

@@ -0,0 +1,137 @@
+from enum import Enum
+from typing import List, Optional
+
+from specklepy.objects.base import Base
+from specklepy.objects.geometry import Vector
+from specklepy.objects.structural.axis import Axis
+
+STRUCTURAL_LOADING = "Objects.Structural.Loading."
+
+
+class LoadType(int, Enum):
+    none = 0
+    Dead = 1
+    SuperDead = 2
+    Soil = 3
+    Live = 4
+    LiveRoof = 5
+    ReducibleLive = 6
+    Wind = 7
+    Snow = 8
+    Rain = 9
+    Thermal = 10
+    Notional = 11
+    Prestress = 12
+    Equivalent = 13
+    Accidental = 14
+    SeismicRSA = 15
+    SeismicAccTorsion = 16
+    SeismicStatic = 17
+    Other = 18
+
+
+class ActionType(int, Enum):
+    none = 0
+    Permanent = 1
+    Variable = 2
+    Accidental = 3
+
+
+class BeamLoadType(int, Enum):
+    Point = 0
+    Uniform = 1
+    Linear = 2
+    Patch = 3
+    TriLinear = 4
+
+
+class FaceLoadType(int, Enum):
+    Constant = 0
+    Variable = 1
+    Point = 2
+
+
+class LoadDirection2D(int, Enum):
+    X = 0
+    Y = 1
+    Z = 2
+
+
+class LoadDirection(int, Enum):
+    X = 0
+    Y = 1
+    Z = 2
+    XX = 3
+    YY = 4
+    ZZ = 5
+
+
+class LoadAxisType(int, Enum):
+    Global = 0
+    Local = 1  # local element axes
+    DeformedLocal = (
+        2  # element local axis that is embedded in the element as it deforms
+    )
+
+
+class CombinationType(int, Enum):
+    LinearAdd = 0
+    Envelope = 1
+    AbsoluteAdd = 2
+    SRSS = 3
+    RangeAdd = 4
+
+
+class LoadCase(Base, speckle_type=STRUCTURAL_LOADING + "LoadCase"):
+    name: Optional[str] = None
+    loadType: Optional[LoadType] = None
+    group: Optional[str] = None
+    actionType: Optional[ActionType] = None
+    description: Optional[str] = None
+
+
+class Load(Base, speckle_type=STRUCTURAL_LOADING + "Load"):
+    name: Optional[str] = None
+    loadCase: Optional[LoadCase] = None
+
+
+class LoadBeam(Load, speckle_type=STRUCTURAL_LOADING + "LoadBeam"):
+    elements: Optional[List] = None
+    loadType: Optional[BeamLoadType] = None
+    direction: Optional[LoadDirection] = None
+    loadAxis: Optional[Axis] = None
+    loadAxisType: Optional[LoadAxisType] = None
+    isProjected: Optional[bool] = None
+    values: Optional[List] = None
+    positions: Optional[List] = None
+
+
+class LoadCombinations(Base, speckle_type=STRUCTURAL_LOADING + "LoadCombination"):
+    name: Optional[str] = None
+    loadCases: List
+    loadFactors: List
+    combinationType: CombinationType
+
+
+class LoadFace(Load, speckle_type=STRUCTURAL_LOADING + "LoadFace"):
+    elements: Optional[List] = None
+    loadType: Optional[FaceLoadType] = None
+    direction: Optional[LoadDirection2D] = None
+    loadAxis: Optional[Axis] = None
+    loadAxisType: Optional[LoadAxisType] = None
+    isProjected: Optional[bool] = None
+    values: Optional[List] = None
+    positions: Optional[List] = None
+
+
+class LoadGravity(Load, speckle_type=STRUCTURAL_LOADING + "LoadGravity"):
+    elements: Optional[List] = None
+    nodes: Optional[List] = None
+    gravityFactors: Optional[Vector] = None
+
+
+class LoadNode(Load, speckle_type=STRUCTURAL_LOADING + "LoadNode"):
+    nodes: Optional[List] = None
+    loadAxis: Optional[Axis] = None
+    direction: Optional[LoadDirection] = None
+    value: float = 0.0

src/specklepy/objects/structural/materials.py

@@ -0,0 +1,61 @@
+from enum import Enum
+from typing import Optional
+
+from specklepy.objects.base import Base
+
+STRUCTURAL_MATERIALS = "Objects.Structural.Materials"
+
+
+class MaterialType(int, Enum):
+    Concrete = 0
+    Steel = 1
+    Timber = 2
+    Aluminium = 3
+    Masonry = 4
+    FRP = 5
+    Glass = 6
+    Fabric = 7
+    Rebar = 8
+    Tendon = 9
+    ColdFormed = 10
+    Other = 11
+
+
+class StructuralMaterial(
+    Base, speckle_type=STRUCTURAL_MATERIALS + ".StructuralMaterial"
+):
+    name: Optional[str] = None
+    grade: Optional[str] = None
+    materialType: Optional[MaterialType] = None
+    designCode: Optional[str] = None
+    codeYear: Optional[str] = None
+    strength: float = 0.0
+    elasticModulus: float = 0.0
+    poissonsRatio: float = 0.0
+    shearModulus: float = 0.0
+    density: float = 0.0
+    thermalExpansivity: float = 0.0
+    dampingRatio: float = 0.0
+    cost: float = 0.0
+    materialSafetyFactor: float = 0.0
+
+
+class Concrete(StructuralMaterial):
+    compressiveStrength: float = 0.0
+    tensileStrength: float = 0.0
+    flexuralStrength: float = 0.0
+    maxCompressiveStrain: float = 0.0
+    maxTensileStrain: float = 0.0
+    maxAggregateSize: float = 0.0
+    lightweight: Optional[bool] = None
+
+
+class Steel(StructuralMaterial, speckle_type=STRUCTURAL_MATERIALS + ".Steel"):
+    yieldStrength: float = 0.0
+    ultimateStrength: float = 0.0
+    maxStrain: float = 0.0
+    strainHardeningModulus: float = 0.0
+
+
+class Timber(StructuralMaterial, speckle_type=STRUCTURAL_MATERIALS + ".Timber"):
+    species: Optional[str] = None

src/specklepy/objects/structural/properties.py

@@ -0,0 +1,209 @@
+from enum import Enum
+from typing import Optional
+
+from specklepy.objects.base import Base
+from specklepy.objects.structural.axis import Axis
+from specklepy.objects.structural.materials import StructuralMaterial
+
+STRUCTURAL_PROPERTY = "Objectives.Structural.Properties"
+
+
+class MemberType(int, Enum):
+    Beam = 0
+    Column = 1
+    Generic1D = 2
+    Slab = 3
+    Wall = 4
+    Generic2D = 5
+    VoidCutter1D = 6
+    VoidCutter2D = 7
+
+
+class BaseReferencePoint(int, Enum):
+    Centroid = 0
+    TopLeft = 1
+    TopCentre = 2
+    TopRight = 3
+    MidLeft = 4
+    MidRight = 5
+    BotLeft = 6
+    BotCentre = 7
+    BotRight = 8
+
+
+class ReferenceSurface(int, Enum):
+    Top = 0
+    Middle = 1
+    Bottom = 2
+
+
+class PropertyType2D(int, Enum):
+    Stress = 0
+    Fabric = 1
+    Plate = 2
+    Shell = 3
+    Curved = 4
+    Wall = 5
+    Strain = 6
+    Axi = 7
+    Load = 8
+
+
+class PropertyType3D(int, Enum):
+    Solid = 0
+    Infinite = 1
+
+
+class ShapeType(int, Enum):
+    Rectangular = 0
+    Circular = 1
+    I = 2  # noqa: E741
+    Tee = 3
+    Angle = 4
+    Channel = 5
+    Perimeter = 6
+    Box = 7
+    Catalogue = 8
+    Explicit = 9
+
+
+class PropertyTypeSpring(int, Enum):
+    Axial = 0
+    Torsional = 1
+    General = 2
+    Matrix = 3
+    TensionOnly = 4
+    CompressionOnly = 5
+    Connector = 6
+    LockUp = 7
+    Gap = 8
+    Friction = 9
+
+
+class PropertyTypeDamper(int, Enum):
+    Axial = 0
+    Torsional = 1
+    General = 2
+
+
+class Property(Base, speckle_type=STRUCTURAL_PROPERTY):
+    name: Optional[str] = None
+
+
+class SectionProfile(Base, speckle_type=STRUCTURAL_PROPERTY + ".SectionProfile"):
+    name: Optional[str] = None
+    shapeType: Optional[ShapeType] = None
+    area: float = 0.0
+    Iyy: float = 0.0
+    Izz: float = 0.0
+    J: float = 0.0
+    Ky: float = 0.0
+    weight: float = 0.0
+
+
+class Property1D(Property, speckle_type=STRUCTURAL_PROPERTY + ".Property1D"):
+    memberType: Optional[MemberType] = None
+    material: Optional[StructuralMaterial] = None
+    profile: Optional[SectionProfile] = None
+    referencePoint: Optional[BaseReferencePoint] = None
+    offsetY: float = 0.0
+    offsetZ: float = 0.0
+
+
+class Property2D(Property, speckle_type=STRUCTURAL_PROPERTY + ".Property2D"):
+    type: Optional[PropertyType2D] = None
+    thickness: float = 0.0
+    material: Optional[StructuralMaterial] = None
+    orientationAxis: Optional[Axis] = None
+    refSurface: Optional[ReferenceSurface] = None
+    zOffset: float = 0.0
+    modifierInPlane: float = 0.0
+    modifierBending: float = 0.0
+    modifierShear: float = 0.0
+    modifierVolume: float = 0.0
+
+
+class Property3D(Property, speckle_type=STRUCTURAL_PROPERTY + ".Property3D"):
+    type: Optional[PropertyType3D] = None
+    material: Optional[StructuralMaterial] = None
+    orientationAxis: Optional[Axis] = None
+
+
+class PropertyDamper(Property, speckle_type=STRUCTURAL_PROPERTY + ".PropertyDamper"):
+    damperType: Optional[PropertyTypeDamper] = None
+    dampingX: float = 0.0
+    dampingY: float = 0.0
+    dampingZ: float = 0.0
+    dampingXX: float = 0.0
+    dampingYY: float = 0.0
+    dampingZZ: float = 0.0
+
+
+class PropertyMass(Property, speckle_type=STRUCTURAL_PROPERTY + ".PropertyMass"):
+    mass: float = 0.0
+    inertiaXX: float = 0.0
+    inertiaYY: float = 0.0
+    inertiaZZ: float = 0.0
+    inertiaXY: float = 0.0
+    inertiaYZ: float = 0.0
+    inertiaZX: float = 0.0
+    massModified: Optional[bool] = None
+    massModifierX: float = 0.0
+    massModifierY: float = 0.0
+    massModifierZ: float = 0.0
+
+
+class PropertySpring(Property, speckle_type=STRUCTURAL_PROPERTY + ".PropertySpring"):
+    springType: Optional[PropertyTypeSpring] = None
+    springCurveX: float = 0.0
+    stiffnessX: float = 0.0
+    springCurveY: float = 0.0
+    stiffnessY: float = 0.0
+    springCurveZ: float = 0.0
+    stiffnessZ: float = 0.0
+    springCurveXX: float = 0.0
+    stiffnessXX: float = 0.0
+    springCurveYY: float = 0.0
+    stiffnessYY: float = 0.0
+    springCurveZZ: float = 0.0
+    stiffnessZZ: float = 0.0
+    dampingRatio: float = 0.0
+    dampingX: float = 0.0
+    dampingY: float = 0.0
+    dampingZ: float = 0.0
+    dampingXX: float = 0.0
+    dampingYY: float = 0.0
+    dampingZZ: float = 0.0
+    matrix: float = 0.0
+    postiveLockup: float = 0.0
+    frictionCoefficient: float = 0.0
+
+
+class ReferenceSurfaceEnum(int, Enum):
+    Concrete = 0
+    Steel = 1
+    Timber = 2
+    Aluminium = 3
+    Masonry = 4
+    FRP = 5
+    Glass = 6
+    Fabric = 7
+    Rebar = 8
+    Tendon = 9
+    ColdFormed = 10
+    Other = 11
+
+
+class shapeType(int, Enum):
+    Concrete = 0
+    Steel = 1
+    Timber = 2
+    Aluminium = 3
+    Masonry = 4
+    FRP = 5
+    Glass = 6
+    Fabric = 7
+    Rebar = 8
+    Tendon = 9
+    ColdFormed = 10
+    Other = 11

src/specklepy/objects/structural/results.py

@@ -0,0 +1,172 @@
+from typing import List, Optional
+
+from specklepy.objects.base import Base
+from specklepy.objects.structural.analysis import Model
+from specklepy.objects.structural.geometry import Element1D, Element2D, Element3D, Node
+
+STRUCTURAL_RESULTS = "Objects.Structural.Results."
+
+
+class Result(Base, speckle_type=STRUCTURAL_RESULTS + "Result"):
+    resultCase: Optional[Base] = None
+    permutation: Optional[str] = None
+    description: Optional[str] = None
+
+
+class ResultSet1D(Result, speckle_type=STRUCTURAL_RESULTS + "ResultSet1D"):
+    results1D: List
+
+
+class Result1D(Result, speckle_type=STRUCTURAL_RESULTS + "Result1D"):
+    element: Optional[Element1D] = None
+    position: Optional[float] = None
+    dispX: Optional[float] = None
+    dispY: Optional[float] = None
+    dispZ: Optional[float] = None
+    rotXX: Optional[float] = None
+    rotYY: Optional[float] = None
+    rotZZ: Optional[float] = None
+    forceX: Optional[float] = None
+    forceY: Optional[float] = None
+    forceZ: Optional[float] = None
+    momentXX: Optional[float] = None
+    momentYY: Optional[float] = None
+    momentZZ: Optional[float] = None
+    axialStress: Optional[float] = None
+    shearStressY: Optional[float] = None
+    shearStressZ: Optional[float] = None
+    bendingStressYPos: Optional[float] = None
+    bendingStressYNeg: Optional[float] = None
+    bendingStressZPos: Optional[float] = None
+    bendingStressZNeg: Optional[float] = None
+    combinedStressMax: Optional[float] = None
+    combinedStressMin: Optional[float] = None
+
+
+class ResultSet2D(Result, speckle_type=STRUCTURAL_RESULTS + "ResultSet2D"):
+    results2D: List
+
+
+class Result2D(Result, speckle_type=STRUCTURAL_RESULTS + "Result2D"):
+    element: Optional[Element2D] = None
+    position: List
+    dispX: Optional[float] = None
+    dispY: Optional[float] = None
+    dispZ: Optional[float] = None
+    forceXX: Optional[float] = None
+    forceYY: Optional[float] = None
+    forceXY: Optional[float] = None
+    momentXX: Optional[float] = None
+    momentYY: Optional[float] = None
+    momentXY: Optional[float] = None
+    shearX: Optional[float] = None
+    shearY: Optional[float] = None
+    stressTopXX: Optional[float] = None
+    stressTopYY: Optional[float] = None
+    stressTopZZ: Optional[float] = None
+    stressTopXY: Optional[float] = None
+    stressTopYZ: Optional[float] = None
+    stressTopZX: Optional[float] = None
+    stressMidXX: Optional[float] = None
+    stressMidYY: Optional[float] = None
+    stressMidZZ: Optional[float] = None
+    stressMidXY: Optional[float] = None
+    stressMidYZ: Optional[float] = None
+    stressMidZX: Optional[float] = None
+    stressBotXX: Optional[float] = None
+    stressBotYY: Optional[float] = None
+    stressBotZZ: Optional[float] = None
+    stressBotXY: Optional[float] = None
+    stressBotYZ: Optional[float] = None
+    stressBotZX: Optional[float] = None
+
+
+class ResultSet3D(Result, speckle_type=STRUCTURAL_RESULTS + "ResultSet3D"):
+    results3D: List
+
+
+class Result3D(Result, speckle_type=STRUCTURAL_RESULTS + "Result3D"):
+    element: Optional[Element3D] = None
+    position: List
+    dispX: Optional[float] = None
+    dispY: Optional[float] = None
+    dispZ: Optional[float] = None
+    stressXX: Optional[float] = None
+    stressYY: Optional[float] = None
+    stressZZ: Optional[float] = None
+    stressXY: Optional[float] = None
+    stressYZ: Optional[float] = None
+    stressZX: Optional[float] = None
+
+
+class ResultGlobal(Result, speckle_type=STRUCTURAL_RESULTS + "ResultGlobal"):
+    model: Optional[Model] = None
+    loadX: Optional[float] = None
+    loadY: Optional[float] = None
+    loadZ: Optional[float] = None
+    loadXX: Optional[float] = None
+    loadYY: Optional[float] = None
+    loadZZ: Optional[float] = None
+    reactionX: Optional[float] = None
+    reactionY: Optional[float] = None
+    reactionZ: Optional[float] = None
+    reactionXX: Optional[float] = None
+    reactionYY: Optional[float] = None
+    reactionZZ: Optional[float] = None
+    mode: Optional[float] = None
+    frequency: Optional[float] = None
+    loadFactor: Optional[float] = None
+    modalStiffness: Optional[float] = None
+    modalGeoStiffness: Optional[float] = None
+    effMassX: Optional[float] = None
+    effMassY: Optional[float] = None
+    effMassZ: Optional[float] = None
+    effMassXX: Optional[float] = None
+    effMassYY: Optional[float] = None
+    effMassZZ: Optional[float] = None
+
+
+class ResultSetNode(Result, speckle_type=STRUCTURAL_RESULTS + "ResultSetNode"):
+    resultsNode: List
+
+
+class ResultNode(Result, speckle_type=STRUCTURAL_RESULTS + " ResultNode"):
+    node: Optional[Node] = None
+    dispX: Optional[float] = None
+    dispY: Optional[float] = None
+    dispZ: Optional[float] = None
+    rotXX: Optional[float] = None
+    rotYY: Optional[float] = None
+    rotZZ: Optional[float] = None
+    reactionX: Optional[float] = None
+    reactionY: Optional[float] = None
+    reactionZ: Optional[float] = None
+    reactionXX: Optional[float] = None
+    reactionYY: Optional[float] = None
+    reactionZZ: Optional[float] = None
+    constraintX: Optional[float] = None
+    constraintY: Optional[float] = None
+    constraintZ: Optional[float] = None
+    constraintXX: Optional[float] = None
+    constraintYY: Optional[float] = None
+    constraintZZ: Optional[float] = None
+    velX: Optional[float] = None
+    velY: Optional[float] = None
+    velZ: Optional[float] = None
+    velXX: Optional[float] = None
+    velYY: Optional[float] = None
+    velZZ: Optional[float] = None
+    accX: Optional[float] = None
+    accY: Optional[float] = None
+    accZ: Optional[float] = None
+    accXX: Optional[float] = None
+    accYY: Optional[float] = None
+    accZZ: Optional[float] = None
+
+
+class ResultSetAll(Base, speckle_type=None):
+    resultSet1D: Optional[ResultSet1D] = None
+    resultSet2D: Optional[ResultSet2D] = None
+    resultSet3D: Optional[ResultSet3D] = None
+    resultsGlobal: Optional[ResultGlobal] = None
+    resultsNode: Optional[ResultSetNode] = None

src/specklepy/objects/units.py

@@ -0,0 +1,84 @@
+from enum import Enum
+from typing import Union
+
+from specklepy.logging.exceptions import SpeckleException, SpeckleInvalidUnitException
+
+__all__ = [
+    "Units",
+    "get_encoding_from_units",
+    "get_units_from_encoding",
+    "get_units_from_string",
+]
+
+
+class Units(Enum):
+    mm = "mm"
+    cm = "cm"
+    m = "m"
+    km = "km"
+    inches = "in"
+    feet = "ft"
+    yards = "yd"
+    miles = "mi"
+    none = "none"
+
+
+UNITS_STRINGS = {
+    Units.mm: ["mm", "mil", "millimeters", "millimetres"],
+    Units.cm: ["cm", "centimetre", "centimeter", "centimetres", "centimeters"],
+    Units.m: ["m", "meter", "meters", "metre", "metres"],
+    Units.km: ["km", "kilometer", "kilometre", "kilometers", "kilometres"],
+    Units.inches: ["in", "inch", "inches"],
+    Units.feet: ["ft", "foot", "feet"],
+    Units.yards: ["yd", "yard", "yards"],
+    Units.miles: ["mi", "mile", "miles"],
+    Units.none: ["none", "null"],
+}
+
+UNITS_ENCODINGS = {
+    Units.none: 0,
+    None: 0,
+    Units.mm: 1,
+    Units.cm: 2,
+    Units.m: 3,
+    Units.km: 4,
+    Units.inches: 5,
+    Units.feet: 6,
+    Units.yards: 7,
+    Units.miles: 8,
+}
+
+
+def get_units_from_string(unit: str) -> Units:
+    if not isinstance(unit, str):
+        raise SpeckleInvalidUnitException(unit)
+    unit = str.lower(unit)
+    for name, alternates in UNITS_STRINGS.items():
+        if unit in alternates:
+            return name
+    raise SpeckleInvalidUnitException(unit)
+
+
+def get_units_from_encoding(unit: int):
+    for name, encoding in UNITS_ENCODINGS.items():
+        if unit == encoding:
+            return name
+
+    raise SpeckleException(
+        message=(
+            f"Could not understand what unit {unit} is referring to."
+            f"Please enter a valid unit encoding (eg {UNITS_ENCODINGS})."
+        )
+    )
+
+
+def get_encoding_from_units(unit: Union[Units, None]):
+    try:
+        return UNITS_ENCODINGS[unit]
+    except KeyError as e:
+        raise SpeckleException(
+            message=(
+                f"No encoding exists for unit {unit}."
+                f"Please enter a valid unit to encode (eg {UNITS_ENCODINGS})."
+            )
+        ) from e

src/specklepy/serialization/base_object_serializer.py

@@ -1,58 +1,109 @@
-import json
 import hashlib
 import re
-
+import warnings
+from enum import Enum
+from typing import Any, Dict, List, Optional, Tuple
 from uuid import uuid4
-from typing import Any, Dict, List, Tuple
+from warnings import warn
+
+import ujson
+
+# import for serialization
+from specklepy.logging.exceptions import SpeckleException, SpeckleWarning
 from specklepy.objects.base import Base, DataChunk
-from specklepy.logging.exceptions import SerializationException, SpeckleException
 from specklepy.transports.abstract_transport import AbstractTransport
-import specklepy.objects.geometry
-import specklepy.objects.other
 
 PRIMITIVES = (int, float, str, bool)
 
 
 def hash_obj(obj: Any) -> str:
-    return hashlib.sha256(json.dumps(obj).encode()).hexdigest()[:32]
+    return hashlib.sha256(ujson.dumps(obj).encode()).hexdigest()[:32]
+
+
+def safe_json_loads(obj: str, obj_id=None) -> Any:
+    try:
+        return ujson.loads(obj)
+    except ValueError as err:
+        import json
+
+        warn(
+            f"Failed to deserialise object (id: {obj_id}). This is likely a ujson big"
+            f" int error - falling back to json. \nError: {err}",
+            SpeckleWarning,
+        )
+        return json.loads(obj)
 
 
 class BaseObjectSerializer:
     read_transport: AbstractTransport
     write_transports: List[AbstractTransport]
-    detach_lineage: List[bool] = []  # tracks depth and whether or not to detach
-    lineage: List[str] = []  # keeps track of hash chain through the object tree
-    family_tree: Dict[str, Dict[str, int]] = {}
-    closure_table: Dict[str, Dict[str, int]] = {}
+    detach_lineage: List[bool]  # tracks depth and whether or not to detach
+    lineage: List[str]  # keeps track of hash chain through the object tree
+    family_tree: Dict[str, Dict[str, int]]
+    closure_table: Dict[str, Dict[str, int]]
+    deserialized: Dict[
+        str, Base
+    ]  # holds deserialized objects so objects with same id return the same instance
 
     def __init__(
-        self, write_transports: List[AbstractTransport] = [], read_transport=None
+        self,
+        write_transports: Optional[List[AbstractTransport]] = None,
+        read_transport: Optional[AbstractTransport] = None,
     ) -> None:
-        self.write_transports = write_transports
+        self.write_transports = write_transports or []
         self.read_transport = read_transport
+        self.detach_lineage = []
+        self.lineage = []
+        self.family_tree = {}
+        self.closure_table = {}
+        self.deserialized = {}
 
     def write_json(self, base: Base):
-        self.__reset_writer()
-        self.detach_lineage = [True]
-        hash, obj = self.traverse_base(base)
-        return hash, json.dumps(obj)
+        """Serializes a given base object into a json string
+        Arguments:
+            base {Base} -- the base object to be decomposed and serialized
 
-    def traverse_base(self, base: Base) -> Tuple[str, Dict]:
+        Returns:
+            (str, str) -- a tuple containing the object id of the base object and
+            the serialized object string
+        """
+
+        obj_id, obj = self.traverse_base(base)
+
+        return obj_id, ujson.dumps(obj)
+
+    def traverse_base(self, base: Base) -> Tuple[str, Dict[str, Any]]:
         """Decomposes the given base object and builds a serializable dictionary
 
         Arguments:
             base {Base} -- the base object to be decomposed and serialized
 
         Returns:
-            (str, dict) -- a tuple containing the hash (id) of the base object and the constructed serializable dictionary
+            (str, dict) -- a tuple containing the object id of the base object and
+            the constructed serializable dictionary
         """
+        self.__reset_writer()
+
+        if self.write_transports:
+            for wt in self.write_transports:
+                wt.begin_write()
+
+        obj_id, obj = self._traverse_base(base)
+
+        if self.write_transports:
+            for wt in self.write_transports:
+                wt.end_write()
+
+        return obj_id, obj
+
+    def _traverse_base(self, base: Base) -> Tuple[str, Dict]:
         if not self.detach_lineage:
             self.detach_lineage = [True]
 
         self.lineage.append(uuid4().hex)
         object_builder = {"id": "", "speckle_type": "Base", "totalChildrenCount": 0}
         object_builder.update(speckle_type=base.speckle_type)
-        obj, props = base, base.get_member_names()
+        obj, props = base, base.get_serializable_attributes()
 
         while props:
             prop = props.pop(0)
@@ -60,8 +111,8 @@ class BaseObjectSerializer:
             chunkable = False
             detach = False
 
-            # skip nulls or props marked to be ignored with "__" or "_"
-            if value is None or prop.startswith(("__", "_")):
+            # skip props marked to be ignored with "__" or "_"
+            if prop.startswith(("__", "_")):
                 continue
 
             # don't prepopulate id as this will mess up hashing
@@ -70,7 +121,9 @@ class BaseObjectSerializer:
 
             # only bother with chunking and detaching if there is a write transport
             if self.write_transports:
-                dynamic_chunk_match = re.match(r"^@\((\d*)\)", prop)
+                dynamic_chunk_match = prop.startswith("@") and re.match(
+                    r"^@\((\d*)\)", prop
+                )
                 if dynamic_chunk_match:
                     chunk_size = dynamic_chunk_match.groups()[0]
                     base._chunkable[prop] = (
@@ -82,17 +135,22 @@ class BaseObjectSerializer:
                     prop.startswith("@") or prop in base._detachable or chunkable
                 )
 
-            # 1. handle primitives (ints, floats, strings, and bools)
-            if isinstance(value, PRIMITIVES):
+            # 1. handle None and primitives (ints, floats, strings, and bools)
+            if value is None or isinstance(value, PRIMITIVES):
                 object_builder[prop] = value
                 continue
 
+            # NOTE: for dynamic props, this won't be re-serialised as an enum but as an int
+            if isinstance(value, Enum):
+                object_builder[prop] = value.value
+                continue
+
             # 2. handle Base objects
             elif isinstance(value, Base):
                 child_obj = self.traverse_value(value, detach=detach)
                 if detach and self.write_transports:
-                    ref_hash = child_obj["id"]
-                    object_builder[prop] = self.detach_helper(ref_hash=ref_hash)
+                    ref_id = child_obj["id"]
+                    object_builder[prop] = self.detach_helper(ref_id=ref_id)
                 else:
                     object_builder[prop] = child_obj
 
@@ -111,8 +169,8 @@ class BaseObjectSerializer:
                 chunk_refs = []
                 for c in chunks:
                     self.detach_lineage.append(detach)
-                    ref_hash, _ = self.traverse_base(c)
-                    ref_obj = self.detach_helper(ref_hash=ref_hash)
+                    ref_id, _ = self._traverse_base(c)
+                    ref_obj = self.detach_helper(ref_id=ref_id)
                     chunk_refs.append(ref_obj)
                 object_builder[prop] = chunk_refs
 
@@ -131,20 +189,20 @@ class BaseObjectSerializer:
             }
         object_builder["totalChildrenCount"] = len(closure)
 
-        hash = hash_obj(object_builder)
+        obj_id = hash_obj(object_builder)
 
-        object_builder["id"] = hash
+        object_builder["id"] = obj_id
         if closure:
-            object_builder["__closure"] = self.closure_table[hash] = closure
+            object_builder["__closure"] = self.closure_table[obj_id] = closure
 
         # write detached or root objects to transports
         if detached and self.write_transports:
             for t in self.write_transports:
-                t.save_object(id=hash, serialized_object=json.dumps(object_builder))
+                t.save_object(id=obj_id, serialized_object=ujson.dumps(object_builder))
 
         del self.lineage[-1]
 
-        return hash, object_builder
+        return obj_id, object_builder
 
     def traverse_value(self, obj: Any, detach: bool = False) -> Any:
         """Decomposes a given object and constructs a serializable object or dictionary
@@ -155,9 +213,15 @@ class BaseObjectSerializer:
         Returns:
             Any -- a serializable version of the given object
         """
+        if obj is None:
+            return None
         if isinstance(obj, PRIMITIVES):
             return obj
 
+        # NOTE: for dynamic props, this won't be re-serialised as an enum but as an int
+        if isinstance(obj, Enum):
+            return obj.value
+
         elif isinstance(obj, (list, tuple, set)):
             if not detach:
                 return [self.traverse_value(o) for o in obj]
@@ -166,15 +230,15 @@ class BaseObjectSerializer:
             for o in obj:
                 if isinstance(o, Base):
                     self.detach_lineage.append(detach)
-                    hash, _ = self.traverse_base(o)
-                    detached_list.append(self.detach_helper(ref_hash=hash))
+                    ref_id, _ = self._traverse_base(o)
+                    detached_list.append(self.detach_helper(ref_id=ref_id))
                 else:
                     detached_list.append(self.traverse_value(o, detach))
             return detached_list
 
         elif isinstance(obj, dict):
             for k, v in obj.items():
-                if isinstance(v, PRIMITIVES):
+                if isinstance(v, PRIMITIVES) or v is None:
                     continue
                 else:
                     obj[k] = self.traverse_value(v)
@@ -182,24 +246,28 @@ class BaseObjectSerializer:
 
         elif isinstance(obj, Base):
             self.detach_lineage.append(detach)
-            _, base_obj = self.traverse_base(obj)
+            _, base_obj = self._traverse_base(obj)
             return base_obj
 
         else:
             try:
                 return obj.dict()
-            except:
-                SerializationException(
-                    message=f"Failed to handle {type(obj)} in `BaseObjectSerializer.traverse_value`",
-                    object=obj,
+            except Exception:
+                warn(
+                    f"Failed to handle {type(obj)} in"
+                    " `BaseObjectSerializer.traverse_value`",
+                    SpeckleWarning,
                 )
+
                 return str(obj)
 
-    def detach_helper(self, ref_hash: str) -> Dict[str, str]:
-        """Helper to keep track of detached objects and their depth in the family tree and create reference objects to place in the parent object
+    def detach_helper(self, ref_id: str) -> Dict[str, str]:
+        """
+        Helper to keep track of detached objects and their depth in the family tree
+        and create reference objects to place in the parent object
 
         Arguments:
-            ref_hash {str} -- the hash of the fully traversed object
+            ref_id {str} -- the id of the fully traversed object
 
         Returns:
             dict -- a reference object to be inserted into the given object's parent
@@ -208,19 +276,22 @@ class BaseObjectSerializer:
         for parent in self.lineage:
             if parent not in self.family_tree:
                 self.family_tree[parent] = {}
-            if ref_hash not in self.family_tree[parent] or self.family_tree[parent][
-                ref_hash
+            if ref_id not in self.family_tree[parent] or self.family_tree[parent][
+                ref_id
             ] > len(self.detach_lineage):
-                self.family_tree[parent][ref_hash] = len(self.detach_lineage)
+                self.family_tree[parent][ref_id] = len(self.detach_lineage)
 
         return {
-            "referencedId": ref_hash,
+            "referencedId": ref_id,
             "speckle_type": "reference",
         }
 
     def __reset_writer(self) -> None:
-        """Reinitializes the lineage, and other variables that get used during the json writing process"""
-        self.detach_lineage = []
+        """
+        Reinitializes the lineage, and other variables that get used during the json
+        writing process
+        """
+        self.detach_lineage = [True]
         self.lineage = []
         self.family_tree = {}
         self.closure_table = {}
@@ -236,7 +307,9 @@ class BaseObjectSerializer:
         """
         if not obj_string:
             return None
-        obj = json.loads(obj_string)
+
+        self.deserialized = {}
+        obj = safe_json_loads(obj_string)
         return self.recompose_base(obj=obj)
 
     def recompose_base(self, obj: dict) -> Base:
@@ -252,7 +325,10 @@ class BaseObjectSerializer:
         if not obj:
             return
         if isinstance(obj, str):
-            obj = json.loads(obj)
+            obj = safe_json_loads(obj)
+
+        if "id" in obj and obj["id"] in self.deserialized:
+            return self.deserialized[obj["id"]]
 
         if "speckle_type" in obj and obj["speckle_type"] == "reference":
             obj = self.get_child(obj=obj)
@@ -266,7 +342,7 @@ class BaseObjectSerializer:
         object_type = Base.get_registered_type(speckle_type)
 
         # initialise the base object using `speckle_type` fall back to base if needed
-        base = object_type() if object_type else Base(speckle_type=speckle_type)
+        base = object_type() if object_type else Base.of_type(speckle_type=speckle_type)
         # get total children count
         if "__closure" in obj:
             if not self.read_transport:
@@ -284,23 +360,31 @@ class BaseObjectSerializer:
 
             # 2. handle referenced child objects
             elif "referencedId" in value:
-                ref_hash = value["referencedId"]
-                ref_obj_str = self.read_transport.get_object(id=ref_hash)
-                if not ref_obj_str:
-                    raise SpeckleException(
-                        f"Could not find the referenced child object of id `{ref_hash}` in the given read transport: {self.read_transport.name}"
+                ref_id = value["referencedId"]
+                ref_obj_str = self.read_transport.get_object(id=ref_id)
+                if ref_obj_str:
+                    ref_obj = safe_json_loads(ref_obj_str, ref_id)
+                    base.__setattr__(prop, self.recompose_base(obj=ref_obj))
+                else:
+                    warnings.warn(
+                        f"Could not find the referenced child object of id `{ref_id}`"
+                        f" in the given read transport: {self.read_transport.name}",
+                        SpeckleWarning,
                     )
-                ref_obj = json.loads(ref_obj_str)
-                base.__setattr__(prop, self.recompose_base(obj=ref_obj))
+                    base.__setattr__(prop, self.handle_value(value))
 
             # 3. handle all other cases (base objects, lists, and dicts)
             else:
                 base.__setattr__(prop, self.handle_value(value))
 
+        if "id" in obj:
+            self.deserialized[obj["id"]] = base
+
         return base
 
     def handle_value(self, obj: Any):
-        """Helper for recomposing a base object by handling the dictionary representation's values
+        """Helper for recomposing a base object by handling the dictionary
+        representation's values
 
         Arguments:
             obj {Any} -- a value from the base object dictionary
@@ -324,7 +408,7 @@ class BaseObjectSerializer:
                 # handle chunked lists
                 data = []
                 for o in obj_list:
-                    data.extend(o["data"])
+                    data.extend(o.data)
                 return data
             return obj_list
 
@@ -342,10 +426,14 @@ class BaseObjectSerializer:
             return obj
 
     def get_child(self, obj: Dict):
-        ref_hash = obj["referencedId"]
-        ref_obj_str = self.read_transport.get_object(id=ref_hash)
+        ref_id = obj["referencedId"]
+        ref_obj_str = self.read_transport.get_object(id=ref_id)
         if not ref_obj_str:
-            raise SpeckleException(
-                f"Could not find the referenced child object of id `{ref_hash}` in the given read transport: {self.read_transport.name}"
+            warnings.warn(
+                f"Could not find the referenced child object of id `{ref_id}` in the"
+                f" given read transport: {self.read_transport.name}",
+                SpeckleWarning,
             )
-        return json.loads(ref_obj_str)
+            return obj
+
+        return safe_json_loads(ref_obj_str, ref_id)

src/specklepy/transports/abstract_transport.py

@@ -1,16 +1,8 @@
 from abc import ABC, abstractmethod
-from typing import Any, Optional, List, Dict
-from pydantic import BaseModel
-from pydantic.main import Extra
+from typing import Dict, List, Optional
 
-#  __________________
-# |                  |
-# |  this is v wip   |
-# |  pls be careful  |
-# |__________________|
-# (\__/) ||
-# (•ㅅ•)  ||
-# / 　 づ
+from pydantic import BaseModel
+from pydantic.config import Extra
 
 
 class AbstractTransport(ABC, BaseModel):
@@ -27,7 +19,9 @@ class AbstractTransport(ABC, BaseModel):
 
     @abstractmethod
     def end_write(self) -> None:
-        """Optional: signals to the transport that no more items will need to be written."""
+        """
+        Optional: signals to the transport that no more items will need to be written.
+        """
         pass
 
     @abstractmethod
@@ -48,7 +42,8 @@ class AbstractTransport(ABC, BaseModel):
 
         Arguments:
             id {str} -- the hash of the object
-            source_transport {AbstractTransport) -- the transport through which the object can be found
+            source_transport {AbstractTransport)
+            -- the transport through which the object can be found
         """
         pass
 
@@ -60,7 +55,8 @@ class AbstractTransport(ABC, BaseModel):
             id {str} -- the hash of the object
 
         Returns:
-            str -- the full string representation of the object (or null if no object is found)
+            str -- the full string representation
+            of the object (or null if no object is found)
         """
         pass
 
@@ -72,7 +68,8 @@ class AbstractTransport(ABC, BaseModel):
             id_list -- List of object id to be checked
 
         Returns:
-            Dict[str, bool] -- keys: input ids, values: whether the transport has that object
+            Dict[str, bool] -- keys: input ids, values:
+                whether the transport has that object
         """
         pass
 
@@ -84,7 +81,8 @@ class AbstractTransport(ABC, BaseModel):
 
         Arguments:
             id {str} -- the id of the object you want to copy
-            target_transport {AbstractTransport} -- the transport you want to copy the object to
+            target_transport {AbstractTransport}
+                -- the transport you want to copy the object to
         Returns:
             str -- the string representation of the root object
         """

src/specklepy/transports/memory.py

@@ -1,6 +1,5 @@
-import json
-from typing import Any, List, Dict
-from specklepy.logging.exceptions import SpeckleException
+from typing import Any, Dict, List
+
 from specklepy.transports.abstract_transport import AbstractTransport
 
 
@@ -28,10 +27,7 @@ class MemoryTransport(AbstractTransport):
         raise NotImplementedError
 
     def get_object(self, id: str) -> str or None:
-        if id in self.objects:
-            return self.objects[id]
-        else:
-            return None
+        return self.objects[id] if id in self.objects else None
 
     def has_objects(self, id_list: List[str]) -> Dict[str, bool]:
         return {id: (id in self.objects) for id in id_list}

src/specklepy/transports/server/__init__.py

@@ -0,0 +1,3 @@
+from specklepy.transports.server.server import ServerTransport
+
+__all__ = ["ServerTransport"]

src/specklepy/transports/server/batch_sender.py

@@ -1,11 +1,11 @@
+import gzip
 import json
 import logging
-import threading
 import queue
-import time
-import gzip
+import threading
 
 import requests
+
 from specklepy.logging.exceptions import SpeckleException
 
 LOG = logging.getLogger(__name__)
@@ -92,17 +92,25 @@ class BatchSender(object):
 
     def _bg_send_batch(self, session, batch):
         object_ids = [obj[0] for obj in batch]
-        server_has_object = session.post(
-            url=f"{self.server_url}/api/diff/{self.stream_id}",
-            data={"objects": json.dumps(object_ids)},
-        ).json()
+        try:
+            server_has_object = session.post(
+                url=f"{self.server_url}/api/diff/{self.stream_id}",
+                data={"objects": json.dumps(object_ids)},
+            ).json()
+        except Exception as ex:
+            raise SpeckleException(
+                f"Invalid credentials - cannot send objects to server {self.server_url}"
+            ) from ex
 
         new_object_ids = [x for x in object_ids if not server_has_object[x]]
         new_object_ids = set(new_object_ids)
         new_objects = [obj[1] for obj in batch if obj[0] in new_object_ids]
 
         if not new_objects:
-            LOG.info(f"Uploading batch of {len(batch)} objects: all objects are already in the server")
+            LOG.info(
+                f"Uploading batch of {len(batch)} objects: all objects are already in"
+                " the server"
+            )
             return
 
         upload_data = "[" + ",".join(new_objects) + "]"
@@ -112,24 +120,35 @@ class BatchSender(object):
             % (len(batch), len(new_objects), len(upload_data), len(upload_data_gzip))
         )
 
-        r = session.post(
-            url=f"{self.server_url}/objects/{self.stream_id}",
-            files={"batch-1": ("batch-1", upload_data_gzip, "application/gzip")},
-        )
-        if r.status_code != 201:
-            LOG.warning("Upload server response: %s", r.text)
-            raise SpeckleException(
-                message=f"Could not save the object to the server - status code {r.status_code}"
+        try:
+            r = session.post(
+                url=f"{self.server_url}/objects/{self.stream_id}",
+                files={"batch-1": ("batch-1", upload_data_gzip, "application/gzip")},
+            )
+            if r.status_code != 201:
+                LOG.warning("Upload server response: %s", r.text)
+                raise SpeckleException(
+                    message=(
+                        "Could not save the object to the server - status code"
+                        f" {r.status_code}"
+                    )
+                )
+        except json.JSONDecodeError as error:
+            return SpeckleException(
+                f"Failed to send objects to {self.server_url}. Please ensure this"
+                f" stream ({self.stream_id}) exists on this server and that you have"
+                " permission to send to it.",
+                error,
             )
 
     def _create_threads(self):
-        for i in range(self.thread_count):
+        for _ in range(self.thread_count):
             t = threading.Thread(target=self._sending_thread_main, daemon=True)
             t.start()
             self._send_threads.append(t)
 
     def _delete_threads(self):
-        for i in range(len(self._send_threads)):
+        for _ in range(len(self._send_threads)):
             self._batches.put(None)
 
         for thread in self._send_threads:

src/specklepy/transports/server/server.py

@@ -0,0 +1,174 @@
+import json
+from typing import Any, Dict, List, Optional
+from warnings import warn
+
+import requests
+
+from specklepy.api.client import SpeckleClient
+from specklepy.api.credentials import Account, get_account_from_token
+from specklepy.logging.exceptions import SpeckleException, SpeckleWarning
+from specklepy.transports.abstract_transport import AbstractTransport
+
+from .batch_sender import BatchSender
+
+
+class ServerTransport(AbstractTransport):
+    """
+    The `ServerTransport` is the vehicle through which you transport objects to and
+    from a Speckle Server. Provide it to `operations.send()` or `operations.receive()`.
+
+    The `ServerTransport` can be authenticated two different ways:
+        1. by providing a `SpeckleClient`
+        2. by providing an `Account`
+        3. by providing a `token` and `url`
+
+    ```py
+    from specklepy.api import operations
+    from specklepy.transports.server import ServerTransport
+
+    # here's the data you want to send
+    block = Block(length=2, height=4)
+
+    # next create the server transport - this is the vehicle through which
+    # you will send and receive
+    transport = ServerTransport(stream_id=new_stream_id, client=client)
+
+    # this serialises the block and sends it to the transport
+    hash = operations.send(base=block, transports=[transport])
+
+    # you can now create a commit on your stream with this object
+    commit_id = client.commit.create(
+        stream_id=new_stream_id,
+        obj_id=hash,
+        message="this is a block I made in speckle-py",
+    )
+    ```
+    """
+
+    _name = "RemoteTransport"
+    url: Optional[str] = None
+    stream_id: Optional[str] = None
+    account: Optional[Account] = None
+    saved_obj_count: int = 0
+    session: Optional[requests.Session] = None
+
+    def __init__(
+        self,
+        stream_id: str,
+        client: Optional[SpeckleClient] = None,
+        account: Optional[Account] = None,
+        token: Optional[str] = None,
+        url: Optional[str] = None,
+        **data: Any,
+    ) -> None:
+        super().__init__(**data)
+        if client is None and account is None and token is None and url is None:
+            raise SpeckleException(
+                "You must provide either a client or a token and url to construct a"
+                " ServerTransport."
+            )
+
+        if account:
+            self.account = account
+            url = account.serverInfo.url
+        elif client:
+            url = client.url
+            if not client.account.token:
+                warn(
+                    SpeckleWarning(
+                        "Unauthenticated Speckle Client provided to Server Transport"
+                        f" for {self.url}. Receiving from private streams will fail."
+                    )
+                )
+            else:
+                self.account = client.account
+        else:
+            self.account = get_account_from_token(token, url)
+
+        self.stream_id = stream_id
+        self.url = url
+
+        self._batch_sender = BatchSender(
+            self.url, self.stream_id, self.account.token, max_batch_size_mb=1
+        )
+
+        self.session = requests.Session()
+        self.session.headers.update(
+            {"Authorization": f"Bearer {self.account.token}", "Accept": "text/plain"}
+        )
+
+    def begin_write(self) -> None:
+        self.saved_obj_count = 0
+
+    def end_write(self) -> None:
+        self._batch_sender.flush()
+
+    def save_object(self, id: str, serialized_object: str) -> None:
+        self._batch_sender.send_object(id, serialized_object)
+
+    def save_object_from_transport(
+        self, id: str, source_transport: AbstractTransport
+    ) -> None:
+        obj_string = source_transport.get_object(id=id)
+        self.save_object(id=id, serialized_object=obj_string)
+
+    def get_object(self, id: str) -> str:
+        # endpoint = f"{self.url}/objects/{self.stream_id}/{id}/single"
+        # r = self.session.get(endpoint, stream=True)
+
+        # _, obj = next(r.iter_lines().decode("utf-8")).split("\t")
+
+        # return obj
+
+        raise SpeckleException(
+            "Getting a single object using `ServerTransport.get_object()` is not"
+            " implemented. To get an object from the server, please use the"
+            " `SpeckleClient.object.get()` route",
+            NotImplementedError(),
+        )
+
+    def has_objects(self, id_list: List[str]) -> Dict[str, bool]:
+        return {id: False for id in id_list}
+
+    def copy_object_and_children(
+        self, id: str, target_transport: AbstractTransport
+    ) -> str:
+        endpoint = f"{self.url}/objects/{self.stream_id}/{id}/single"
+        r = self.session.get(endpoint)
+        r.encoding = "utf-8"
+
+        if r.status_code != 200:
+            raise SpeckleException(
+                f"Can't get object {self.stream_id}/{id}: HTTP error"
+                f" {r.status_code} ({r.text[:1000]})"
+            )
+        root_obj_serialized = r.text
+        root_obj = json.loads(root_obj_serialized)
+        closures = root_obj.get("__closure", {})
+
+        # Check which children are not already in the target transport
+        children_ids = list(closures.keys())
+        children_found_map = target_transport.has_objects(children_ids)
+        new_children_ids = [
+            id for id in children_found_map if not children_found_map[id]
+        ]
+
+        # Get the new children
+        endpoint = f"{self.url}/api/getobjects/{self.stream_id}"
+        r = self.session.post(
+            endpoint, data={"objects": json.dumps(new_children_ids)}, stream=True
+        )
+        r.encoding = "utf-8"
+        lines = r.iter_lines(decode_unicode=True)
+
+        # iter through returned objects saving them as we go
+        target_transport.begin_write()
+        for line in lines:
+            if line:
+                hash, obj = line.split("\t")
+                target_transport.save_object(hash, obj)
+
+        target_transport.save_object(id, root_obj_serialized)
+        target_transport.end_write()
+
+        return root_obj_serialized

src/specklepy/transports/sqlite.py

@@ -0,0 +1,201 @@
+import os
+import sqlite3
+from contextlib import closing
+from typing import Any, Dict, List, Optional, Tuple
+
+from specklepy.core.helpers import speckle_path_provider
+from specklepy.logging.exceptions import SpeckleException
+from specklepy.transports.abstract_transport import AbstractTransport
+
+
+class SQLiteTransport(AbstractTransport):
+    _name = "SQLite"
+    _base_path: Optional[str] = None
+    _root_path: Optional[str] = None
+    __connection: Optional[sqlite3.Connection] = None
+    app_name: str = ""
+    scope: str = ""
+    saved_obj_count: int = 0
+    max_size: Optional[int] = None
+    _current_batch: Optional[List[Tuple[str, str]]] = None
+    _current_batch_size: Optional[int] = None
+
+    def __init__(
+        self,
+        base_path: Optional[str] = None,
+        app_name: Optional[str] = None,
+        scope: Optional[str] = None,
+        max_batch_size_mb: float = 10.0,
+        **data: Any,
+    ) -> None:
+        super().__init__(**data)
+        self.app_name = app_name or "Speckle"
+        self.scope = scope or "Objects"
+        self._base_path = base_path or self.get_base_path(self.app_name)
+        self.max_size = int(max_batch_size_mb * 1000 * 1000)
+        self._current_batch = []
+        self._current_batch_size = 0
+
+        try:
+            os.makedirs(self._base_path, exist_ok=True)
+
+            self._root_path = os.path.join(
+                os.path.join(self._base_path, f"{self.scope}.db")
+            )
+            self.__initialise()
+        except Exception as ex:
+            raise SpeckleException(
+                f"SQLiteTransport could not initialise {self.scope}.db at"
+                f" {self._base_path}. Either provide a different `base_path` or use an"
+                " alternative transport.",
+                ex,
+            )
+
+    def __repr__(self) -> str:
+        return f"SQLiteTransport(app: '{self.app_name}', scope: '{self.scope}')"
+
+    @staticmethod
+    def get_base_path(app_name):
+        # # from appdirs https://github.com/ActiveState/appdirs/blob/master/appdirs.py
+        # # default mac path is not the one we use (we use unix path), so using special case for this
+        # system = sys.platform
+        # if system.startswith("java"):
+        #     import platform
+
+        #     os_name = platform.java_ver()[3][0]
+        #     if os_name.startswith("Mac"):
+        #         system = "darwin"
+
+        # if system != "darwin":
+        #     return user_data_dir(appname=app_name, appauthor=False, roaming=True)
+
+        # path = os.path.expanduser("~/.config/")
+        # return os.path.join(path, app_name)
+
+        return str(
+            speckle_path_provider.user_application_data_path().joinpath(app_name)
+        )
+
+    def save_object_from_transport(
+        self, id: str, source_transport: AbstractTransport
+    ) -> None:
+        """Adds an object from the given transport to the the local db
+
+        Arguments:
+            id {str} -- the object id
+            source_transport {AbstractTransport)
+            -- the transport through which the object can be found
+        """
+        serialized_object = source_transport.get_object(id)
+        self.save_object(id, serialized_object)
+
+    def save_object(self, id: str, serialized_object: str) -> None:
+        """
+        Adds an object to the current batch to be written to the db.
+        If the current batch is full,
+        the batch is written to the db and the current batch is reset.
+
+        Arguments:
+            id {str} -- the object id
+            serialized_object {str} -- the full string representation of the object
+        """
+        obj_size = len(serialized_object)
+        if (
+            not self._current_batch
+            or self._current_batch_size + obj_size < self.max_size
+        ):
+            self._current_batch.append((id, serialized_object))
+            self._current_batch_size += obj_size
+            return
+
+        self.save_current_batch()
+        self._current_batch = [(id, serialized_object)]
+        self._current_batch_size = obj_size
+
+    def save_current_batch(self) -> None:
+        """Save the current batch of objects to the local db"""
+        self.__check_connection()
+        try:
+            with closing(self.__connection.cursor()) as c:
+                c.executemany(
+                    "INSERT OR IGNORE INTO objects(hash, content) VALUES(?,?)",
+                    self._current_batch,
+                )
+                self.__connection.commit()
+        except Exception as ex:
+            raise SpeckleException(
+                "Could not save the batch of objects to the local db. Inner exception:"
+                f" {ex}",
+                ex,
+            )
+
+    def get_object(self, id: str) -> str or None:
+        self.__check_connection()
+        with closing(self.__connection.cursor()) as c:
+            row = c.execute(
+                "SELECT * FROM objects WHERE hash = ? LIMIT 1", (id,)
+            ).fetchone()
+        return row[1] if row else None
+
+    def has_objects(self, id_list: List[str]) -> Dict[str, bool]:
+        ret = {}
+        self.__check_connection()
+        with closing(self.__connection.cursor()) as c:
+            for id in id_list:
+                row = c.execute(
+                    "SELECT 1 FROM objects WHERE hash = ? LIMIT 1", (id,)
+                ).fetchone()
+                ret[id] = bool(row)
+        return ret
+
+    def begin_write(self):
+        self._object_cache = []
+        self.saved_obj_count = 0
+
+    def end_write(self):
+        if self._current_batch:
+            self.save_current_batch()
+        self._current_batch = []
+        self._current_batch_size = 0
+
+    def copy_object_and_children(
+        self, id: str, target_transport: AbstractTransport
+    ) -> str:
+        raise NotImplementedError
+
+    def get_all_objects(self):
+        """
+        Returns all the objects in the store.
+        NOTE: do not use for large collections!
+        """
+        self.__check_connection()
+        with closing(self.__connection.cursor()) as c:
+            rows = c.execute("SELECT * FROM objects").fetchall()
+        return rows
+
+    def close(self):
+        """Close the connection to the database"""
+        if self.__connection:
+            self.__connection.close()
+            self.__connection = None
+
+    def __initialise(self) -> None:
+        self.__connection = sqlite3.connect(self._root_path)
+        with closing(self.__connection.cursor()) as c:
+            c.execute(
+                """ CREATE TABLE IF NOT EXISTS objects(
+                      hash TEXT PRIMARY KEY,
+                      content TEXT
+                    ) WITHOUT ROWID;"""
+            )
+            c.execute("PRAGMA journal_mode='wal';")
+            c.execute("PRAGMA count_changes=OFF;")
+            c.execute("PRAGMA temp_store=MEMORY;")
+            self.__connection.commit()
+
+    def __check_connection(self):
+        if not self.__connection:
+            self.__connection = sqlite3.connect(self._root_path)
+
+    def __del__(self):
+        self.close()

tests/conftest.py

@@ -1,97 +1,8 @@
-import uuid
 import random
+
 import pytest
-import requests
-from specklepy.api.models import Stream
-from specklepy.api.client import SpeckleClient
+
 from specklepy.objects.base import Base
-from specklepy.objects.geometry import Point
-from specklepy.objects.fakemesh import FakeMesh
-
-
-@pytest.fixture(scope="session")
-def host():
-    return "localhost:3000"
-
-
-def seed_user(host):
-    seed = uuid.uuid4().hex
-    user_dict = {
-        "email": f"{seed[0:7]}@spockle.com",
-        "password": "$uper$3cr3tP@ss",
-        "name": f"{seed[0:7]} Name",
-        "company": "test spockle",
-    }
-
-    r = requests.post(
-        url=f"http://{host}/auth/local/register?challenge=pyspeckletests",
-        data=user_dict,
-    )
-    print(r.url)
-    access_code = r.url.split("access_code=")[1]
-
-    r_tokens = requests.post(
-        url=f"http://{host}/auth/token",
-        json={
-            "appSecret": "spklwebapp",
-            "appId": "spklwebapp",
-            "accessCode": access_code,
-            "challenge": "pyspeckletests",
-        },
-    )
-
-    user_dict.update(**r_tokens.json())
-
-    return user_dict
-
-
-@pytest.fixture(scope="session")
-def user_dict(host):
-    return seed_user(host)
-
-
-@pytest.fixture(scope="session")
-def second_user_dict(host):
-    return seed_user(host)
-
-
-@pytest.fixture(scope="session")
-def client(host, user_dict):
-    client = SpeckleClient(host=host, use_ssl=False)
-    client.authenticate(user_dict["token"])
-    return client
-
-
-@pytest.fixture(scope="session")
-def sample_stream(client):
-    stream = Stream(
-        name="a sample stream for testing",
-        description="a stream created for testing",
-        isPublic=True,
-    )
-    stream.id = client.stream.create(stream.name, stream.description, stream.isPublic)
-    return stream
-
-
-@pytest.fixture(scope="session")
-def mesh():
-    mesh = FakeMesh()
-    mesh.name = "my_mesh"
-    mesh.vertices = [random.uniform(0, 10) for _ in range(1, 210)]
-    mesh.faces = [i for i in range(1, 210)]
-    mesh["@(100)colours"] = [random.uniform(0, 10) for _ in range(1, 210)]
-    mesh["@()default_chunk"] = [random.uniform(0, 10) for _ in range(1, 210)]
-    mesh.test_bases = [Base(name=f"test {i}") for i in range(1, 22)]
-    mesh.detach_this = Base(name="predefined detached base")
-    mesh["@detach"] = Base(name="detached base")
-    mesh["@detached_list"] = [
-        42,
-        "some text",
-        [1, 2, 3],
-        Base(name="detached within a list"),
-    ]
-    mesh.origin = Point(value=[4, 2, 0])
-    return mesh
 
 
 @pytest.fixture(scope="session")
@@ -99,7 +10,12 @@ def base():
     base = Base()
     base.name = "my_base"
     base.units = "millimetres"
+    base.null_val = None
+    base.null_dict = {"a null val": None}
+    base.tuple = (1, 2, "3")
+    base.set = {1, 2, "3"}
     base.vertices = [random.uniform(0, 10) for _ in range(1, 120)]
     base.test_bases = [Base(name=i) for i in range(1, 22)]
     base["@detach"] = Base(name="detached base")
+    base["@revit_thing"] = Base.of_type("SpecialRevitFamily", name="secret tho")
     return base

tests/intergration/conftest.py

@@ -0,0 +1,112 @@
+import random
+import uuid
+
+import pytest
+import requests
+
+from specklepy.api.client import SpeckleClient
+from specklepy.api.models import Stream
+from specklepy.logging import metrics
+from specklepy.objects.base import Base
+from specklepy.objects.fakemesh import FakeDirection, FakeMesh
+from specklepy.objects.geometry import Point
+
+metrics.disable()
+
+
+@pytest.fixture(scope="session")
+def host():
+    return "localhost:3000"
+
+
+def seed_user(host):
+    seed = uuid.uuid4().hex
+    user_dict = {
+        "email": f"{seed[0:7]}@spockle.com",
+        "password": "$uper$3cr3tP@ss",
+        "name": f"{seed[0:7]} Name",
+        "company": "test spockle",
+    }
+
+    r = requests.post(
+        url=f"http://{host}/auth/local/register?challenge=pyspeckletests",
+        data=user_dict,
+        # do not follow redirects here, they lead to the frontend, which might not be
+        # running in a test environment
+        # causing the response to not be OK in the end
+        allow_redirects=False,
+    )
+    if not r.ok:
+        raise Exception(f"Cannot seed user: {r.reason}")
+    access_code = r.text.split("access_code=")[1]
+
+    r_tokens = requests.post(
+        url=f"http://{host}/auth/token",
+        json={
+            "appSecret": "spklwebapp",
+            "appId": "spklwebapp",
+            "accessCode": access_code,
+            "challenge": "pyspeckletests",
+        },
+    )
+
+    user_dict.update(**r_tokens.json())
+
+    return user_dict
+
+
+@pytest.fixture(scope="session")
+def user_dict(host):
+    return seed_user(host)
+
+
+@pytest.fixture(scope="session")
+def second_user_dict(host):
+    return seed_user(host)
+
+
+@pytest.fixture(scope="session")
+def client(host, user_dict):
+    client = SpeckleClient(host=host, use_ssl=False)
+    client.authenticate_with_token(user_dict["token"])
+    return client
+
+
+@pytest.fixture(scope="session")
+def second_client(host, second_user_dict):
+    client = SpeckleClient(host=host, use_ssl=False)
+    client.authenticate_with_token(second_user_dict["token"])
+    return client
+
+
+@pytest.fixture(scope="session")
+def sample_stream(client):
+    stream = Stream(
+        name="a sample stream for testing",
+        description="a stream created for testing",
+        isPublic=True,
+    )
+    stream.id = client.stream.create(stream.name, stream.description, stream.isPublic)
+    return stream
+
+
+@pytest.fixture(scope="session")
+def mesh():
+    mesh = FakeMesh()
+    mesh.name = "my_mesh"
+    mesh.vertices = [random.uniform(0, 10) for _ in range(1, 210)]
+    mesh.faces = list(range(1, 210))
+    mesh["@(100)colours"] = [random.uniform(0, 10) for _ in range(1, 210)]
+    mesh["@()default_chunk"] = [random.uniform(0, 10) for _ in range(1, 210)]
+    mesh.cardinal_dir = FakeDirection.WEST
+    mesh.test_bases = [Base(name=f"test {i}") for i in range(1, 22)]
+    mesh.detach_this = Base(name="predefined detached base")
+    mesh["@detach"] = Base(name="detached base")
+    mesh["@detached_list"] = [
+        42,
+        "some text",
+        [1, 2, 3],
+        Base(name="detached within a list"),
+    ]
+    mesh.origin = Point(x=4, y=2)
+    return mesh

tests/intergration/test_active_user.py

@@ -0,0 +1,46 @@
+import pytest
+
+from specklepy.api.client import SpeckleClient
+from specklepy.api.models import Activity, ActivityCollection, User
+from specklepy.logging.exceptions import SpeckleException
+
+
+@pytest.mark.run(order=2)
+class TestUser:
+    def test_user_get_self(self, client: SpeckleClient, user_dict):
+        fetched_user = client.active_user.get()
+
+        assert isinstance(fetched_user, User)
+        assert fetched_user.name == user_dict["name"]
+        assert fetched_user.email == user_dict["email"]
+
+        user_dict["id"] = fetched_user.id
+
+    def test_user_update(self, client: SpeckleClient):
+        bio = "i am a ghost in the machine"
+
+        failed_update = client.active_user.update()
+        assert isinstance(failed_update, SpeckleException)
+
+        updated = client.active_user.update(bio=bio)
+
+        me = client.active_user.get()
+
+        assert updated is True
+        assert me.bio == bio
+
+    def test_user_activity(self, client: SpeckleClient, second_user_dict):
+        my_activity = client.active_user.activity(limit=10)
+        their_activity = client.other_user.activity(second_user_dict["id"])
+
+        assert isinstance(my_activity, ActivityCollection)
+        assert my_activity.items
+        assert isinstance(my_activity.items[0], Activity)
+        assert my_activity.totalCount
+        assert isinstance(their_activity, ActivityCollection)
+
+        older_activity = client.user.activity(before=my_activity.items[0].time)
+
+        assert isinstance(older_activity, ActivityCollection)
+        assert older_activity.totalCount
+        assert older_activity.totalCount < my_activity.totalCount

tests/intergration/test_branch.py

@@ -1,7 +1,8 @@
 import pytest
+
 from specklepy.api import operations
-from specklepy.transports.server import ServerTransport
 from specklepy.api.models import Branch, Commit, Stream
+from specklepy.transports.server import ServerTransport
 
 
 class TestBranch:
@@ -58,7 +59,7 @@ class TestBranch:
         assert isinstance(branches, list)
         assert len(branches) == 2
         assert isinstance(branches[0], Branch)
-        assert branches[0].name == branch.name
+        assert branches[1].name == branch.name
 
     def test_branch_update(self, client, stream, branch, updated_branch):
         updated = client.branch.update(

tests/intergration/test_client_and_ops.py

@@ -0,0 +1,58 @@
+from tempfile import gettempdir
+
+import pytest
+
+from specklepy.api import operations
+from specklepy.api.client import SpeckleClient
+from specklepy.api.credentials import Account, get_account_from_token
+from specklepy.core.helpers import speckle_path_provider
+from specklepy.logging.exceptions import SpeckleException, SpeckleWarning
+from specklepy.objects.base import Base
+from specklepy.transports.server import ServerTransport
+
+
+def test_invalid_authentication():
+    # overriding the appdata path (it would be enough to just override the Accounts)
+    # but this way its cleaner
+    speckle_path_provider.override_application_data_path(gettempdir())
+    client = SpeckleClient()
+
+    with pytest.warns(SpeckleWarning):
+        client.authenticate_with_token("fake token")
+
+    # remove path override
+    speckle_path_provider.override_application_data_path(None)
+
+
+def test_invalid_send():
+    client = SpeckleClient()
+    client.account = Account(token="fake_token")
+    transport = ServerTransport("3073b96e86", client)
+
+    with pytest.raises(SpeckleException):
+        operations.send(Base(), [transport])
+
+
+def test_invalid_receive():
+    client = SpeckleClient()
+    client.account = Account(token="fake_token")
+    transport = ServerTransport("fake stream", client)
+
+    with pytest.raises(SpeckleException):
+        operations.receive("fake object", transport)
+
+
+def test_account_from_token():
+    token = "fake token"
+    acct = get_account_from_token(token)
+
+    assert acct.token == token
+
+
+def test_account_from_token_and_url():
+    token = "fake token"
+    url = "fake.server"
+    acct = get_account_from_token(token, url)
+
+    assert acct.token == token
+    assert acct.serverInfo.url == url

tests/intergration/test_commit.py

@@ -1,10 +1,11 @@
 import pytest
+
 from specklepy.api import operations
 from specklepy.api.models import Commit, Stream
 from specklepy.transports.server.server import ServerTransport
 
 
-@pytest.mark.run(order=4)
+@pytest.mark.run(order=6)
 class TestCommit:
     @pytest.fixture(scope="module")
     def commit(self):
@@ -68,3 +69,20 @@ class TestCommit:
         deleted = client.commit.delete(stream_id=stream.id, commit_id=commit_id)
 
         assert deleted is True
+
+    def test_commit_marked_as_received(self, client, stream, mesh) -> None:
+        commit = Commit(message="this commit should be received")
+        commit.id = client.commit.create(
+            stream_id=stream.id,
+            object_id=mesh.id,
+            message=commit.message,
+        )
+
+        commit_marked_received = client.commit.received(
+            stream.id,
+            commit.id,
+            source_application="pytest",
+            message="testing received",
+        )
+
+        assert commit_marked_received is True

tests/intergration/test_objects.py

@@ -1,9 +1,11 @@
-from specklepy.objects import Base
-from specklepy.transports.memory import MemoryTransport
-from specklepy.api.models import Stream
-from specklepy.serialization.base_object_serializer import BaseObjectSerializer
 import pytest
 
+from specklepy.api.models import Stream
+from specklepy.objects import Base
+from specklepy.objects.encoding import ObjectArray
+from specklepy.serialization.base_object_serializer import BaseObjectSerializer
+from specklepy.transports.sqlite import SQLiteTransport
+
 
 class TestObject:
     @pytest.fixture(scope="module")
@@ -19,12 +21,13 @@ class TestObject:
         return stream
 
     def test_object_create(self, client, stream, base):
-        transport = MemoryTransport()
+        transport = SQLiteTransport()
         s = BaseObjectSerializer(write_transports=[transport], read_transport=transport)
         _, base_dict = s.traverse_base(base)
         obj_id = client.object.create(stream_id=stream.id, objects=[base_dict])[0]
 
         assert isinstance(obj_id, str)
+        assert base_dict["@detach"]["speckle_type"] == "reference"
         assert obj_id == base.get_id(True)
 
     def test_object_get(self, client, stream, base):
@@ -35,4 +38,10 @@ class TestObject:
         assert isinstance(fetched_base, Base)
         assert fetched_base.name == base.name
         assert isinstance(fetched_base.vertices, list)
-        assert fetched_base["@detach"]["speckle_type"] == "reference"
+        # assert fetched_base["@detach"]["speckle_type"] == "reference"
+
+    def test_object_array_decoder(self):
+        array = ObjectArray()
+        array.data = [5, 1, 1, 1, 1, 1, 4, 1, 1, 1, 1, 3, 1, 1, 1, 2, 1, 1, 1, 1]
+
+        assert array.decode(decoder=sum) == [5, 4, 3, 2, 1]