feat(objects): revit params in objects for blender (#179)

* feat(models): `ActivityCollection` and `Activity`

* feat(client): stream activity method

* test(client): test for stream activity

* refactor(client): use datetime args for activity

* docs(client): clean up stream activity docstring

* feat/test(client): user activity

.circleci/config.yml

@@ -0,0 +1,78 @@
+version: 2.1
+
+orbs:
+  python: circleci/python@1.3.2
+  codecov: codecov/codecov@3.2.2
+
+jobs:
+  test:
+    docker:
+      - image: "cimg/python:<<parameters.tag>>"
+      - image: 'cimg/node:14.18'
+      - image: 'circleci/redis:6'
+      - image: 'cimg/postgres:12.8'
+        environment:
+          POSTGRES_DB: speckle2_test
+          POSTGRES_PASSWORD: speckle
+          POSTGRES_USER: speckle
+      - image: "speckle/speckle-server"
+        command: ["bash", "-c", "/wait && node bin/www"]
+        environment:
+          POSTGRES_URL: "localhost"
+          POSTGRES_USER: "speckle"
+          POSTGRES_PASSWORD: "speckle"
+          POSTGRES_DB: "speckle2_test"
+          REDIS_URL: "redis://localhost"
+          SESSION_SECRET: "keyboard cat"
+          STRATEGY_LOCAL: "true"
+          CANONICAL_URL: "http://localhost:3000"
+          WAIT_HOSTS: localhost:5432, localhost:6379
+    parameters:
+      tag:
+        default: "3.8"
+        type: string
+    steps:
+      - checkout
+      - run: python --version
+      - run:
+          command: python -m pip install --upgrade pip
+          name: upgrade pip
+      - python/install-packages:
+          pkg-manager: poetry
+      - run: poetry run pytest --cov --cov-report xml:reports/coverage.xml --junitxml=reports/test-results.xml
+
+      - store_test_results:
+          path: reports
+
+      - store_artifacts:
+          path: reports
+
+      - codecov/upload
+
+  deploy:
+    docker:
+      - image: "circleci/python:3.8"
+    steps:
+      - checkout
+      - run: python patch_version.py $CIRCLE_TAG
+      - run: poetry build
+      - run: poetry publish -u specklesystems -p $PYPI_PASSWORD
+
+workflows:
+  main:
+    jobs: 
+      - test:
+          matrix:
+            parameters:
+              tag: ["3.6", "3.7", "3.8", "3.9"]
+          filters:
+            tags:
+              only: /.*/
+      - deploy:
+          requires:
+            - test 
+          filters:
+            tags:
+              only: /[0-9]+(\.[0-9]+)*/
+            branches:
+              ignore: /.*/ # For testing only! /ci\/.*/

.devcontainer/Dockerfile

@@ -0,0 +1,27 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.191.1/containers/python-3/.devcontainer/base.Dockerfile
+
+# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6
+ARG VARIANT="3.9"
+FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image.
+# COPY requirements.txt /tmp/pip-tmp/
+# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \
+#    && rm -rf /tmp/pip-tmp
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1
+
+USER vscode
+
+RUN curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
+
+ENV PATH=$PATH:$HOME/.poetry/env

.devcontainer/devcontainer.json

@@ -0,0 +1,52 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.191.1/containers/python-3
+{
+	"name": "Python 3",
+	// "build": {
+	// 	"dockerfile": "Dockerfile",
+	// 	"context": "..",
+	// 	"args": {
+	// 		// Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9
+	// 		"VARIANT": "3.6",
+	// 		// Options
+	// 		"NODE_VERSION": "lts/*"
+	// 	}
+	// },
+	"dockerComposeFile": "./docker-compose.yaml",
+	"service": "specklepy",
+	"workspaceFolder": "/workspaces/specklepy",
+	"shutdownAction": "stopCompose",
+	// Set *default* container specific settings.json values on container create.
+	"settings": {
+		"python.pythonPath": "/usr/local/bin/python",
+		"python.languageServer": "Pylance",
+		"python.linting.enabled": true,
+		"python.linting.pylintEnabled": true,
+		"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+		"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+		"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+		"python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+		"python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+		"python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+		"python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+		"python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+		"python.linting.pylintPath": "/usr/local/py-utils/bin/pylint",
+		"python.testing.pytestArgs": [
+			"tests/",
+			"-s"
+		],
+		"python.testing.pytestEnabled": true,
+		"editor.formatOnSave": true,
+	},
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"ms-python.python",
+		"ms-python.vscode-pylance"
+	],
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "poetry config virtualenvs.create false && poetry install",
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+}

.devcontainer/docker-compose.yaml

@@ -0,0 +1,49 @@
+version: "3.3"  # optional since v1.27.0
+services:
+  postgres:
+    image: circleci/postgres:12
+    environment:
+      POSTGRES_DB: speckle2_test
+      POSTGRES_PASSWORD: speckle
+      POSTGRES_USER: speckle
+      # ports:
+      #   - "5432:5432"
+    network_mode: host
+  redis:
+    image: circleci/redis:6
+    # ports:
+    #   - "6379:6379"
+    network_mode: host
+  speckle-server:
+    image: speckle/speckle-server
+    command: ["bash", "-c", "/wait && node bin/www"]
+    environment:
+      POSTGRES_URL: "localhost"
+      POSTGRES_USER: "speckle"
+      POSTGRES_PASSWORD: "speckle"
+      POSTGRES_DB: "speckle2_test"
+      REDIS_URL: "redis://localhost"
+      SESSION_SECRET: "keyboard cat"
+      STRATEGY_LOCAL: "true"
+      CANONICAL_URL: "http://localhost:3000"
+      WAIT_HOSTS: localhost:5432, localhost:6379
+    # ports:
+    #   - "3000:3000"
+    network_mode: host
+
+  specklepy:
+    build:
+      dockerfile: Dockerfile
+      context: .
+      args:
+        VARIANT: 3.9
+        NODE_VERSION: lts/*
+    volumes:
+      # Mounts the project folder to '/workspace'. While this file is in .devcontainer,
+      # mounts are relative to the first file in the list, which is a level up.
+      - ..:/workspaces/specklepy:cached
+    # Overrides default command so things don't shut down after the process ends.
+    command: /bin/sh -c "while sleep 1000; do :; done"
+    network_mode: host
+# networks:
+#     default:

.gitattributes

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

.github/CONTRIBUTING.md

@@ -1,4 +1,5 @@
 # Speckle Contribution Guidelines
+
 ## Introduction
 
 Thank you for reading this! Speckle's a rather wide network of parts that depend on each other, either directly, indirectly or even just cosmetically.
@@ -9,41 +10,41 @@ This means that what might look like a simple quick change in one repo may have
 
 ## Bugs & Issues 🐞
 
-### Found a new bug? 
+### Found a new bug?
 
 - First step is to check whether this is a new bug! We encourage you to search through the issues of the project in question **and** associated repos!
 
-- If you come up with nothing, **open a new issue with a clear title and description**, as much relevant information as possible: system configuration, code samples & steps to reproduce the problem. 
+- If you come up with nothing, **open a new issue with a clear title and description**, as much relevant information as possible: system configuration, code samples & steps to reproduce the problem.
 
-- Can't mention this often enough: tells us how to reproduce the problem! We will ignore or flag as such issues without reproduction steps. 
+- Can't mention this often enough: tells us how to reproduce the problem! We will ignore or flag as such issues without reproduction steps.
 
 - Try to reference & note all potentially affected projects.
 
 ### Sending a PR for Bug Fixes
 
-You fixed something! Great! We hope you logged it first :) Make sure though that you've covered the lateral thinking needed for a bug report, as described above, also in your implementation! If there any tests, make sure they all pass. If there are none, it means they're missing - so add them! 
+You fixed something! Great! We hope you logged it first :) Make sure though that you've covered the lateral thinking needed for a bug report, as described above, also in your implementation! If there any tests, make sure they all pass. If there are none, it means they're missing - so add them!
 
 ## New Features 🎉
 
 The golden rule is to Discuss First!
 
 - Before embarking on adding a new feature, suggest it first as an issue with the `enhancement` label and/or title - this will allow relevant people to pitch in
-- We'll now discuss your requirements and see how and if they fit within the Speckle ecosystem. 
-- The last step is to actually start writing code & submit a PR so we can follow along! 
-- All new features should, if and where possible, come with tests. We won't merge without! 
+- We'll now discuss your requirements and see how and if they fit within the Speckle ecosystem.
+- The last step is to actually start writing code & submit a PR so we can follow along!
+- All new features should, if and where possible, come with tests. We won't merge without!
 
 > Many clients may potentially have overlapping scopes, some features might already be in dev somewhere else, or might have been postponed to the next major release due to api instability in that area. For example, adding a delete stream button in the accounts panel in rhino: this feature was planned for speckle admin, and the whole functionality of the accounts panel in rhino is to be greatly reduced!
 
 ## Cosmetic Patches ✨
 
-Changes that are cosmetic in nature and do not add anything substantial to the stability or functionality of Speckle **will generally not be accepted**. 
+Changes that are cosmetic in nature and do not add anything substantial to the stability or functionality of Speckle **will generally not be accepted**.
 
 Why? However trivial the changes might seem, there might be subtle reasons for the original code to be as it is. Furthermore, there are a lot of potential hidden costs (that even maintainers themselves are not aware of fully!) and they eat up review time unncessarily.
 
-> **Examples**: modifying the colour of an UI element in one client may have a big hidden cost and need propagation in several other clients that implement a similar ui element. Changing the default port or specifiying `localhost` instead of `0.0.0.0` breaks cross-vm debugging and developing. 
-
+> **Examples**: modifying the colour of an UI element in one client may have a big hidden cost and need propagation in several other clients that implement a similar ui element. Changing the default port or specifiying `localhost` instead of `0.0.0.0` breaks cross-vm debugging and developing.
 
 ## Wrap up
-Don't worry if you get things wrong. We all do, including project owners: this document should've been here a long time ago. There's plenty of room for discussion either on our community [forum](https://discourse.speckle.works) or [chat](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI).
+
+Don't worry if you get things wrong. We all do, including project owners: this document should've been here a long time ago. There's plenty of room for discussion on our community [forum](https://discourse.speckle.works).
 
 🙌❤️💙💚💜🙌

.github/workflows/close-issue.yml

@@ -0,0 +1,78 @@
+name: Update issue Status
+
+on:
+  issues:
+    types: [closed]
+
+jobs:
+  update_issue:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get project data
+        env:
+          GITHUB_TOKEN: ${{secrets.GHPROJECT_TOKEN}}
+          ORGANIZATION: specklesystems
+          PROJECT_NUMBER: 9
+        run: |
+          gh api graphql --header 'GraphQL-Features: projects_next_graphql' -f query='
+            query($org: String!, $number: Int!) {
+              organization(login: $org){
+                projectNext(number: $number) {
+                  id
+                  fields(first:20) {
+                    nodes {
+                      id
+                      name
+                      settings
+                    }
+                  }
+                }
+              }
+            }' -f org=$ORGANIZATION -F number=$PROJECT_NUMBER > project_data.json
+
+          echo 'PROJECT_ID='$(jq '.data.organization.projectNext.id' project_data.json) >> $GITHUB_ENV
+          echo 'STATUS_FIELD_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Status") | .id' project_data.json) >> $GITHUB_ENV
+          
+          echo "$PROJECT_ID"
+          echo "$STATUS_FIELD_ID"
+          
+          echo 'DONE_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Status") | .settings | fromjson | .options[] | select(.name== "Done") | .id' project_data.json) >> $GITHUB_ENV
+          echo "$DONE_ID"
+
+      - name: Add Issue to project #it's already in the project, but we do this to get its node id!
+        env:
+          GITHUB_TOKEN: ${{secrets.GHPROJECT_TOKEN}}
+          ISSUE_ID: ${{ github.event.issue.node_id }}
+        run: |
+          item_id="$( gh api graphql --header 'GraphQL-Features: projects_next_graphql' -f query='
+            mutation($project:ID!, $id:ID!) {
+              addProjectNextItem(input: {projectId: $project, contentId: $id}) {
+                projectNextItem {
+                  id
+                }
+              }
+            }' -f project=$PROJECT_ID -f id=$ISSUE_ID --jq '.data.addProjectNextItem.projectNextItem.id')"
+          
+          echo 'ITEM_ID='$item_id >> $GITHUB_ENV
+          
+      - name: Update Status
+        env:
+          GITHUB_TOKEN: ${{secrets.GHPROJECT_TOKEN}}
+          ISSUE_ID: ${{ github.event.issue.node_id }}
+        run: |
+          gh api graphql --header 'GraphQL-Features: projects_next_graphql' -f query='
+            mutation($project:ID!, $status:ID!, $id:ID!, $value:String!) {
+              set_status: updateProjectNextItemField(
+                input: {
+                  projectId: $project
+                  itemId: $id
+                  fieldId: $status
+                  value: $value
+                }
+              ) {
+                projectNextItem {
+                  id
+                }
+              }
+            }' -f project=$PROJECT_ID -f status=$STATUS_FIELD_ID -f id=$ITEM_ID -f value=${{ env.DONE_ID }}
+          

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

.vscode/launch.json

@@ -11,6 +11,12 @@
       "program": "${file}",
       "console": "integratedTerminal",
       "justMyCode": false
+    },
+    {
+      "name": "Python: Test debug config",
+      "type": "python",
+      "request": "test",
+      "console": "integratedTerminal",
     }
   ]
 }

README.md

@@ -1,22 +1,76 @@
-# 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) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works)
-[![Slack Invite](https://img.shields.io/badge/-slack-grey?style=flat-square&logo=slack)](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI) [![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems)
+<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)
+
+### Features
+
+- **Object-based:** say goodbye to files! Speckle is the first object based platform for the AEC industry
+- **Version control:** Speckle is the Git & Hub for geometry and BIM data
+- **Collaboration:** share your designs collaborate with others
+- **3D Viewer:** see your CAD and BIM models online, share and embed them anywhere
+- **Interoperability:** get your CAD and BIM models into other software without exporting or importing
+- **Real time:** get real time updates and notifications and changes
+- **GraphQL API:** get what you need anywhere you want it
+- **Webhooks:** the base for a automation and next-gen pipelines
+- **Built for developers:** we are building Speckle with developers in mind and got tools for every stack
+- **Built for the AEC industry:** Speckle connectors are plugins for the most common software used in the industry such as Revit, Rhino, Grasshopper, AutoCAD, Civil 3D, Excel, Unreal Engine, Unity, QGIS, Blender and more!
+
+### Try Speckle now!
+
+Give Speckle a try in no time by:
+
+- [![speckle XYZ](https://img.shields.io/badge/https://-speckle.xyz-0069ff?style=flat-square&logo=hackthebox&logoColor=white)](https://speckle.xyz) ⇒ creating an account at our public server
+- [![create a droplet](https://img.shields.io/badge/Create%20a%20Droplet-0069ff?style=flat-square&logo=digitalocean&logoColor=white)](https://marketplace.digitalocean.com/apps/speckle-server?refcode=947a2b5d7dc1) ⇒ deploying an instance in 1 click 
+
+### Resources
+
+- [![Community forum users](https://img.shields.io/badge/community-forum-green?style=for-the-badge&logo=discourse&logoColor=white)](https://speckle.community) for help, feature requests or just to hang with other speckle enthusiasts, check out our community forum!
+- [![website](https://img.shields.io/badge/tutorials-speckle.systems-royalblue?style=for-the-badge&logo=youtube)](https://speckle.systems) our tutorials portal is full of resources to get you started using Speckle
+- [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=for-the-badge&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) reference on almost any end-user and developer functionality
+
+
+# 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
 
-To get started, create a virtual environment and pip install the requirements. 
+### Installation
 
-on windows:
-```
-python -m venv venv
-venv\Scripts\activate
-pip install -r requirements.txt
-```
+This project uses python-poetry for dependency management, make sure you follow the official [docs](https://python-poetry.org/docs/#installation) to get poetry.
+
+To bootstrap the project environment run `$ poetry install`. This will create a new virtual-env for the project and install both the package and dev dependencies.
+
+If this is your first time using poetry and you're used to creating your venvs within the project directory, run `poetry config virtualenvs.in-project true` to configure poetry to do the same.
+
+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.
+
+### Local Data Paths
+
+It may be helpful to know where the local accounts and object cache dbs are stored. Depending on on your OS, you can find the dbs at:
+- Windows: `APPDATA` or `<USER>\AppData\Roaming\Speckle`
+- Linux: `$XDG_DATA_HOME` or by default `~/.local/share/Speckle`
+- Mac: `~/.config/Speckle`
 
 ## Contributing
 
@@ -24,12 +78,11 @@ Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md)
 
 ## Community
 
-The Speckle Community hangs out in two main places, usually:
+The Speckle Community hangs out on [the forum](https://discourse.speckle.works), do join and introduce yourself & feel free to ask us questions!
 
-- on [the forum](https://discourse.speckle.works)
-- on [the chat](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI)
+## Security
 
-Do join and introduce yourself!
+For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems. 
 
 ## License
 

example/using_speckle_base.py

@@ -0,0 +1,59 @@
+"""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
+
+
+class ExampleSub(Base):
+    """
+    Inheriting from `Base` is done with in the standard way by default.
+
+    The syntax is similar to the stdlib dataclass syntax.
+    No __init__ method definition is required, that is done automatically by the base
+    type. Also the attributes defined this way are instance attributes despite they
+    might look like class attributes.
+
+    The speckle Base uses the pydantic BaseModel in the background, but ideally that
+    is not the consumers concern.
+
+    **Important note:** currently the way how serialization works, requires
+    each attribute to have a valid default value, just like `foo` has. This includes
+    default values for all primitives and complex datastructures.
+    Failing to provide a default, breaks the receiving end of the transport.
+    """
+
+    foo: str = "bar"
+
+
+class SpeckleSub(ExampleSub, speckle_type="custom_speckle_sub"):
+    """
+    Example custom type name registration.
+
+    This is an optional feature.
+    The default value of the speckle_type is generated from the name of the class, but
+    optionally it may be overridden. This is useful, since the speckle_type has to be
+    unique for each subclass of speckle Base.
+    """
+
+    magic: str = "trick"
+
+
+if __name__ == "__main__":
+    # example usage
+    custom_sub = SpeckleSub(
+        foo=123,
+        magic="trick",
+        bar="baric",
+        extra=123,
+    )
+    # support for dynamic attributes
+    custom_sub.extra_extra = "what is this?"
+    debug(custom_sub.json())
+
+    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())

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(f"Invalid pyproject.toml. Could not patch version.")
+
+        lines[2] = f'version = "{tag}"\n'
+        with open("pyproject.toml", "w") as file:
+            file.writelines(lines)
+
+
+def main():
+    if len(sys.argv) < 2:
+        return
+
+    tag = sys.argv[1]
+    if not re.match(r"[0-9]+(\.[0-9]+)*$", tag):
+        raise ValueError(f"Invalid tag provided: {tag}")
+
+    patch(tag)
+
+
+if __name__ == "__main__":
+    main()

pyproject.toml

@@ -0,0 +1,51 @@
+[tool.poetry]
+name = "specklepy"
+version = "2.4.0"
+description = "The Python SDK for Speckle 2.0"
+readme = "README.md"
+authors = ["Speckle Systems <devops@speckle.systems>"]
+license = "Apache-2.0"
+repository = "https://github.com/specklesystems/speckle-py"
+documentation = "https://speckle.guide/dev/py-examples.html"
+homepage = "https://speckle.systems/"
+
+
+[tool.poetry.dependencies]
+python = "^3.6.5"
+pydantic = "^1.8.2"
+appdirs = "^1.4.4"
+gql = {version = ">=3.0.0b1", extras = ["all"], allow-prereleases = true}
+ujson = "^4.3.0"
+Deprecated = "^1.2.13"
+
+[tool.poetry.dev-dependencies]
+black = "^20.8b1"
+isort = "^5.7.0"
+pytest = "^6.2.2"
+pytest-ordering = "^0.6"
+pytest-cov = "^3.0.0"
+
+
+[tool.black]
+exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+)/
+'''
+include = '\.pyi?$'
+line-length = 88
+target-version = ["py36", "py37", "py38"]
+
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

requirements.txt

@@ -1,31 +0,0 @@
-aiohttp==3.7.1
-appdirs==1.4.4
-astroid==2.4.2
-async-timeout==3.0.1
-attrs==20.3.0
-black==20.8b1
-certifi==2020.11.8
-chardet==3.0.4
-click==7.1.2
-colorama==0.4.4
-gql==3.0.0a4
-graphql-core==3.1.2
-idna==2.10
-isort==5.6.4
-lazy-object-proxy==1.4.3
-mccabe==0.6.1
-multidict==5.0.0
-mypy-extensions==0.4.3
-pathspec==0.8.1
-pydantic==1.7.2
-pylint==2.6.0
-regex==2020.11.11
-requests==2.24.0
-six==1.15.0
-toml==0.10.2
-typed-ast==1.4.1
-typing-extensions==3.7.4.3
-urllib3==1.25.11
-websockets==8.1
-wrapt==1.12.1
-yarl==1.5.1

speckle/api/client.py

@@ -1,85 +0,0 @@
-from gql.client import SyncClientSession
-from speckle.logging.exceptions import SpeckleException
-from typing import Dict
-
-from speckle.api import resources
-from speckle.api.resources import stream, server, user, subscriptions
-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 = "staging.speckle.dev"
-    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"
-
-        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()
-
-    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.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"
-            )

speckle/api/models.py

@@ -1,86 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  stream_schema.json
-#   timestamp: 2020-11-17T14:33:13+00:00
-
-from __future__ import annotations
-
-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]
-    referencedObject: Optional[str]
-
-
-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 Streams(BaseModel):
-    totalCount: Optional[int]
-    cursor: Optional[datetime]
-    items: List[Stream] = []
-
-
-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]
-
-
-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]

speckle/api/resources/branch.py

@@ -1,48 +0,0 @@
-from typing import List, Optional
-from gql import gql
-from pydantic.main import BaseModel
-from speckle.api.resource import ResourceBase
-from speckle.api.models import Branch
-
-NAME = "branch"
-METHODS = ["create"]
-
-
-class Resource(ResourceBase):
-    """API Access class for branches"""
-
-    def __init__(self, me, basepath, client) -> None:
-        super().__init__(
-            me=me, basepath=basepath, client=client, name=NAME, methods=METHODS
-        )
-        self.schema = Branch
-
-    def create(
-        self, streamId: str, name: str, description: str = "No description provided"
-    ) -> str:
-        """Create a new branch on this stream
-
-        Arguments:
-            name {str} -- the name of the new branch
-            description {str} -- a short description of the branch
-
-        Returns:
-            id {str} -- the newly created branch's id
-        """
-
-        query = gql(
-            """
-            mutation BranchCreate($branch: BranchCreateInput!){
-              branchCreate(branch: $branch)
-            }
-          """
-        )
-        params = {
-            "branch": {
-                "streamId": streamId,
-                "name": name,
-                "description": description,
-            }
-        }
-
-        return self.make_request(query=query, params=params, parse_response=False)

speckle/api/resources/commit.py

@@ -1,19 +0,0 @@
-from typing import Optional, List
-from gql import gql
-from pydantic.main import BaseModel
-from speckle.api.resource import ResourceBase
-from speckle.api.models import Commit
-
-
-NAME = "commit"
-METHODS = []
-
-
-class Resource(ResourceBase):
-    """API Access class for commits"""
-
-    def __init__(self, me, basepath, client) -> None:
-        super().__init__(
-            me=me, basepath=basepath, client=client, name=NAME, methods=METHODS
-        )
-        self.schema = Commit

speckle/api/resources/server.py

@@ -1,79 +0,0 @@
-from typing import Dict
-from gql import gql
-from gql.client import Client
-from speckle.api.resource import ResourceBase
-
-
-NAME = "server"
-METHODS = ["get", "apps"]
-
-
-class Resource(ResourceBase):
-    """API Access class for the server"""
-
-    def __init__(self, me, basepath, client) -> None:
-        super().__init__(
-            me=me, basepath=basepath, client=client, name=NAME, methods=METHODS
-        )
-
-    def get(self) -> Dict:
-        """Get the server info
-
-        Returns:
-            dict -- the server info in dictionary form
-        """
-        query = gql(
-            """
-            query Server {
-              serverInfo {
-                name
-                company
-                description
-                adminContact
-                canonicalUrl
-                roles {
-                  name
-                  description
-                  resourceTarget
-                }
-                scopes {
-                  name
-                  description
-                }
-                authStrategies{
-                  id
-                  name
-                  icon
-                }
-              }
-            }
-        """
-        )
-
-        return self.make_request(query=query)
-
-    def apps(self) -> Dict:
-        """Get the apps registered on the server
-
-        Returns:
-            dict -- a dictionary of apps registered on the server
-        """
-        query = gql(
-            """
-            query Apps {
-              apps {
-                id
-                name
-                description
-                termsAndConditionsLink
-                logo
-                author {
-                  id
-                  name
-                }
-              }
-            }
-        """
-        )
-
-        return self.make_request(query=query)

speckle/api/resources/stream.py

@@ -1,298 +0,0 @@
-from re import search
-from typing import Dict, List, Optional
-from pydantic import BaseModel
-from gql import gql
-from speckle.api.resource import ResourceBase
-from speckle.api.models import Stream
-from speckle.logging.exceptions import GraphQLException
-
-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"]
-        )

speckle/api/resources/user.py

@@ -1,86 +0,0 @@
-from speckle.logging.exceptions import SpeckleException
-from typing import List, Optional
-from gql import gql
-from pydantic.main import BaseModel
-from speckle.api.resource import ResourceBase
-from speckle.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"]
-        )

speckle/logging/exceptions.py

@@ -1,17 +0,0 @@
-from typing import List
-
-
-class SpeckleException(Exception):
-    def __init__(self, message: str, exception: Exception = None) -> None:
-        self.message = message
-        self.exception = exception
-
-    def __repr__(self) -> str:
-        return f"SpeckleException: {self.message}"
-
-
-class GraphQLException(SpeckleException):
-    def __init__(self, message: str, errors: List, data=None) -> None:
-        super().__init__(message=message)
-        self.errors = errors
-        self.data = data

specklepy/api/client.py

@@ -0,0 +1,190 @@
+import re
+from warnings import warn
+from deprecated import deprecated
+from specklepy.api.credentials import Account, get_account_from_token
+from specklepy.logging.exceptions import (
+    GraphQLException,
+    SpeckleException,
+    SpeckleWarning,
+)
+from typing import Dict
+
+from specklepy.api import resources
+from specklepy.api.resources import (
+    branch,
+    commit,
+    stream,
+    object,
+    server,
+    user,
+    subscriptions,
+)
+from specklepy.api.models import ServerInfo
+from gql import Client
+from gql.transport.requests import RequestsHTTPTransport
+from gql.transport.websockets import WebsocketsTransport
+
+
+class SpeckleClient:
+    """
+    The `SpeckleClient` is your entry point for interacting with your Speckle Server's GraphQL API.
+    You'll need to have access to a server to use it, or you can use our public server `speckle.xyz`.
+
+    To authenticate the client, you'll need to have downloaded the [Speckle Manager](https://speckle.guide/#speckle-manager)
+    and added your account.
+
+    ```py
+    from specklepy.api.client import SpeckleClient
+    from specklepy.api.credentials import get_default_account
+
+    # initialise the client
+    client = SpeckleClient(host="speckle.xyz") # or whatever your host is
+    # client = SpeckleClient(host="localhost:3000", use_ssl=False) or use local server
+
+    # authenticate the client with an account (account has been added in Speckle Manager)
+    account = get_default_account()
+    client.authenticate_with_account(account)
+
+    # create a new stream. this returns the stream id
+    new_stream_id = client.stream.create(name="a shiny new stream")
+
+    # use that stream id to get the stream from the server
+    new_stream = client.stream.get(id=new_stream_id)
+    ```
+    """
+
+    DEFAULT_HOST = "speckle.xyz"
+    USE_SSL = True
+
+    def __init__(self, host: str = DEFAULT_HOST, use_ssl: bool = USE_SSL) -> None:
+        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
+        try:
+            serverInfo = self.server.get()
+            if isinstance(serverInfo, Exception):
+                raise serverInfo
+            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 __repr__(self):
+        return f"SpeckleClient( server: {self.url}, authenticated: {self.account.token is not None} )"
+
+    @deprecated(
+        version="2.6.0",
+        reason="Renamed: please use `authenticate_with_account` or `authenticate_with_token` instead.",
+    )
+    def authenticate(self, token: str) -> None:
+        """Authenticate the client using a personal access token
+        The token is saved in the client object and a synchronous GraphQL entrypoint is created
+
+        Arguments:
+            token {str} -- an api token
+        """
+        self.authenticate_with_token(token)
+        self._set_up_client()
+
+    def authenticate_with_token(self, token: str) -> None:
+        """Authenticate the client using a personal access token
+        The token is saved in the client object and a synchronous GraphQL entrypoint is created
+
+        Arguments:
+            token {str} -- an api token
+        """
+        self.account = get_account_from_token(token, self.url)
+        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`
+        """
+        self.account = account
+        self._set_up_client()
+
+    def _set_up_client(self) -> None:
+        headers = {
+            "Authorization": f"Bearer {self.account.token}",
+            "Content-Type": "application/json",
+        }
+        httptransport = RequestsHTTPTransport(
+            url=self.graphql, headers=headers, verify=True, retries=3
+        )
+        wstransport = WebsocketsTransport(
+            url=self.ws_url,
+            init_payload={"Authorization": f"Bearer {self.account.token}"},
+        )
+        self.httpclient = Client(transport=httptransport)
+        self.wsclient = Client(transport=wstransport)
+
+        self._init_resources()
+
+        if isinstance(self.user.get(), GraphQLException):
+            warn(
+                SpeckleWarning(
+                    f"Possibly invalid token - could not authenticate Speckle Client for server {self.url}"
+                )
+            )
+
+    def execute_query(self, query: str) -> Dict:
+        return self.httpclient.execute(query)
+
+    def _init_resources(self) -> None:
+        self.stream = stream.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.commit = commit.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.branch = branch.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.object = object.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.server = server.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.user = user.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.subscribe = subscriptions.Resource(
+            account=self.account,
+            basepath=self.ws_url,
+            client=self.wsclient,
+        )
+
+    def __getattr__(self, name):
+        try:
+            attr = getattr(resources, name)
+            return attr.Resource(
+                account=self.account, basepath=self.url, client=self.httpclient
+            )
+        except:
+            raise SpeckleException(
+                f"Method {name} is not supported by the SpeckleClient class"
+            )

specklepy/api/credentials.py

@@ -0,0 +1,131 @@
+import os
+from pydantic import BaseModel, Field
+from typing import List, Optional
+from specklepy.logging import metrics
+from specklepy.api.models import ServerInfo
+from specklepy.transports.sqlite import SQLiteTransport
+from specklepy.logging.exceptions import SpeckleException
+
+
+class UserInfo(BaseModel):
+    name: Optional[str]
+    email: Optional[str]
+    company: Optional[str]
+    id: Optional[str]
+
+
+class Account(BaseModel):
+    isDefault: bool = False
+    token: str = None
+    refreshToken: str = None
+    serverInfo: ServerInfo = Field(default_factory=ServerInfo)
+    userInfo: UserInfo = Field(default_factory=UserInfo)
+    id: str = None
+
+    def __repr__(self) -> str:
+        return f"Account(email: {self.userInfo.email}, server: {self.serverInfo.url}, isDefault: {self.isDefault})"
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+    @classmethod
+    def from_token(cls, token: str, server_url: str = None):
+        acct = cls(token=token)
+        acct.serverInfo.url = server_url
+        return acct
+
+
+def get_local_accounts(base_path: str = None) -> List[Account]:
+    """Gets all the accounts present in this environment
+
+    Arguments:
+        base_path {str} -- custom base path if you are not using the system default
+
+    Returns:
+        List[Account] -- list of all local accounts or an empty list if no accounts were found
+    """
+    account_storage = SQLiteTransport(scope="Accounts", base_path=base_path)
+    json_path = os.path.join(account_storage._base_path, "Accounts")
+    os.makedirs(json_path, exist_ok=True)
+    json_acct_files = [file for file in os.listdir(json_path) if file.endswith(".json")]
+
+    accounts = []
+    res = account_storage.get_all_objects()
+    if res:
+        accounts.extend(Account.parse_raw(r[1]) for r in res)
+    if json_acct_files:
+        try:
+            accounts.extend(
+                Account.parse_file(os.path.join(json_path, json_file))
+                for json_file in json_acct_files
+            )
+        except Exception as ex:
+            raise SpeckleException(
+                "Invalid json accounts could not be read. Please fix or remove them.",
+                ex,
+            )
+    metrics.track(
+        metrics.ACCOUNTS,
+        next(
+            (acc for acc in accounts if acc.isDefault),
+            accounts[0] if accounts else None,
+        ),
+    )
+
+    return accounts
+
+
+def get_default_account(base_path: str = None) -> Account:
+    """Gets this environment's default account if any. If there is no default, the first found will be returned and set as default.
+    Arguments:
+        base_path {str} -- custom base path if you are not using the system default
+
+    Returns:
+        Account -- the default account or None if no local accounts were found
+    """
+    accounts = get_local_accounts(base_path=base_path)
+    if not accounts:
+        return None
+
+    default = next((acc for acc in accounts if acc.isDefault), None)
+    if not default:
+        default = accounts[0]
+        default.isDefault = True
+    metrics.initialise_tracker(default)
+
+    return default
+
+
+def get_account_from_token(token: str, server_url: str = None) -> Account:
+    """Gets the local account for the token if it exists
+    Arguments:
+        token {str} -- the api token
+
+    Returns:
+        Account -- the local account with this token or a shell account containing just the token and url if no local account is found
+    """
+    accounts = get_local_accounts()
+    if not accounts:
+        return Account.from_token(token, server_url)
+
+    acct = next((acc for acc in accounts if acc.token == token), None)
+    if acct:
+        return acct
+
+    if server_url:
+        url = server_url.lower()
+        acct = next(
+            (acc for acc in accounts if url in acc.serverInfo.url.lower()), None
+        )
+        if acct:
+            return acct
+
+    return Account.from_token(token, server_url)
+
+
+class StreamWrapper:
+    def __init__(self, url: str = None) -> None:
+        raise SpeckleException(
+            message="The StreamWrapper has moved as of v2.6.0! Please import from specklepy.api.wrapper",
+            exception=DeprecationWarning,
+        )

specklepy/api/models.py

@@ -0,0 +1,148 @@
+# generated by datamodel-codegen:
+#   filename:  stream_schema.json
+#   timestamp: 2020-11-17T14:33:13+00:00
+
+from datetime import datetime
+from typing import Any, Dict, List, Optional
+
+
+from pydantic import BaseModel
+
+
+class Collaborator(BaseModel):
+    id: Optional[str]
+    name: Optional[str]
+    role: Optional[str]
+    avatar: Optional[str]
+
+
+class Commit(BaseModel):
+    id: Optional[str]
+    message: Optional[str]
+    authorName: Optional[str]
+    authorId: Optional[str]
+    authorAvatar: Optional[str]
+    branchName: Optional[str]
+    createdAt: Optional[datetime]
+    sourceApplication: Optional[str]
+    referencedObject: Optional[str]
+    totalChildrenCount: Optional[int]
+    parents: Optional[List[str]]
+
+    def __repr__(self) -> str:
+        return f"Commit( id: {self.id}, message: {self.message}, referencedObject: {self.referencedObject}, authorName: {self.authorName}, branchName: {self.branchName}, createdAt: {self.createdAt} )"
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+
+class Commits(BaseModel):
+    totalCount: Optional[int]
+    cursor: Optional[datetime]
+    items: List[Commit] = []
+
+
+class Object(BaseModel):
+    id: Optional[str]
+    speckleType: Optional[str]
+    applicationId: Optional[str]
+    totalChildrenCount: Optional[int]
+    createdAt: Optional[datetime]
+
+
+class Branch(BaseModel):
+    id: Optional[str]
+    name: Optional[str]
+    description: Optional[str]
+    commits: Optional[Commits]
+
+
+class Branches(BaseModel):
+    totalCount: Optional[int]
+    cursor: Optional[datetime]
+    items: List[Branch] = []
+
+
+class Stream(BaseModel):
+    id: Optional[str]
+    name: Optional[str]
+    description: Optional[str]
+    isPublic: Optional[bool]
+    createdAt: Optional[datetime]
+    updatedAt: Optional[datetime]
+    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 Activity(BaseModel):
+    actionType: Optional[str]
+    info: Optional[dict]
+    userId: Optional[str]
+    streamId: Optional[str]
+    resourceId: Optional[str]
+    resourceType: Optional[str]
+    message: Optional[str]
+    time: Optional[datetime]
+
+    def __repr__(self) -> str:
+        return f"Activity( streamId: {self.streamId}, actionType: {self.actionType}, message: {self.message}, userId: {self.userId} )"
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+
+class ActivityCollection(BaseModel):
+    totalCount: Optional[int]
+    items: Optional[List[Activity]]
+    cursor: Optional[datetime]
+
+    def __repr__(self) -> str:
+        return f"ActivityCollection( totalCount: {self.totalCount}, items: {len(self.items) if self.items else 0}, cursor: {self.cursor.isoformat()} )"
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+
+class ServerInfo(BaseModel):
+    name: Optional[str]
+    company: Optional[str]
+    url: Optional[str]
+    description: Optional[str]
+    adminContact: Optional[str]
+    canonicalUrl: Optional[str]
+    roles: Optional[List[dict]]
+    scopes: Optional[List[dict]]
+    authStrategies: Optional[List[dict]]
+    version: Optional[str]

specklepy/api/operations.py

@@ -0,0 +1,128 @@
+from typing import List
+from specklepy.logging import metrics
+from specklepy.objects.base import Base
+from specklepy.transports.sqlite import SQLiteTransport
+from specklepy.transports.server import ServerTransport
+from specklepy.logging.exceptions import SpeckleException
+from specklepy.transports.abstract_transport import AbstractTransport
+from specklepy.serialization.base_object_serializer import BaseObjectSerializer
+
+
+def send(
+    base: Base,
+    transports: List[AbstractTransport] = None,
+    use_default_cache: bool = True,
+):
+    """Sends an object via the provided transports. Defaults to the local cache.
+
+    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
+
+    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"
+        )
+
+    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()
+    obj_hash, _ = serializer.write_json(base=base)
+
+    for t in transports:
+        t.end_write()
+
+    return obj_hash
+
+
+def receive(
+    obj_id: str,
+    remote_transport: AbstractTransport = None,
+    local_transport: 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 local cache to check for existing objects
+                                       (defaults to `SQLiteTransport`)
+
+    Returns:
+        Base -- the base object
+    """
+    metrics.track(metrics.RECEIVE, getattr(remote_transport, "account", None))
+    if not local_transport:
+        local_transport = SQLiteTransport()
+
+    serializer = BaseObjectSerializer(read_transport=local_transport)
+
+    # try local transport first. if the parent is there, we assume all the children are there and continue wth deserialisation using the local transport
+    obj_string = local_transport.get_object(obj_id)
+    if obj_string:
+        return serializer.read_json(obj_string=obj_string)
+
+    if not remote_transport:
+        raise SpeckleException(
+            message="Could not find the specified object using the local transport, and you didn't provide a fallback remote from which to pull it."
+        )
+
+    obj_string = remote_transport.copy_object_and_children(
+        id=obj_id, target_transport=local_transport
+    )
+
+    return serializer.read_json(obj_string=obj_string)
+
+
+def serialize(base: Base, write_transports: List[AbstractTransport] = []) -> str:
+    """
+    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
+
+    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 = 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.
+
+    Arguments:
+        obj_string {str} -- the string object to deserialize
+        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)

specklepy/api/resource.py

@@ -1,21 +1,23 @@
-from logging import error
-from speckle.logging.exceptions import GraphQLException, SpeckleException
+from specklepy.api.credentials import Account
+from specklepy.transports.sqlite import SQLiteTransport
 from typing import Dict, List
 from gql.client import Client
 from gql.gql import gql
 from gql.transport.exceptions import TransportQueryError
+from specklepy.logging.exceptions import GraphQLException, SpeckleException
+from specklepy.serialization.base_object_serializer import BaseObjectSerializer
 
 
 class ResourceBase(object):
     def __init__(
         self,
-        me: Dict,
+        account: Account,
         basepath: str,
         client: Client,
         name: str,
         methods: list,
     ) -> None:
-        self.me = me
+        self.account = account
         self.basepath = basepath
         self.client = client
         self.name = name
@@ -40,7 +42,11 @@ class ResourceBase(object):
         if schema:
             return schema.parse_obj(response)
         elif self.schema:
-            return self.schema.parse_obj(response)
+            try:
+                return self.schema.parse_obj(response)
+            except:
+                s = BaseObjectSerializer(read_transport=SQLiteTransport())
+                return s.recompose_base(response)
         else:
             return response
 

specklepy/api/resources/__init__.py

@@ -5,9 +5,9 @@ import pkgutil
 from importlib import import_module
 
 
-for (_, name, _) in pkgutil.iter_modules([Path(__file__).parent]):
+for (_, name, _) in pkgutil.iter_modules(__path__):
 
     imported_module = import_module("." + name, package=__name__)
 
     if hasattr(imported_module, "Resource"):
-        setattr(sys.modules[__name__], name, imported_module)
+        setattr(sys.modules[__name__], name, imported_module)

specklepy/api/resources/branch.py

@@ -0,0 +1,216 @@
+from gql import gql
+from specklepy.api.resource import ResourceBase
+from specklepy.api.models import Branch
+from specklepy.logging import metrics
+
+NAME = "branch"
+METHODS = ["create"]
+
+
+class Resource(ResourceBase):
+    """API Access class for branches"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+            methods=METHODS,
+        )
+        self.schema = Branch
+
+    def create(
+        self, stream_id: str, name: str, description: str = "No description provided"
+    ) -> str:
+        """Create a new branch on this stream
+
+        Arguments:
+            name {str} -- the name of the new branch
+            description {str} -- a short description of the branch
+
+        Returns:
+            id {str} -- the newly created branch's id
+        """
+        metrics.track(metrics.BRANCH, self.account, {"name": "create"})
+        query = gql(
+            """
+            mutation BranchCreate($branch: BranchCreateInput!) {
+              branchCreate(branch: $branch)
+            }
+          """
+        )
+        params = {
+            "branch": {
+                "streamId": stream_id,
+                "name": name,
+                "description": description,
+            }
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type="branchCreate", parse_response=False
+        )
+
+    def get(self, stream_id: str, name: str, commits_limit: int = 10):
+        """Get a branch by name from a stream
+
+        Arguments:
+            stream_id {str} -- the id of the stream to get the branch from
+            name {str} -- the name of the branch to get
+            commits_limit {int} -- maximum number of commits to get
+
+        Returns:
+            Branch -- the fetched branch with its latest commits
+        """
+        metrics.track(metrics.BRANCH, self.account, {"name": "get"})
+        query = gql(
+            """
+            query BranchGet($stream_id: String!, $name: String!, $commits_limit: Int!) {
+                stream(id: $stream_id) {
+                        branch(name: $name) {
+                          id,
+                          name,
+                          description,
+                          commits (limit: $commits_limit) {
+                            totalCount,
+                            cursor,
+                            items {
+                              id,
+                              referencedObject,
+                              sourceApplication,
+                              totalChildrenCount,
+                              message,
+                              authorName,
+                              authorId,
+                              branchName,
+                              parents,
+                              createdAt
+                            }
+                        }
+                    }                      
+                }
+            }
+            """
+        )
+
+        params = {"stream_id": stream_id, "name": name, "commits_limit": commits_limit}
+
+        return self.make_request(
+            query=query, params=params, return_type=["stream", "branch"]
+        )
+
+    def list(self, stream_id: str, branches_limit: int = 10, commits_limit: int = 10):
+        """Get a list of branches from a given stream
+
+        Arguments:
+            stream_id {str} -- the id of the stream to get the branches from
+            branches_limit {int} -- maximum number of branches to get
+            commits_limit {int} -- maximum number of commits to get
+
+        Returns:
+            List[Branch] -- the branches on the stream
+        """
+        metrics.track(metrics.BRANCH, self.account, {"name": "get"})
+        query = gql(
+            """
+            query BranchesGet($stream_id: String!, $branches_limit: Int!, $commits_limit: Int!) {
+                stream(id: $stream_id) {
+                    branches(limit: $branches_limit) {
+                        items {
+                            id
+                            name
+                            description
+                            commits(limit: $commits_limit) {
+                                totalCount
+                                items{
+                                    id
+                                    message
+                                    referencedObject
+                                    sourceApplication
+                                    parents
+                                    authorId
+                                    authorName
+                                    branchName
+                                    createdAt
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+            """
+        )
+
+        params = {
+            "stream_id": stream_id,
+            "branches_limit": branches_limit,
+            "commits_limit": commits_limit,
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type=["stream", "branches", "items"]
+        )
+
+    def update(
+        self, stream_id: str, branch_id: str, name: str = None, description: str = None
+    ):
+        """Update a branch
+
+        Arguments:
+            stream_id {str} -- the id of the stream containing the branch to update
+            branch_id {str} -- the id of the branch to update
+            name {str} -- optional: the updated branch name
+            description {str} -- optional: the updated branch description
+
+        Returns:
+            bool -- True if update is successfull
+        """
+        metrics.track(metrics.BRANCH, self.account, {"name": "update"})
+        query = gql(
+            """
+            mutation  BranchUpdate($branch: BranchUpdateInput!) {
+                branchUpdate(branch: $branch)
+                }
+            """
+        )
+        params = {
+            "branch": {
+                "streamId": stream_id,
+                "id": branch_id,
+            }
+        }
+
+        if name:
+            params["branch"]["name"] = name
+        if description:
+            params["branch"]["description"] = description
+
+        return self.make_request(
+            query=query, params=params, return_type="branchUpdate", parse_response=False
+        )
+
+    def delete(self, stream_id: str, branch_id: str):
+        """Delete a branch
+
+        Arguments:
+            stream_id {str} -- the id of the stream containing the branch to delete
+            branch_id {str} -- the branch to delete
+
+        Returns:
+            bool -- True if deletion is successful
+        """
+        metrics.track(metrics.BRANCH, self.account, {"name": "delete"})
+        query = gql(
+            """
+            mutation BranchDelete($branch: BranchDeleteInput!) {
+                branchDelete(branch: $branch)
+            }
+            """
+        )
+
+        params = {"branch": {"streamId": stream_id, "id": branch_id}}
+
+        return self.make_request(
+            query=query, params=params, return_type="branchDelete", parse_response=False
+        )

specklepy/api/resources/commit.py

@@ -0,0 +1,235 @@
+from typing import Optional, List
+from gql import gql
+from specklepy.api.resource import ResourceBase
+from specklepy.api.models import Commit
+from specklepy.logging import metrics
+
+
+NAME = "commit"
+METHODS = []
+
+
+class Resource(ResourceBase):
+    """API Access class for commits"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+            methods=METHODS,
+        )
+        self.schema = Commit
+
+    def get(self, stream_id: str, commit_id: str) -> Commit:
+        """
+        Gets a commit given a stream and the commit id
+
+        Arguments:
+            stream_id {str} -- the stream where we can find the commit
+            commit_id {str} -- the id of the commit you want to get
+
+        Returns:
+            Commit -- the retrieved commit object
+        """
+        query = gql(
+            """
+            query Commit($stream_id: String!, $commit_id: String!) {
+                stream(id: $stream_id) {
+                    commit(id: $commit_id) {
+                        id
+                        message
+                        referencedObject
+                        authorId
+                        authorName
+                        authorAvatar
+                        branchName
+                        createdAt
+                        sourceApplication
+                        totalChildrenCount
+                        parents
+                    }
+                }
+            }
+            """
+        )
+        params = {"stream_id": stream_id, "commit_id": commit_id}
+
+        return self.make_request(
+            query=query, params=params, return_type=["stream", "commit"]
+        )
+
+    def list(self, stream_id: str, limit: int = 10) -> List[Commit]:
+        """
+        Get a list of commits on a given stream
+
+        Arguments:
+            stream_id {str} -- the stream where the commits are
+            limit {int} -- the maximum number of commits to fetch (default = 10)
+
+        Returns:
+            List[Commit] -- a list of the most recent commit objects
+        """
+        metrics.track(metrics.COMMIT, self.account, {"name": "get"})
+        query = gql(
+            """
+            query Commits($stream_id: String!, $limit: Int!) {
+                stream(id: $stream_id) {
+                    commits(limit: $limit) {
+                        items {
+                            id
+                            message
+                            referencedObject
+                            authorName
+                            authorId
+                            authorName
+                            authorAvatar
+                            branchName
+                            createdAt
+                            sourceApplication
+                            totalChildrenCount
+                            parents
+                        }
+                    }
+                }
+            }
+            """
+        )
+        params = {"stream_id": stream_id, "limit": limit}
+
+        return self.make_request(
+            query=query, params=params, return_type=["stream", "commits", "items"]
+        )
+
+    def create(
+        self,
+        stream_id: str,
+        object_id: str,
+        branch_name: str = "main",
+        message: str = "",
+        source_application: str = "python",
+        parents: List[str] = None,
+    ) -> str:
+        """
+        Creates a commit on a branch
+
+        Arguments:
+            stream_id {str} -- the stream you want to commit to
+            object_id {str} -- the hash of your commit object
+            branch_name {str} -- the name of the branch to commit to (defaults to "main")
+            message {str} -- optional: a message to give more information about the commit
+            source_application{str} -- optional: the application from which the commit was created (defaults to "python")
+            parents {List[str]} -- optional: the id of the parent commits
+
+        Returns:
+            str -- the id of the created commit
+        """
+        metrics.track(metrics.COMMIT, self.account, {"name": "create"})
+        query = gql(
+            """
+            mutation CommitCreate ($commit: CommitCreateInput!){ commitCreate(commit: $commit)}
+            """
+        )
+        params = {
+            "commit": {
+                "streamId": stream_id,
+                "branchName": branch_name,
+                "objectId": object_id,
+                "message": message,
+                "sourceApplication": source_application,
+            }
+        }
+        if parents:
+            params["commit"]["parents"] = parents
+
+        return self.make_request(
+            query=query, params=params, return_type="commitCreate", parse_response=False
+        )
+
+    def update(self, stream_id: str, commit_id: str, message: str) -> bool:
+        """
+        Update a commit
+
+        Arguments:
+            stream_id {str} -- the id of the stream that contains the commit you'd like to update
+            commit_id {str} -- the id of the commit you'd like to update
+            message {str} -- the updated commit message
+
+        Returns:
+            bool -- True if the operation succeeded
+        """
+        metrics.track(metrics.COMMIT, self.account, {"name": "update"})
+        query = gql(
+            """
+            mutation CommitUpdate($commit: CommitUpdateInput!){ commitUpdate(commit: $commit)}
+            """
+        )
+        params = {
+            "commit": {"streamId": stream_id, "id": commit_id, "message": message}
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type="commitUpdate", parse_response=False
+        )
+
+    def delete(self, stream_id: str, commit_id: str) -> bool:
+        """
+        Delete a commit
+
+        Arguments:
+            stream_id {str} -- the id of the stream that contains the commit you'd like to delete
+            commit_id {str} -- the id of the commit you'd like to delete
+
+        Returns:
+            bool -- True if the operation succeeded
+        """
+        metrics.track(metrics.COMMIT, self.account, {"name": "delete"})
+        query = gql(
+            """
+            mutation CommitDelete($commit: CommitDeleteInput!){ commitDelete(commit: $commit)}
+            """
+        )
+        params = {"commit": {"streamId": stream_id, "id": commit_id}}
+
+        return self.make_request(
+            query=query, params=params, return_type="commitDelete", parse_response=False
+        )
+
+    def received(
+        self,
+        stream_id: str,
+        commit_id: str,
+        source_application: str = "python",
+        message: Optional[str] = None,
+    ) -> bool:
+        """
+        Mark a commit object a received by the source application.
+        """
+        metrics.track(metrics.COMMIT, self.account, {"name": "received"})
+        query = gql(
+            """
+            mutation CommitReceive($receivedInput:CommitReceivedInput!){
+                commitReceive(input:$receivedInput)
+            }
+            """
+        )
+        params = {
+            "receivedInput": {
+                "sourceApplication": source_application,
+                "streamId": stream_id,
+                "commitId": commit_id,
+                "message": "message",
+            }
+        }
+
+        try:
+            return self.make_request(
+                query=query,
+                params=params,
+                return_type="commitReceive",
+                parse_response=False,
+            )
+        except Exception as ex:
+            print(ex.with_traceback)
+            return False

specklepy/api/resources/object.py

@@ -0,0 +1,83 @@
+from typing import Dict, List
+from gql import gql
+from specklepy.api.resource import ResourceBase
+from specklepy.objects.base import Base
+
+NAME = "object"
+METHODS = []
+
+
+class Resource(ResourceBase):
+    """API Access class for objects"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+            methods=METHODS,
+        )
+        self.schema = Base
+
+    def get(self, stream_id: str, object_id: str) -> Base:
+        """
+        Get a stream object
+
+        Arguments:
+            stream_id {str} -- the id of the stream for the object
+            object_id {str} -- the hash of the object you want to get
+
+        Returns:
+            Base -- the returned Base object
+        """
+        query = gql(
+            """
+            query Object($stream_id: String!, $object_id: String!) {
+              stream(id: $stream_id) {
+                id
+                name
+                object(id: $object_id) {
+                  id
+                  speckleType
+                  applicationId
+                  createdAt
+                  totalChildrenCount
+                  data
+                }
+              }
+            }
+          """
+        )
+        params = {"stream_id": stream_id, "object_id": object_id}
+
+        return self.make_request(
+            query=query, params=params, return_type=["stream", "object", "data"]
+        )
+
+    def create(self, stream_id: str, objects: List[Dict]) -> str:
+        """
+        Not advised - generally, you want to use `operations.send()`.
+
+        Create a new object on a stream. To send a base object, you can prepare it by running it through the
+        `BaseObjectSerializer.traverse_base()` function to get a valid (serialisable) object to send.
+
+        NOTE: this does not create a commit - you can create one with `SpeckleClient.commit.create`. Dynamic fields will be located in the 'data' dict of the received `Base` object
+
+        Arguments:
+            stream_id {str} -- the id of the stream you want to send the object to
+            objects {List[Dict]} -- a list of base dictionary objects (NOTE: must be json serialisable)
+
+        Returns:
+            str -- the id of the object
+        """
+        query = gql(
+            """
+          mutation ObjectCreate($object_input: ObjectCreateInput!) { objectCreate(objectInput: $object_input) }
+          """
+        )
+        params = {"object_input": {"streamId": stream_id, "objects": objects}}
+
+        return self.make_request(
+            query=query, params=params, return_type="objectCreate", parse_response=False
+        )

specklepy/api/resources/server.py

@@ -0,0 +1,140 @@
+from typing import Dict, List
+from gql import gql
+from specklepy.api.models import ServerInfo
+from specklepy.api.resource import ResourceBase
+
+
+NAME = "server"
+METHODS = ["get", "apps"]
+
+
+class Resource(ResourceBase):
+    """API Access class for the server"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+            methods=METHODS,
+        )
+
+    def get(self) -> ServerInfo:
+        """Get the server info
+
+        Returns:
+            dict -- the server info in dictionary form
+        """
+        query = gql(
+            """
+            query Server {
+                serverInfo {
+                    name
+                    company
+                    description
+                    adminContact
+                    canonicalUrl
+                    version
+                    roles {
+                        name
+                        description
+                        resourceTarget
+                    }
+                    scopes {
+                        name
+                        description
+                    }
+                    authStrategies{
+                        id
+                        name
+                        icon
+                    }
+                }
+            }
+            """
+        )
+
+        return self.make_request(
+            query=query, return_type="serverInfo", schema=ServerInfo
+        )
+
+    def apps(self) -> Dict:
+        """Get the apps registered on the server
+
+        Returns:
+            dict -- a dictionary of apps registered on the server
+        """
+        query = gql(
+            """
+            query Apps {
+                apps{
+                    id
+                    name
+                    description
+                    termsAndConditionsLink
+                    trustByDefault
+                    logo
+                    author {
+                        id
+                        name
+                        avatar
+                    }
+                }
+            }
+        """
+        )
+
+        return self.make_request(query=query, return_type="apps", parse_response=False)
+
+    def create_token(self, name: str, scopes: List[str], lifespan: int) -> str:
+        """Create a personal API token
+
+        Arguments:
+            scopes {List[str]} -- the scopes to grant with this token
+            name {str} -- a name for your new token
+            lifespan {int} -- duration before the token expires
+
+        Returns:
+            str -- the new API token. note: this is the only time you'll see the token!
+        """
+        query = gql(
+            """
+            mutation TokenCreate($token: ApiTokenCreateInput!) {
+                apiTokenCreate(token: $token)
+            }
+            """
+        )
+        params = {"token": {"scopes": scopes, "name": name, "lifespan": lifespan}}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="apiTokenCreate",
+            parse_response=False,
+        )
+
+    def revoke_token(self, token: str) -> bool:
+        """Revokes (deletes) a personal API token
+
+        Arguments:
+            token {str} -- the token to revoke (delete)
+
+        Returns:
+            bool -- True if the token was successfully deleted
+        """
+        query = gql(
+            """
+            mutation TokenRevoke($token: String!) {
+                apiTokenRevoke(token: $token)
+            }
+            """
+        )
+        params = {"token": token}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="apiTokenRevoke",
+            parse_response=False,
+        )

specklepy/api/resources/stream.py

@@ -0,0 +1,434 @@
+from datetime import datetime, timezone
+from gql import gql
+from typing import List
+from specklepy.logging import metrics
+from specklepy.api.models import ActivityCollection, Stream
+from specklepy.api.resource import ResourceBase
+from specklepy.logging.exceptions import SpeckleException
+
+
+NAME = "stream"
+METHODS = ["list", "create", "get", "update", "delete", "search", "activity"]
+
+
+class Resource(ResourceBase):
+    """API Access class for streams"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+            methods=METHODS,
+        )
+
+        self.schema = Stream
+
+    def get(self, id: str, branch_limit: int = 10, commit_limit: int = 10) -> Stream:
+        """Get the specified stream from the server
+
+        Arguments:
+            id {str} -- the stream id
+            branch_limit {int} -- the maximum number of branches to return
+            commit_limit {int} -- the maximum number of commits to return
+
+        Returns:
+            Stream -- the retrieved stream
+        """
+        metrics.track(metrics.STREAM, self.account, {"name": "get"})
+        query = gql(
+            """
+            query Stream($id: String!, $branch_limit: Int!, $commit_limit: Int!) {
+                stream(id: $id) {
+                    id
+                    name
+                    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
+        """
+        metrics.track(metrics.STREAM, self.account, {"name": "get"})
+        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
+        """
+        metrics.track(metrics.STREAM, self.account, {"name": "create"})
+        query = gql(
+            """
+            mutation StreamCreate($stream: StreamCreateInput!) {
+              streamCreate(stream: $stream)
+            }
+        """
+        )
+
+        params = {
+            "stream": {"name": name, "description": description, "isPublic": is_public}
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type="streamCreate", parse_response=False
+        )
+
+    def update(
+        self, id: str, name: str = None, description: str = None, is_public: bool = None
+    ) -> bool:
+        """Update an existing stream
+
+        Arguments:
+            id {str} -- the id of the stream to be updated
+            name {str} -- the name of the string
+            description {str} -- a short description of the stream
+            is_public {bool} -- whether or not the stream can be viewed by anyone with the id
+
+        Returns:
+            bool -- whether the stream update was successful
+        """
+        metrics.track(metrics.STREAM, self.account, {"name": "update"})
+        query = gql(
+            """
+            mutation StreamUpdate($stream: StreamUpdateInput!) {
+                streamUpdate(stream: $stream)
+            }
+        """
+        )
+
+        params = {
+            "id": id,
+            "name": name,
+            "description": description,
+            "isPublic": is_public,
+        }
+        # remove None values so graphql doesn't cry
+        params = {"stream": {k: v for k, v in params.items() if v is not None}}
+
+        return self.make_request(
+            query=query, params=params, return_type="streamUpdate", parse_response=False
+        )
+
+    def delete(self, id: str) -> bool:
+        """Delete a stream given its id
+
+        Arguments:
+            id {str} -- the id of the stream to delete
+
+        Returns:
+            bool -- whether the deletion was successful
+        """
+        metrics.track(metrics.STREAM, self.account, {"name": "delete"})
+        query = gql(
+            """
+            mutation StreamDelete($id: String!) {
+                streamDelete(id: $id)
+            }
+            """
+        )
+
+        params = {"id": id}
+
+        return self.make_request(
+            query=query, params=params, return_type="streamDelete", parse_response=False
+        )
+
+    def search(
+        self,
+        search_query: str,
+        limit: int = 25,
+        branch_limit: int = 10,
+        commit_limit: int = 10,
+    ):
+        """Search for streams by name, description, or id
+
+        Arguments:
+            search_query {str} -- a string to search for
+            limit {int} -- the maximum number of results to return
+            branch_limit {int} -- the maximum number of branches to return
+            commit_limit {int} -- the maximum number of commits to return
+
+        Returns:
+            List[Stream] -- a list of Streams that match the search query
+        """
+        metrics.track(metrics.STREAM, self.account, {"name": "search"})
+        query = gql(
+            """
+            query StreamSearch($search_query: String!,$limit: Int!, $branch_limit:Int!, $commit_limit:Int!) {
+                streams(query: $search_query, limit: $limit) {
+                    items {
+                        id
+                        name
+                        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
+        """
+        metrics.track(metrics.PERMISSION, self.account, {"name": "add", "role": role})
+        query = gql(
+            """
+            mutation StreamGrantPermission($permission_params: StreamGrantPermissionInput !) {
+                streamGrantPermission(permissionParams: $permission_params)
+            }
+            """
+        )
+
+        params = {
+            "permission_params": {
+                "streamId": stream_id,
+                "userId": user_id,
+                "role": role,
+            }
+        }
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamGrantPermission",
+            parse_response=False,
+        )
+
+    def revoke_permission(self, stream_id: str, user_id: str):
+        """Revoke permissions from a user on a given stream
+
+        Arguments:
+            stream_id {str} -- the id of the stream to revoke permissions from
+            user_id {str} -- the id of the user to revoke permissions from
+
+        Returns:
+            bool -- True if the operation was successful
+        """
+        metrics.track(metrics.PERMISSION, self.account, {"name": "revoke"})
+        query = gql(
+            """
+            mutation StreamRevokePermission($permission_params: StreamRevokePermissionInput !) {
+                streamRevokePermission(permissionParams: $permission_params)
+            }
+            """
+        )
+
+        params = {"permission_params": {"streamId": stream_id, "userId": user_id}}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamRevokePermission",
+            parse_response=False,
+        )
+
+    def activity(
+        self,
+        stream_id: str,
+        action_type: str = None,
+        limit: int = 20,
+        before: datetime = None,
+        after: datetime = None,
+        cursor: datetime = None,
+    ):
+        """
+        Get the activity from a given stream in an Activity collection. Step into the activity `items` for the list of activity.
+
+        Note: all timestamps arguments should be `datetime` of any tz as they will be converted to UTC ISO format strings
+
+        stream_id {str} -- the id of the stream to get activity from
+        action_type {str} -- filter results to a single action type (eg: `commit_create` or `commit_receive`)
+        limit {int} -- max number of Activity items to return
+        before {datetime} -- latest cutoff for activity (ie: return all activity _before_ this time)
+        after {datetime} -- oldest cutoff for activity (ie: return all activity _after_ this time)
+        cursor {datetime} -- timestamp cursor for pagination
+        """
+        query = gql(
+            """
+            query StreamActivity($stream_id: String!, $action_type: String, $before:DateTime, $after: DateTime, $cursor: DateTime, $limit: Int){
+                stream(id: $stream_id) {
+                    activity(actionType: $action_type, before: $before, after: $after, cursor: $cursor, limit: $limit) {
+                        totalCount
+                        cursor
+                        items {
+                            actionType
+                            info
+                            userId
+                            streamId
+                            resourceId
+                            resourceType
+                            message
+                            time
+                        }
+                    }
+                }
+            }
+            """
+        )
+        try:
+            params = {
+                "stream_id": stream_id,
+                "limit": limit,
+                "action_type": action_type,
+                "before": before.astimezone(timezone.utc).isoformat()
+                if before
+                else before,
+                "after": after.astimezone(timezone.utc).isoformat() if after else after,
+                "cursor": cursor.astimezone(timezone.utc).isoformat()
+                if cursor
+                else cursor,
+            }
+        except AttributeError as e:
+            raise SpeckleException(
+                "Could not get stream activity - `before`, `after`, and `cursor` must be in `datetime` format if provided",
+                ValueError,
+            ) from e
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type=["stream", "activity"],
+            schema=ActivityCollection,
+        )

specklepy/api/resources/subscriptions.py

@@ -1,9 +1,9 @@
-from typing import Callable, Dict, List, Optional, Any
+from typing import Callable, Dict, List
 from functools import wraps
 from gql import gql
-from speckle.api.resource import ResourceBase
-from speckle.api.resources.stream import Stream
-from speckle.logging.exceptions import GraphQLException, SpeckleException
+from specklepy.api.resource import ResourceBase
+from specklepy.api.resources.stream import Stream
+from specklepy.logging.exceptions import SpeckleException
 
 NAME = "subscribe"
 METHODS = [
@@ -29,9 +29,13 @@ 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,
+            methods=METHODS,
         )
 
     @check_wsclient
@@ -122,4 +126,4 @@ class Resource(ResourceBase):
                 if callback is not None:
                     callback(res)
                 else:
-                    return res
+                    return res

specklepy/api/resources/user.py

@@ -0,0 +1,190 @@
+from datetime import datetime, timezone
+from specklepy.logging import metrics
+from specklepy.logging.exceptions import SpeckleException
+from typing import List
+from gql import gql
+from specklepy.api.resource import ResourceBase
+from specklepy.api.models import ActivityCollection, User
+
+NAME = "user"
+METHODS = ["get", "search", "update", "activity"]
+
+
+class Resource(ResourceBase):
+    """API Access class for users"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            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
+        """
+        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")
+
+    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"
+            )
+
+        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"]
+        )
+
+    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
+        """
+        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,
+        user_id: str = None,
+        limit: int = 20,
+        action_type: str = None,
+        before: datetime = None,
+        after: datetime = None,
+        cursor: datetime = None,
+    ):
+        """
+        Get the activity from a given stream in an Activity collection. Step into the activity `items` for the list of activity.
+        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,
+        )

specklepy/api/wrapper.py

@@ -0,0 +1,166 @@
+from warnings import warn
+from urllib.parse import urlparse, unquote
+from specklepy.api.credentials import (
+    Account,
+    get_account_from_token,
+    get_local_accounts,
+)
+from specklepy.logging import metrics
+from specklepy.api.client import SpeckleClient
+from specklepy.transports.server.server import ServerTransport
+from specklepy.logging.exceptions import SpeckleException, SpeckleWarning
+
+
+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: {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 in a.serverInfo.url),
+            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)

specklepy/logging/exceptions.py

@@ -0,0 +1,35 @@
+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}"
+
+
+class SpeckleWarning(Warning):
+    def __init__(self, *args: object) -> None:
+        super().__init__(*args)

specklepy/logging/metrics.py

@@ -0,0 +1,139 @@
+import json
+import os
+import socket
+import sys
+import queue
+import hashlib
+import logging
+import requests
+import threading
+
+"""
+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"
+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"
+COMMIT = "Commit Action"
+BRANCH = "Branch Action"
+USER = "User Action"
+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):
+    global HOST_APP
+    HOST_APP = host_app
+
+
+def track(action: str, account: "Account" = None, custom_props: 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,
+                "$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.error("Error queueing metrics request: " + str(ex))
+
+
+def initialise_tracker(account: "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"
+    user_ip = None
+    last_user = None
+    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()
+        self.user_ip = socket.gethostbyname(socket.gethostname())
+
+    def set_last_user(self, email: str):
+        if not email:
+            return
+        self.last_user = "@" + 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.error("Error sending metrics request: " + str(ex))
+
+            self.queue.task_done()

specklepy/objects/__init__.py

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

specklepy/objects/base.py

@@ -0,0 +1,413 @@
+from typing import (
+    Any,
+    ClassVar,
+    Dict,
+    List,
+    Optional,
+    Union,
+    Set,
+    Type,
+    get_type_hints,
+)
+
+import contextlib
+from enum import EnumMeta
+from warnings import warn
+
+from specklepy.logging.exceptions import SpeckleException
+from specklepy.objects.units import 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]
+    _type_registry: ClassVar[Dict[str, "Base"]] = {}
+    _attr_types: ClassVar[Dict[str, Type]] = {}
+
+    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: str = None,
+        chunkable: Dict[str, int] = None,
+        detachable: Set[str] = None,
+        serialize_ignore: 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.
+        """
+        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
+        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)
+
+
+class Base(_RegisteringBase):
+    id: Optional[str] = None
+    totalChildrenCount: Optional[int] = None
+    applicationId: Optional[str] = None
+    _units: str = "m"
+    # 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()
+
+    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):
+        """
+        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)
+
+        if t is None or t is Any:
+            return value
+
+        if value is None:
+            return None
+
+        if isinstance(t, EnumMeta) and (value in t._value2member_map_):
+            return t(value)
+
+        if t.__module__ == "typing":
+            origin = getattr(t, "__origin__")
+            t = (
+                tuple(getattr(sub_t, "__origin__", sub_t) for sub_t in t.__args__)
+                if origin is Union
+                else origin
+            )
+
+            if not isinstance(t, (type, tuple)):
+                warn(
+                    f"Unrecognised type '{t}' provided for attribute '{name}'. Type will not been validated."
+                )
+                return value
+        if isinstance(value, t):
+            return value
+
+        # to be friendly, we'll parse ints and strs into floats, but not the other way around
+        # (to avoid unexpected rounding)
+        if isinstance(t, tuple):
+            t = t[0]
+
+        with contextlib.suppress(ValueError):
+            if t is float:
+                return float(value)
+            if t is str and value:
+                return str(value)
+
+        raise SpeckleException(
+            f"Cannot set '{self.__class__.__name__}.{name}': it expects type '{t.__name__}', 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 strings
+        """
+        self._detachable = self._detachable.union(names)
+
+    @property
+    def units(self):
+        return self._units
+
+    @units.setter
+    def units(self, value: str):
+        units = get_units_from_string(value)
+        if units:
+            self._units = units
+
+    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 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:
+        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: List[Any] = None
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.data = []

specklepy/objects/encoding.py

@@ -0,0 +1,136 @@
+from enum import Enum
+from typing import Any, Callable, List, 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) -> None:
+        self.data = []
+
+    @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(object=obj)
+
+        return data_list
+
+    @staticmethod
+    def decode_data(
+        data: List[Any], decoder: Callable[[List[Any]], Base]
+    ) -> List[Base]:
+        bases = []
+        if not data:
+            return bases
+
+        index = 0
+        while index < len(data):
+            item_length = data[index]
+            item_start = index + 1
+            item_end = item_start + item_length
+            item_data = data[item_start:item_end]
+            index = item_end
+            # TODO: investigate what's going on w this fail
+            try:
+                decoded_data = decoder(item_data)
+                bases.append(decoded_data)
+            except ValueError:
+                continue
+        return bases
+
+    def decode(self, decoder: Callable[[List[Any]], Any]):
+        return self.decode_data(data=self.data, decoder=decoder)
+
+    def encode_object(self, object: Base):
+        encoded = object.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()
+        crv_array.data = data
+        return crv_array.to_curve()
+
+    def to_curves(self) -> List[Base]:
+        return self.decode(decoder=self._curve_decoder)

specklepy/objects/fakemesh.py

@@ -0,0 +1,52 @@
+from enum import Enum
+from typing import List
+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: List[Base] = None
+    dots: List[int] = None
+
+
+class FakeDirection(Enum):
+    NORTH = 1
+    EAST = 2
+    SOUTH = 3
+    WEST = 4
+
+
+class FakeMesh(FakeGeo, chunkable=CHUNKABLE_PROPS, detachable=DETACHABLE):
+    vertices: List[float] = None
+    faces: List[int] = None
+    colors: List[int] = None
+    textureCoordinates: List[float] = None
+    cardinal_dir: FakeDirection = 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

@@ -0,0 +1,772 @@
+from enum import Enum
+from typing import Any, List, Optional
+
+from .base import Base
+from .encoding import CurveArray, CurveTypeEncoding, ObjectArray
+from .units import get_encoding_from_units, get_units_from_encoding
+
+GEOMETRY = "Objects.Geometry."
+
+
+class Interval(Base, speckle_type="Objects.Primitive.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 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: {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 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()
+
+    @classmethod
+    def from_list(cls, args: List[Any]) -> "Plane":
+        return cls(
+            origin=Point.from_list(args[0:3]),
+            normal=Vector.from_list(args[3:6]),
+            xdir=Vector.from_list(args[6:9]),
+            ydir=Vector.from_list(args[9:12]),
+        )
+
+    def to_list(self) -> List[Any]:
+        encoded = []
+        encoded.extend(self.origin.to_list())
+        encoded.extend(self.normal.to_list())
+        encoded.extend(self.xdir.to_list())
+        encoded.extend(self.ydir.to_list())
+        return encoded
+
+
+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
+
+    @classmethod
+    def from_list(cls, args: List[Any]) -> "Line":
+        return cls(
+            start=Point.from_list(args[0:3]),
+            end=Point.from_list(args[3:6]),
+            domain=Interval.from_list(args[6:9]),
+        )
+
+    def to_list(self) -> List[Any]:
+        encoded = []
+        encoded.extend(self.start.to_list())
+        encoded.extend(self.end.to_list())
+        encoded.extend(self.domain.to_list())
+        return encoded
+
+
+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
+
+    @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]),
+            units=get_units_from_encoding(args[-1]),
+        )
+
+    def to_list(self) -> List[Any]:
+        encoded = []
+        encoded.append(CurveTypeEncoding.Arc.value)
+        encoded.append(self.radius)
+        encoded.append(self.startAngle)
+        encoded.append(self.endAngle)
+        encoded.append(self.angleRadians)
+        encoded.extend(self.domain.to_list())
+        encoded.extend(self.plane.to_list())
+        encoded.append(get_encoding_from_units(self.units))
+        return encoded
+
+
+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
+
+    @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]:
+        encoded = []
+        encoded.append(CurveTypeEncoding.Circle.value)
+        encoded.append(self.radius),
+        encoded.extend(self.domain.to_list())
+        encoded.extend(self.plane.to_list())
+        encoded.append(get_encoding_from_units(self.units))
+        return encoded
+
+
+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
+
+    @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]:
+        encoded = []
+        encoded.append(CurveTypeEncoding.Ellipse.value)
+        encoded.append(self.firstRadius)
+        encoded.append(self.secondRadius)
+        encoded.extend(self.domain.to_list())
+        encoded.extend(self.plane.to_list())
+        encoded.append(get_encoding_from_units(self.units))
+        return encoded
+
+
+class Polyline(Base, speckle_type=GEOMETRY + "Polyline", chunkable={"value": 20000}):
+    value: List[float] = None
+    closed: bool = None
+    domain: Interval = None
+    bbox: Box = None
+    area: float = None
+    length: 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]:
+        encoded = []
+        encoded.append(CurveTypeEncoding.Polyline.value)
+        encoded.append(int(self.closed))
+        encoded.extend(self.domain.to_list())
+        encoded.append(len(self.value))
+        encoded.extend(self.value)
+        encoded.append(get_encoding_from_units(self.units))
+        return encoded
+
+    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 Curve(
+    Base,
+    speckle_type=GEOMETRY + "Curve",
+    chunkable={"points": 20000, "weights": 20000, "knots": 20000},
+):
+    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 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 = args[7]
+        weights_count = args[8]
+        knots_count = 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=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]:
+        encoded = []
+        encoded.append(CurveTypeEncoding.Curve.value)
+        encoded.append(self.degree)
+        encoded.append(int(self.periodic))
+        encoded.append(int(self.rational))
+        encoded.append(int(self.closed))
+        encoded.extend(self.domain.to_list())
+        encoded.append(len(self.points))
+        encoded.append(len(self.weights))
+        encoded.append(len(self.knots))
+        encoded.extend(self.points)
+        encoded.extend(self.weights)
+        encoded.extend(self.knots)
+        encoded.append(get_encoding_from_units(self.units))
+        return encoded
+
+
+class Polycurve(Base, speckle_type=GEOMETRY + "Polycurve"):
+    segments: List[Base] = None
+    domain: Interval = None
+    closed: bool = None
+    bbox: Box = None
+    area: float = None
+    length: float = None
+
+    @classmethod
+    def from_list(cls, args: List[Any]) -> "Polycurve":
+        curve_arrays = CurveArray()
+        curve_arrays.data = args[4:-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]:
+        encoded = []
+        encoded.append(CurveTypeEncoding.Polycurve.value)
+        encoded.append(int(self.closed))
+        encoded.extend(self.domain.to_list())
+        curve_array = CurveArray.from_curves(self.segments)
+        encoded.extend(curve_array.data)
+        encoded.append(get_encoding_from_units(self.units))
+        return encoded
+
+
+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",
+    chunkable={
+        "vertices": 2000,
+        "faces": 2000,
+        "colors": 2000,
+        "textureCoordinates": 2000,
+    },
+):
+    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
+
+    @classmethod
+    def create(
+        cls,
+        vertices: List[float],
+        faces: List[int],
+        colors: List[int] = None,
+        texture_coordinates: 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: int = None
+    degreeV: int = None
+    rational: bool = None
+    area: float = None
+    pointData: List[float] = None
+    countU: int = None
+    countV: int = None
+    bbox: Box = None
+    closedU: bool = None
+    closedV: bool = None
+    domainU: Interval = None
+    domainV: Interval = None
+    knotsU: List[float] = None
+    knotsV: 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]:
+        encoded = []
+        encoded.append(self.degreeU)
+        encoded.append(self.degreeV)
+        encoded.append(self.countU)
+        encoded.append(self.countV)
+        encoded.append(int(self.rational))
+        encoded.append(int(self.closedU))
+        encoded.append(int(self.closedV))
+        encoded.extend(self.domainU.to_list())
+        encoded.extend(self.domainV.to_list())
+        encoded.append(len(self.pointData))
+        encoded.append(len(self.knotsU))
+        encoded.append(len(self.knotsV))
+        encoded.extend(self.pointData)
+        encoded.extend(self.knotsU)
+        encoded.extend(self.knotsV)
+        encoded.append(get_encoding_from_units(self.units))
+        return encoded
+
+
+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):
+        if self.LoopIndices:
+            return [self._Brep.Loops[i] for i 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):
+        if self.TrimIndices:
+            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):
+        if self.TrimIndices:
+            return [self._Brep.Trims[i] for i in self.TrimIndices]
+
+
+class BrepTrimTypeEnum(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: "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]
+
+    @classmethod
+    def from_list(cls, args: List[Any]) -> "BrepTrim":
+        return cls(
+            EdgeIndex=args[0],
+            StartIndex=args[1],
+            EndIndex=args[2],
+            FaceIndex=args[3],
+            LoopIndex=args[4],
+            CurveIndex=args[5],
+            IsoStatus=args[6],
+            TrimType=BrepTrimTypeEnum(args[7]).name,
+            IsReversed=bool(args[8]),
+        )
+
+    def to_list(self) -> List[Any]:
+        encoded = []
+        encoded.append(self.EdgeIndex)
+        encoded.append(self.StartIndex)
+        encoded.append(self.EndIndex)
+        encoded.append(self.FaceIndex)
+        encoded.append(self.LoopIndex)
+        encoded.append(self.CurveIndex)
+        encoded.append(self.IsoStatus)
+        encoded.append(getattr(BrepTrimTypeEnum, self.TrimType).value)
+        encoded.append(self.IsReversed)
+        return encoded
+
+
+class Brep(
+    Base,
+    speckle_type=GEOMETRY + "Brep",
+    chunkable={
+        "SurfacesValue": 200,
+        "Curve3DValues": 200,
+        "Curve2DValues": 200,
+        "VerticesValue": 5000,
+        "Edges": 5000,
+        "Loops": 5000,
+        "TrimsValue": 5000,
+        "Faces": 5000,
+    },
+    detachable={"displayValue"},
+    serialize_ignore={"Surfaces", "Curve3D", "Curve2D", "Vertices", "Trims"},
+):
+    provenance: str = None
+    bbox: Box = None
+    area: float = None
+    volume: float = None
+    _displayValue: List[Mesh] = None
+    Surfaces: List[Surface] = None
+    Curve3D: List[Base] = None
+    Curve2D: List[Base] = None
+    Vertices: List[Point] = None
+    IsClosed: bool = None
+    Orientation: 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
+        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 Edges(self) -> List[BrepEdge]:
+        return self._inject_self_into_children(self._Edges)
+
+    @Edges.setter
+    def Edges(self, value: List[BrepEdge]):
+        self._Edges = value
+
+    @property
+    def Loops(self) -> List[BrepLoop]:
+        return self._inject_self_into_children(self._Loops)
+
+    @Loops.setter
+    def Loops(self, value: List[BrepLoop]):
+        self._Loops = value
+
+    @property
+    def Faces(self) -> List[BrepFace]:
+        return self._inject_self_into_children(self._Faces)
+
+    @Faces.setter
+    def Faces(self, value: List[BrepFace]):
+        self._Faces = value
+
+    @property
+    def SurfacesValue(self) -> List[float]:
+        if self.Surfaces is None:
+            return None
+        return ObjectArray.from_objects(self.Surfaces).data
+
+    @SurfacesValue.setter
+    def SurfacesValue(self, value: List[float]):
+        self.Surfaces = ObjectArray.decode_data(value, Surface.from_list)
+
+    @property
+    def Curve3DValues(self) -> List[float]:
+        if self.Curve3D is None:
+            return None
+        return CurveArray.from_curves(self.Curve3D).data
+
+    @Curve3DValues.setter
+    def Curve3DValues(self, value: List[float]):
+        crv_array = CurveArray()
+        crv_array.data = value
+        self.Curve3D = crv_array.to_curves()
+
+    @property
+    def Curve2DValues(self) -> List[Base]:
+        if self.Curve2D is None:
+            return None
+        return CurveArray.from_curves(self.Curve2D).data
+
+    @Curve2DValues.setter
+    def Curve2DValues(self, value: List[float]):
+        crv_array = CurveArray()
+        crv_array.data = 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
+
+    @property
+    def Trims(self) -> List[BrepTrim]:
+        return self._inject_self_into_children(self._Trims)
+
+    @Trims.setter
+    def Trims(self, value: List[BrepTrim]):
+        self._Trims = value
+
+    @property
+    def TrimsValue(self) -> List[float]:
+        if self.Trims is None:
+            return None
+        values = []
+        for trim in self.Trims:
+            values.extend(trim.to_list())
+        return values
+
+    @TrimsValue.setter
+    def TrimsValue(self, value: List[float]):
+        self.Trims = [
+            BrepTrim.from_list(value[i : i + 9]) for i in range(0, len(value), 9)
+        ]
+
+
+BrepEdge.update_forward_refs()
+BrepLoop.update_forward_refs()
+BrepTrim.update_forward_refs()
+BrepFace.update_forward_refs()

specklepy/objects/other.py

@@ -0,0 +1,214 @@
+from typing import Any, List
+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 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
+
+
+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: 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(
+                f"Could not create a Transform object with the requested value. Input must be a 16 element list of numbers. Value provided: {value}"
+            ) from error
+
+        if len(value) != 16:
+            raise ValueError(
+                f"Could not create a Transform object: input list should be 16 floats 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: 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: str = None
+    basePoint: Point = None
+    geometry: List[Base] = None
+
+
+class BlockInstance(
+    Base, speckle_type=OTHER + "BlockInstance", detachable={"blockDefinition"}
+):
+    blockDefinition: BlockDefinition = None
+    transform: 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: str = None
+    value: Any = None
+    applicationUnitType: str = None  # eg UnitType UT_Length
+    applicationUnit: str = None  # DisplayUnitType eg DUT_MILLIMITERS
+    applicationInternalName: str = (
+        None  # BuiltInParameterName or GUID for shared parameter
+    )
+    isShared: bool = False
+    isReadOnly: bool = False
+    isTypeParameter: bool = False

specklepy/objects/structural/__init__.py

@@ -0,0 +1,40 @@
+"""Builtin Speckle object kit."""
+
+from specklepy.objects.structural.analysis import *
+from specklepy.objects.structural.properties import *
+from specklepy.objects.structural.material import *
+from specklepy.objects.structural.geometry import *
+from specklepy.objects.structural.loading import *
+from specklepy.objects.structural.axis import Axis
+
+__all__ = [
+    "Element1D",
+    "Element2D",
+    "Element3D",
+    "Axis",
+    "Node",
+    "Restraint",
+    "Load",
+    "LoadBeam",
+    "LoadCase",
+    "LoadCombinations",
+    "LoadFace",
+    "LoadGravity",
+    "LoadNode",
+    "Model",
+    "ModelInfo",
+    "ModelSettings",
+    "ModelUnits",
+    "Concrete",
+    "Material",
+    "Steel",
+    "Timber",
+    "Property",
+    "Property1D",
+    "Property2D",
+    "Property3D",
+    "PropertyDamper",
+    "PropertyMass",
+    "PropertySpring",
+    "SectionProfile",
+]

specklepy/objects/structural/analysis.py

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

specklepy/objects/structural/axis.py

@@ -0,0 +1,8 @@
+from ..base import Base
+from ..geometry import Plane
+
+
+class Axis(Base, speckle_type="Objects.Structural.Geometry.Axis"):
+    name: str = None
+    axisType: str = None
+    plane: Plane = None

specklepy/objects/structural/geometry.py

@@ -0,0 +1,108 @@
+from enum import Enum
+from typing import List
+
+from ..base import Base
+from ..geometry import *
+from .properties import *
+from .axis import Axis
+
+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: 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
+    units: str = None
+
+
+class Node(Base, speckle_type=STRUCTURAL_GEOMETRY + ".Node"):
+    name: str = None
+    basePoint: Point = None
+    constraintAxis: Axis = None
+    restraint: Restraint = None
+    springProperty: PropertySpring = None
+    massProperty: PropertyMass = None
+    damperProperty: PropertyDamper = None
+    units: str = None
+
+
+class Element1D(Base, speckle_type=STRUCTURAL_GEOMETRY + ".Element1D"):
+    name: str = None
+    baseLine: Line = None
+    property: Property1D = None
+    type: ElementType1D = None
+    end1Releases: Restraint = None
+    end2Releases: Restraint = None
+    end1Offset: Vector = None
+    end2Offset: Vector = None
+    orientationNode: Node = None
+    orinetationAngle: float = 0.0
+    localAxis: Plane = None
+    parent: Base = None
+    end1Node: Node = Node
+    end2Node: Node = Node
+    topology: List = None
+    displayMesh: Mesh = None
+    units: str = None
+
+
+class Element2D(Base, speckle_type=STRUCTURAL_GEOMETRY + ".Element2D"):
+    name: str = None
+    property: Property2D = None
+    type: ElementType2D = None
+    offset: float = 0.0
+    orientationAngle: float = 0.0
+    parent: Base = None
+    topology: List = None
+    displayMesh: Mesh = None
+    units: str = None
+
+
+class Element3D(Base, speckle_type=STRUCTURAL_GEOMETRY + ".Element3D"):
+    name: str = None
+    baseMesh: Mesh = None
+    property: Property3D = None
+    type: ElementType3D = None
+    orientationAngle: float = 0.0
+    parent: Base = None
+    topology: List
+    units: str = None
+
+
+# class Storey needs ependency on built elements first

specklepy/objects/structural/loading.py

@@ -0,0 +1,144 @@
+from enum import Enum
+from typing import List
+
+from ..base import Base
+from .geometry import *
+
+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: str = None
+    loadType: LoadType = None
+    group: str = None
+    actionType: ActionType = None
+    description: str = None
+
+
+class Load(Base, speckle_type=STRUCTURAL_LOADING + "Load"):
+    name: str = None
+    units: str = None
+    loadCase: LoadCase = None
+
+
+class LoadBeam(Load, speckle_type=STRUCTURAL_LOADING + "LoadBeam"):
+    elements: List = None
+    loadType: BeamLoadType = None
+    direction: LoadDirection = None
+    loadAxis: Axis = None
+    loadAxisType: LoadAxisType = None
+    isProjected: bool = None
+    values: List = None
+    positions: List = None
+
+
+class LoadCombinations(Base, speckle_type=STRUCTURAL_LOADING + "LoadCombination"):
+    name: str = None
+    loadCases: List
+    loadFactors: List
+    combinationType: CombinationType
+
+
+class LoadFace(Load, speckle_type=STRUCTURAL_LOADING + "LoadFace"):
+    elements: List = None
+    loadType: FaceLoadType = None
+    direction: LoadDirection2D = None
+    loadAxis: Axis = None
+    loadAxisType: LoadAxisType = None
+    isProjected: bool = None
+    values: List = None
+    positions: List = None
+
+
+class LoadGravity(Load, speckle_type=STRUCTURAL_LOADING + "LoadGravity"):
+    elements: List = None
+    nodes: List = None
+    gravityFactors: Vector = None
+
+
+class LoadNode(Load, speckle_type=STRUCTURAL_LOADING + "LoadNode"):
+    nodes: List = None
+    loadAxis: Axis = None
+    direction: LoadDirection = None
+    value: float = 0.0

specklepy/objects/structural/material.py

@@ -0,0 +1,59 @@
+from enum import Enum
+
+from ..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 Material(Base, speckle_type=STRUCTURAL_MATERIALS):
+    name: str = None
+    grade: str = None
+    materialType: MaterialType = None
+    designCode: str = None
+    codeYear: 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(Material, speckle_type=STRUCTURAL_MATERIALS + ".Concrete"):
+    compressiveStrength: float = 0.0
+    tensileStrength: float = 0.0
+    flexuralStrength: float = 0.0
+    maxCompressiveStrength: float = 0.0
+    maxTensileStrength: float = 0.0
+    maxAggregateSize: float = 0.0
+    lightweight: bool = None
+
+
+class Steel(Material, speckle_type=STRUCTURAL_MATERIALS + ".Steel"):
+    yieldStrength: float = 0.0
+    ultimateStrength: float = 0.0
+    maxStrain: float = 0.0
+    strainHardeningModulus: float = 0.0
+
+
+class Timber(Material, speckle_type=STRUCTURAL_MATERIALS + ".Timber"):
+    species: str = None

specklepy/objects/structural/properties.py

@@ -0,0 +1,212 @@
+from enum import Enum
+
+from ..base import Base
+
+from .material import *
+from .axis import Axis
+
+
+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
+    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: str = None
+
+
+class SectionProfile(Base, speckle_type=STRUCTURAL_PROPERTY + ".SectionProfile"):
+    name: str = None
+    shapeType: 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
+    units: str = None
+
+
+class Property1D(Property, speckle_type=STRUCTURAL_PROPERTY + ".Property1D"):
+    memberType: MemberType = None
+    Material: Material = None
+    SectionProfile: SectionProfile = None
+    BaseReferencePoint: BaseReferencePoint = None
+    offsetY: float = 0.0
+    offsetZ: float = 0.0
+
+
+class Property2D(Property, speckle_type=STRUCTURAL_PROPERTY + ".Property2D"):
+    PropertyType2D: PropertyType2D = None
+    thickness: float = 0.0
+    Material: Material = None
+    axis: Axis = None
+    referenceSurface: 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"):
+    PropertyType3D: PropertyType3D = None
+    Material: Material = None
+    axis: Axis = None
+
+
+class PropertyDamper(Property, speckle_type=STRUCTURAL_PROPERTY + ".PropertyDamper"):
+    damperType: 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: bool = None
+    massModifierX: float = 0.0
+    massModifierY: float = 0.0
+    massModifierZ: float = 0.0
+
+
+class PropertySpring(Property, speckle_type=STRUCTURAL_PROPERTY + ".PropertySpring"):
+    springType: 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

specklepy/objects/structural/results.py

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

specklepy/objects/units.py

@@ -0,0 +1,64 @@
+from warnings import warn
+from specklepy.logging.exceptions import SpeckleException, SpeckleWarning
+
+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"],
+    "km": ["km", "kilometer", "kilometre", "kilometers", "kilometres"],
+    "in": ["in", "inch", "inches"],
+    "ft": ["ft", "foot", "feet"],
+    "yd": ["yd", "yard", "yards"],
+    "mi": ["mi", "mile", "miles"],
+    "none": ["none", "null"],
+}
+
+UNITS_ENCODINGS = {
+    "none": 0,
+    "mm": 1,
+    "cm": 2,
+    "m": 3,
+    "km": 4,
+    "in": 5,
+    "ft": 6,
+    "yd": 7,
+    "mi": 8,
+}
+
+
+def get_units_from_string(unit: str):
+    if not isinstance(unit, str):
+        warn(
+            f"Invalid units: expected type str but received {type(unit)} ({unit}). Skipping - no units will be set.",
+            SpeckleWarning,
+        )
+        return
+    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})."
+    )
+
+
+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. Please enter a valid unit encoding (eg {UNITS_ENCODINGS})."
+    )
+
+
+def get_encoding_from_units(unit: str):
+    try:
+        return UNITS_ENCODINGS[unit]
+    except KeyError:
+        raise SpeckleException(
+            message=f"No encoding exists for unit {unit}. Please enter a valid unit to encode (eg {UNITS_ENCODINGS})."
+        )

specklepy/serialization/base_object_serializer.py

@@ -0,0 +1,387 @@
+import ujson
+import hashlib
+import re
+from uuid import uuid4
+from enum import Enum
+from warnings import warn
+from typing import Any, Dict, List, Tuple
+from specklepy.objects.base import Base, DataChunk
+from specklepy.logging.exceptions import (
+    SerializationException,
+    SpeckleException,
+    SpeckleWarning,
+)
+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(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 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]] = {}
+
+    def __init__(
+        self, write_transports: List[AbstractTransport] = [], read_transport=None
+    ) -> None:
+        self.write_transports = write_transports
+        self.read_transport = read_transport
+
+    def write_json(self, base: Base):
+        self.__reset_writer()
+        self.detach_lineage = [True]
+        hash, obj = self.traverse_base(base)
+        return hash, ujson.dumps(obj)
+
+    def traverse_base(self, base: Base) -> Tuple[str, Dict]:
+        """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
+        """
+        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_serializable_attributes()
+
+        while props:
+            prop = props.pop(0)
+            value = getattr(obj, prop, None)
+            chunkable = False
+            detach = False
+
+            # skip props marked to be ignored with "__" or "_"
+            if prop.startswith(("__", "_")):
+                continue
+
+            # don't prepopulate id as this will mess up hashing
+            if prop == "id":
+                continue
+
+            # allow serialisation of nulls
+            if value is None:
+                object_builder[prop] = value
+                continue
+
+            # only bother with chunking and detaching if there is a write transport
+            if self.write_transports:
+                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] = (
+                        int(chunk_size) if chunk_size else base._chunk_size_default
+                    )
+
+                chunkable = prop in base._chunkable
+                detach = bool(
+                    prop.startswith("@") or prop in base._detachable or chunkable
+                )
+
+            # 1. handle primitives (ints, floats, strings, and bools)
+            if 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)
+                else:
+                    object_builder[prop] = child_obj
+
+            # 3. handle chunkable props
+            elif chunkable and self.write_transports:
+                chunks = []
+                max_size = base._chunkable[prop]
+                chunk = DataChunk()
+                for count, item in enumerate(value):
+                    if count and count % max_size == 0:
+                        chunks.append(chunk)
+                        chunk = DataChunk()
+                    chunk.data.append(item)
+                chunks.append(chunk)
+
+                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)
+                    chunk_refs.append(ref_obj)
+                object_builder[prop] = chunk_refs
+
+            # 4. handle all other cases
+            else:
+                child_obj = self.traverse_value(value, detach)
+                object_builder[prop] = child_obj
+
+        closure = {}
+        # add closures & children count to the object
+        detached = self.detach_lineage.pop()
+        if self.lineage[-1] in self.family_tree:
+            closure = {
+                ref: depth - len(self.detach_lineage)
+                for ref, depth in self.family_tree[self.lineage[-1]].items()
+            }
+        object_builder["totalChildrenCount"] = len(closure)
+
+        hash = hash_obj(object_builder)
+
+        object_builder["id"] = hash
+        if closure:
+            object_builder["__closure"] = self.closure_table[hash] = 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=ujson.dumps(object_builder))
+
+        del self.lineage[-1]
+
+        return hash, object_builder
+
+    def traverse_value(self, obj: Any, detach: bool = False) -> Any:
+        """Decomposes a given object and constructs a serializable object or dictionary
+
+        Arguments:
+            obj {Any} -- the value to decompose
+
+        Returns:
+            Any -- a serializable version of the given object
+        """
+        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]
+
+            detached_list = []
+            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))
+                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) or v is None:
+                    continue
+                else:
+                    obj[k] = self.traverse_value(v)
+            return obj
+
+        elif isinstance(obj, Base):
+            self.detach_lineage.append(detach)
+            _, base_obj = self.traverse_base(obj)
+            return base_obj
+
+        else:
+            try:
+                return obj.dict()
+            except:
+                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
+
+        Arguments:
+            ref_hash {str} -- the hash of the fully traversed object
+
+        Returns:
+            dict -- a reference object to be inserted into the given object's parent
+        """
+
+        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
+            ] > len(self.detach_lineage):
+                self.family_tree[parent][ref_hash] = len(self.detach_lineage)
+
+        return {
+            "referencedId": ref_hash,
+            "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 = []
+        self.lineage = []
+        self.family_tree = {}
+        self.closure_table = {}
+
+    def read_json(self, obj_string: str) -> Base:
+        """Recomposes a Base object from the string representation of the object
+
+        Arguments:
+            obj_string {str} -- the string representation of the object
+
+        Returns:
+            Base -- the base object with all it's children attached
+        """
+        if not obj_string:
+            return None
+        obj = safe_json_loads(obj_string)
+        return self.recompose_base(obj=obj)
+
+    def recompose_base(self, obj: dict) -> Base:
+        """Steps through a base object dictionary and recomposes the base object
+
+        Arguments:
+            obj {dict} -- the dictionary representation of the object
+
+        Returns:
+            Base -- the base object with all its children attached
+        """
+        # make sure an obj was passed and create dict if string was somehow passed
+        if not obj:
+            return
+        if isinstance(obj, str):
+            obj = safe_json_loads(obj)
+
+        if "speckle_type" in obj and obj["speckle_type"] == "reference":
+            obj = self.get_child(obj=obj)
+
+        speckle_type = obj.get("speckle_type")
+        # if speckle type is not in the object definition, it is treated as a dict
+        if not speckle_type:
+            return obj
+
+        # get the registered type from base register.
+        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.of_type(speckle_type=speckle_type)
+        # get total children count
+        if "__closure" in obj:
+            if not self.read_transport:
+                raise SpeckleException(
+                    message="Cannot resolve reference - no read transport is defined"
+                )
+            closure = obj.pop("__closure")
+            base.totalChildrenCount = len(closure)
+
+        for prop, value in obj.items():
+            # 1. handle primitives (ints, floats, strings, and bools) or None
+            if isinstance(value, PRIMITIVES) or value is None:
+                base.__setattr__(prop, value)
+                continue
+
+            # 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_obj = safe_json_loads(ref_obj_str, ref_hash)
+                base.__setattr__(prop, self.recompose_base(obj=ref_obj))
+
+            # 3. handle all other cases (base objects, lists, and dicts)
+            else:
+                base.__setattr__(prop, self.handle_value(value))
+
+        return base
+
+    def handle_value(self, obj: Any):
+        """Helper for recomposing a base object by handling the dictionary representation's values
+
+        Arguments:
+            obj {Any} -- a value from the base object dictionary
+
+        Returns:
+            Any -- the handled value (primitive, list, dictionary, or Base)
+        """
+        if not obj:
+            return obj
+
+        if isinstance(obj, PRIMITIVES):
+            return obj
+
+        # lists (regular and chunked)
+        if isinstance(obj, list):
+            obj_list = [self.handle_value(o) for o in obj]
+            if (
+                hasattr(obj_list[0], "speckle_type")
+                and "DataChunk" in obj_list[0].speckle_type
+            ):
+                # handle chunked lists
+                data = []
+                for o in obj_list:
+                    data.extend(o.data)
+                return data
+            return obj_list
+
+        # bases
+        if isinstance(obj, dict) and "speckle_type" in obj:
+            return self.recompose_base(obj=obj)
+
+        # dictionaries
+        if isinstance(obj, dict):
+            for k, v in obj.items():
+                if isinstance(v, PRIMITIVES):
+                    continue
+                else:
+                    obj[k] = self.handle_value(v)
+            return obj
+
+    def get_child(self, obj: Dict):
+        ref_hash = obj["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}"
+            )
+
+        return safe_json_loads(ref_obj_str, ref_hash)

specklepy/transports/abstract_transport.py

@@ -0,0 +1,95 @@
+from abc import ABC, abstractmethod
+from typing import Optional, List, Dict
+from pydantic import BaseModel
+from pydantic.main import Extra
+
+#  __________________
+# |                  |
+# |  this is v wip   |
+# |  pls be careful  |
+# |__________________|
+# (\__/) ||
+# (•ㅅ•)  ||
+# / 　 づ
+
+
+class AbstractTransport(ABC, BaseModel):
+    _name: str = "Abstract"
+
+    @property
+    def name(self):
+        return type(self)._name
+
+    @abstractmethod
+    def begin_write(self) -> None:
+        """Optional: signals to the transport that writes are about to begin."""
+        pass
+
+    @abstractmethod
+    def end_write(self) -> None:
+        """Optional: signals to the transport that no more items will need to be written."""
+        pass
+
+    @abstractmethod
+    def save_object(self, id: str, serialized_object: str) -> None:
+        """Saves the given serialized object.
+
+        Arguments:
+            id {str} -- the hash of the object
+            serialized_object {str} -- the full string representation of the object
+        """
+        pass
+
+    @abstractmethod
+    def save_object_from_transport(
+        self, id: str, source_transport: "AbstractTransport"
+    ) -> None:
+        """Saves an object from the given source transport.
+
+        Arguments:
+            id {str} -- the hash of the object
+            source_transport {AbstractTransport) -- the transport through which the object can be found
+        """
+        pass
+
+    @abstractmethod
+    def get_object(self, id: str) -> Optional[str]:
+        """Gets an object. Returns `None` if the object is not found.
+
+        Arguments:
+            id {str} -- the hash of the object
+
+        Returns:
+            str -- the full string representation of the object (or null if no object is found)
+        """
+        pass
+
+    @abstractmethod
+    def has_objects(self, id_list: List[str]) -> Dict[str, bool]:
+        """Checks the presence of multiple objects.
+
+        Arguments:
+            id_list -- List of object id to be checked
+
+        Returns:
+            Dict[str, bool] -- keys: input ids, values: whether the transport has that object
+        """
+        pass
+
+    @abstractmethod
+    def copy_object_and_children(
+        self, id: str, target_transport: "AbstractTransport"
+    ) -> str:
+        """Copies the parent object and all its children to the provided transport.
+
+        Arguments:
+            id {str} -- the id of the object you want to copy
+            target_transport {AbstractTransport} -- the transport you want to copy the object to
+        Returns:
+            str -- the string representation of the root object
+        """
+        pass
+
+    class Config:
+        extra = Extra.allow
+        arbitrary_types_allowed = True

specklepy/transports/memory.py

@@ -0,0 +1,43 @@
+from typing import Any, List, Dict
+from specklepy.transports.abstract_transport import AbstractTransport
+
+
+class MemoryTransport(AbstractTransport):
+    _name: str = "Memory"
+    objects: dict = {}
+    saved_object_count: int = 0
+
+    def __init__(self, name=None, **data: Any) -> None:
+        super().__init__(**data)
+        if name:
+            self._name = name
+
+    def __repr__(self) -> str:
+        return f"MemoryTransport(objects: {len(self.objects)})"
+
+    def save_object(self, id: str, serialized_object: str) -> None:
+        self.objects[id] = serialized_object
+
+        self.saved_object_count += 1
+
+    def save_object_from_transport(
+        self, id: str, source_transport: AbstractTransport
+    ) -> None:
+        raise NotImplementedError
+
+    def get_object(self, id: str) -> str or 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}
+
+    def begin_write(self) -> None:
+        self.saved_object_count = 0
+
+    def end_write(self) -> None:
+        pass
+
+    def copy_object_and_children(
+        self, id: str, target_transport: AbstractTransport
+    ) -> str:
+        raise NotImplementedError

specklepy/transports/server/__init__.py

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

specklepy/transports/server/batch_sender.py

@@ -0,0 +1,153 @@
+import json
+import logging
+import threading
+import queue
+import gzip
+
+import requests
+from specklepy.logging.exceptions import SpeckleException
+
+LOG = logging.getLogger(__name__)
+
+
+class BatchSender(object):
+    def __init__(
+        self,
+        server_url,
+        stream_id,
+        token,
+        max_batch_size_mb=1,
+        batch_buffer_length=10,
+        thread_count=4,
+    ):
+        self.server_url = server_url
+        self.stream_id = stream_id
+        self._token = token
+
+        self.max_size = int(max_batch_size_mb * 1000 * 1000)
+        self._batches = queue.Queue(batch_buffer_length)
+        self._crt_batch = []
+        self._crt_batch_size = 0
+
+        self.thread_count = thread_count
+        self._send_threads = []
+        self._exception = None
+
+    def send_object(self, id: str, obj: str):
+        if not self._send_threads:
+            self._create_threads()
+
+        crt_obj_size = len(obj)
+        if not self._crt_batch or self._crt_batch_size + crt_obj_size < self.max_size:
+            self._crt_batch.append((id, obj))
+            self._crt_batch_size += crt_obj_size
+            return
+
+        self._batches.put(self._crt_batch)
+        self._crt_batch = [(id, obj)]
+        self._crt_batch_size = crt_obj_size
+
+    def flush(self):
+        # Add current non-complete batch
+        if self._crt_batch:
+            self._batches.put(self._crt_batch)
+            self._crt_batch = []
+            self._crt_batch_size = 0
+        # Wait for queued batches to be sent
+        self._batches.join()
+        # End the sending threads
+        self._delete_threads()
+        # If there was any error, throw the first exception that occurred during upload
+        if self._exception is not None:
+            ex = self._exception
+            self._exception = None
+            raise ex
+
+    def _sending_thread_main(self):
+        try:
+            session = requests.Session()
+            session.headers.update(
+                {"Authorization": f"Bearer {self._token}", "Accept": "text/plain"}
+            )
+
+            while True:
+                batch = self._batches.get()
+
+                # None is a sentinel value, meaning the thread should exit gracefully
+                if batch is None:
+                    self._batches.task_done()
+                    break
+
+                try:
+                    self._bg_send_batch(session, batch)
+                except Exception as ex:
+                    self._exception = self._exception or ex
+                    LOG.error("Error sending batch of objects to server: " + str(ex))
+
+                self._batches.task_done()
+        except Exception as ex:
+            self._exception = self._exception or ex
+            LOG.error("ServerTransport sending thread error: " + str(ex))
+
+    def _bg_send_batch(self, session, batch):
+        object_ids = [obj[0] for obj in batch]
+        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"
+            )
+            return
+
+        upload_data = "[" + ",".join(new_objects) + "]"
+        upload_data_gzip = gzip.compress(upload_data.encode())
+        LOG.info(
+            "Uploading batch of %s objects (%s new): (size: %s, compressed size: %s)"
+            % (len(batch), len(new_objects), len(upload_data), len(upload_data_gzip))
+        )
+
+        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=f"Could not save the object to the server - status code {r.status_code}"
+                )
+        except json.JSONDecodeError as error:
+            return SpeckleException(
+                f"Failed to send objects to {self.server_url}. Please ensure this stream ({self.stream_id}) exists on this server and that you have permission to send to it.",
+                error,
+            )
+
+    def _create_threads(self):
+        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 _ in range(len(self._send_threads)):
+            self._batches.put(None)
+
+        for thread in self._send_threads:
+            thread.join()
+
+        self._send_threads = []
+
+    def __del__(self):
+        self._delete_threads()

specklepy/transports/server/server.py

@@ -0,0 +1,184 @@
+import json
+import requests
+from warnings import warn
+
+from typing import Any, Dict, List
+
+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 authenticted 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
+    commid_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: str = None
+    stream_id: str = None
+    account: Account = None
+    saved_obj_count: int = 0
+    session: requests.Session = None
+
+    def __init__(
+        self,
+        stream_id: str,
+        client: SpeckleClient = None,
+        account: Account = None,
+        token: str = None,
+        url: 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(
+                        f"Unauthenticated Speckle Client provided to Server Transport 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 {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
+        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

@@ -0,0 +1,217 @@
+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 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
+    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(self.app_name)
+
+        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 {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}')"
+
+    # def __write_timer_elapsed(self):
+    #     print("WRITE TIMER ELAPSED")
+    #     proc = Process(target=_run_queue, args=(self.__queue, self._root_path))
+    #     proc.start()
+    #     proc.join()
+
+    @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)
+
+    # 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 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:
+        """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()

tests/conftest.py

@@ -0,0 +1,114 @@
+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 FakeDirection, FakeMesh
+from specklepy.logging import metrics
+
+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,
+    )
+    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 = 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
+
+
+@pytest.fixture(scope="session")
+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/test_base.py

@@ -0,0 +1,136 @@
+from enum import Enum
+from typing import Dict, List, Optional
+from contextlib import ExitStack as does_not_raise
+
+import pytest
+from specklepy.api import operations
+from specklepy.logging.exceptions import SpeckleException
+from specklepy.objects.base import Base, DataChunk
+
+
+@pytest.mark.parametrize(
+    "invalid_prop_name",
+    [
+        (""),
+        ("@"),
+        ("@@wow"),
+        ("this.is.bad"),
+        ("super/bad"),
+    ],
+)
+def test_empty_prop_names(invalid_prop_name: str) -> None:
+    base = Base()
+    with pytest.raises(ValueError):
+        base[invalid_prop_name] = "🐛️"
+
+
+class FakeModel(Base):
+    """Just a test class type."""
+
+    foo: str = ""
+
+
+def test_new_type_registration() -> None:
+    """Test if a new subclass is registered into the type register."""
+    assert Base.get_registered_type("FakeModel") == FakeModel
+    assert Base.get_registered_type("🐺️") is None
+
+
+def test_fake_base_serialization() -> None:
+    fake_model = FakeModel(foo="bar")
+
+    serialized = operations.serialize(fake_model)
+    deserialized = operations.deserialize(serialized)
+
+    assert fake_model.get_id() == deserialized.get_id()
+
+
+def test_duplicate_speckle_type_raises_error():
+    with pytest.raises(ValueError):
+
+        class NaughtyClass(Base, speckle_type="Base"):
+            """This class has a speckle_type that is already taken."""
+
+
+@pytest.mark.parametrize(
+    "forbidden_attribute_name, expectation",
+    [
+        ("", pytest.raises(ValueError)),
+        ("@", pytest.raises(ValueError)),
+        ("@@", pytest.raises(ValueError)),
+        ("im.cheeky", pytest.raises(ValueError)),
+        ("im.cheeky", pytest.raises(ValueError)),
+        ("imgood", does_not_raise()),
+    ],
+)
+def test_attribute_name_validation(
+    forbidden_attribute_name: str,
+    expectation,
+    base: Base,
+):
+    with expectation:
+        base[forbidden_attribute_name] = None
+
+
+def test_speckle_type_cannot_be_set(base: Base) -> None:
+    assert base.speckle_type == "Base"
+    base.speckle_type = "unset"
+    assert base.speckle_type == "Base"
+
+
+def test_setting_units():
+    b = Base(units="foot")
+    assert b.units == "ft"
+
+    with pytest.raises(SpeckleException):
+        b.units = "big"
+
+    b.units = None  # invalid args are skipped
+    b.units = 7
+    assert b.units == "ft"
+
+
+def test_base_of_custom_speckle_type() -> None:
+    b1 = Base.of_type("BirdHouse", name="Tweety's Crib")
+    assert b1.speckle_type == "BirdHouse"
+    assert b1.name == "Tweety's Crib"
+
+
+class DietaryRestrictions(Enum):
+    VEGAN = 1
+    GLUTEN_FREE = 2
+    NUT_FREE = 3
+
+
+class FrozenYoghurt(Base):
+    """Testing type checking"""
+
+    servings: int
+    flavours: List[str]  # list item types won't be checked
+    customer: str
+    add_ons: Optional[Dict[str, float]]  # dict item types won't be checked
+    price: float = 0.0
+    dietary: DietaryRestrictions
+
+
+def test_type_checking() -> None:
+    order = FrozenYoghurt()
+
+    order.servings = 2
+    order.price = "7"  # will get converted
+    order.customer = "izzy"
+    order.dietary = DietaryRestrictions.VEGAN
+
+    with pytest.raises(SpeckleException):
+        order.flavours = "not a list"
+    with pytest.raises(SpeckleException):
+        order.servings = "five"
+    with pytest.raises(SpeckleException):
+        order.add_ons = ["sprinkles"]
+    with pytest.raises(SpeckleException):
+        order.dietary = "no nuts plz"
+
+    order.add_ons = {"sprinkles": 0.2, "chocolate": 1.0}
+    order.flavours = ["strawberry", "lychee", "peach", "pineapple"]
+
+    assert order.price == 7.0

tests/test_branch.py

@@ -0,0 +1,82 @@
+import pytest
+from specklepy.api import operations
+from specklepy.transports.server import ServerTransport
+from specklepy.api.models import Branch, Commit, Stream
+
+
+class TestBranch:
+    @pytest.fixture(scope="module")
+    def branch(self):
+        return Branch(name="olive branch 🌿", description="a test branch")
+
+    @pytest.fixture(scope="module")
+    def updated_branch(self):
+        return Branch(name="eucalyptus branch 🌿", description="an updated test branch")
+
+    @pytest.fixture(scope="module")
+    def stream(self, 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
+
+    def test_branch_create(self, client, stream, branch):
+        branch.id = client.branch.create(
+            stream_id=stream.id, name=branch.name, description=branch.description
+        )
+
+        assert isinstance(branch.id, str)
+
+    def test_branch_get(self, client, mesh, stream, branch):
+        transport = ServerTransport(client=client, stream_id=stream.id)
+        mesh.id = operations.send(mesh, transports=[transport])
+
+        client.commit.create(
+            stream_id=stream.id,
+            branch_name=branch.name,
+            object_id=mesh.id,
+            message="a commit for testing branch get",
+        )
+
+        fetched_branch = client.branch.get(stream_id=stream.id, name=branch.name)
+
+        assert isinstance(fetched_branch, Branch)
+        assert fetched_branch.name == branch.name
+        assert fetched_branch.description == branch.description
+        assert isinstance(fetched_branch.commits.items, list)
+        assert isinstance(fetched_branch.commits.items[0], Commit)
+
+    def test_branch_list(self, client, stream, branch):
+        branches = client.branch.list(stream_id=stream.id)
+        print(branches)
+
+        assert isinstance(branches, list)
+        assert len(branches) == 2
+        assert isinstance(branches[0], Branch)
+        assert branches[1].name == branch.name
+
+    def test_branch_update(self, client, stream, branch, updated_branch):
+        updated = client.branch.update(
+            stream_id=stream.id,
+            branch_id=branch.id,
+            name=updated_branch.name,
+            description=updated_branch.description,
+        )
+
+        fetched_branch = client.branch.get(
+            stream_id=stream.id, name=updated_branch.name
+        )
+
+        assert updated is True
+        assert fetched_branch.name == updated_branch.name
+        assert fetched_branch.description == updated_branch.description
+
+    def test_branch_delete(self, client, stream, branch):
+        deleted = client.branch.delete(stream_id=stream.id, branch_id=branch.id)
+
+        assert deleted is True

tests/test_client_and_ops.py

@@ -0,0 +1,48 @@
+import pytest
+from specklepy.api import operations
+from specklepy.api.client import SpeckleClient
+from specklepy.objects.base import Base
+from specklepy.transports.server import ServerTransport
+from specklepy.api.credentials import Account, get_account_from_token
+from specklepy.logging.exceptions import SpeckleException, SpeckleWarning
+
+
+def test_invalid_authentication():
+    client = SpeckleClient()
+
+    with pytest.warns(SpeckleWarning):
+        client.authenticate_with_token("fake token")
+
+
+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/test_commit.py

@@ -0,0 +1,87 @@
+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)
+class TestCommit:
+    @pytest.fixture(scope="module")
+    def commit(self):
+        return Commit(message="a fun little test commit")
+
+    @pytest.fixture(scope="module")
+    def updated_commit(
+        self,
+    ):
+        return Commit(message="a fun little updated commit")
+
+    @pytest.fixture(scope="module")
+    def stream(self, 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
+
+    def test_commit_create(self, client, stream, mesh, commit):
+        transport = ServerTransport(client=client, stream_id=stream.id)
+        mesh.id = operations.send(mesh, transports=[transport])
+
+        commit.id = client.commit.create(
+            stream_id=stream.id, object_id=mesh.id, message=commit.message
+        )
+
+        assert isinstance(commit.id, str)
+
+    def test_commit_get(self, client, stream, mesh, commit):
+        fetched_commit = client.commit.get(stream_id=stream.id, commit_id=commit.id)
+
+        assert fetched_commit.message == commit.message
+        assert fetched_commit.referencedObject == mesh.id
+
+    def test_commit_list(self, client, stream):
+        commits = client.commit.list(stream_id=stream.id)
+
+        assert isinstance(commits, list)
+        assert isinstance(commits[0], Commit)
+
+    def test_commit_update(self, client, stream, commit, updated_commit):
+        updated = client.commit.update(
+            stream_id=stream.id, commit_id=commit.id, message=updated_commit.message
+        )
+
+        fetched_commit = client.commit.get(stream_id=stream.id, commit_id=commit.id)
+
+        assert updated is True
+        assert fetched_commit.message == updated_commit.message
+
+    def test_commit_delete(self, client, stream, mesh):
+        commit_id = client.commit.create(
+            stream_id=stream.id, object_id=mesh.id, message="a great commit to delete"
+        )
+
+        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 == True

tests/test_geometry.py

@@ -0,0 +1,465 @@
+import json
+from typing import Callable
+
+import pytest
+from specklepy.api import operations
+from specklepy.logging.exceptions import SpeckleException
+from specklepy.objects.base import Base
+from specklepy.objects.encoding import CurveArray, ObjectArray
+from specklepy.objects.geometry import (
+    Arc,
+    Box,
+    Brep,
+    BrepEdge,
+    BrepFace,
+    BrepLoop,
+    BrepTrim,
+    BrepTrimTypeEnum,
+    Circle,
+    Curve,
+    Ellipse,
+    Interval,
+    Line,
+    Mesh,
+    Plane,
+    Point,
+    Polycurve,
+    Polyline,
+    Surface,
+    Vector,
+)
+from specklepy.transports.memory import MemoryTransport
+
+
+@pytest.fixture()
+def interval():
+    return Interval(start=0, end=5)
+
+
+@pytest.fixture()
+def point():
+    return Point(x=1, y=10, z=0)
+
+
+@pytest.fixture()
+def vector():
+    return Vector(x=1, y=32, z=10)
+
+
+@pytest.fixture()
+def plane(point, vector):
+    return Plane(
+        origin=point,
+        normal=vector,
+        xdir=vector,
+        ydir=vector,
+    )
+
+
+@pytest.fixture()
+def box(plane, interval):
+    return Box(
+        basePlane=plane,
+        ySize=interval,
+        zSize=interval,
+        xSize=interval,
+        area=20.4,
+        volume=44.2,
+    )
+
+
+@pytest.fixture()
+def line(point, interval):
+    return Line(
+        start=point,
+        end=point,
+        domain=interval,
+        # These attributes are not handled in C#
+        # bbox=None,
+        # length=None
+    )
+
+
+@pytest.fixture()
+def arc(plane, interval):
+    return Arc(
+        radius=2.3,
+        startAngle=22.1,
+        endAngle=44.5,
+        angleRadians=33,
+        plane=plane,
+        domain=interval,
+        units="m",
+        # These attributes are not handled in C#
+        # bbox=None,
+        # area=None,
+        # length=None,
+        # startPoint=None,
+        # midPoint=None,
+        # endPoint=None,
+    )
+
+
+@pytest.fixture()
+def circle(plane, interval):
+    return Circle(
+        radius=22,
+        plane=plane,
+        domain=interval,
+        units="m",
+        # These attributes are not handled in C#
+        # bbox=None,
+        # area=None,
+        # length=None,
+    )
+
+
+@pytest.fixture()
+def ellipse(plane, interval):
+    return Ellipse(
+        firstRadius=34,
+        secondRadius=22,
+        plane=plane,
+        domain=interval,
+        units="m",
+        # These attributes are not handled in C#
+        # trimDomain=None,
+        # bbox=None,
+        # area=None,
+        # length=None,
+    )
+
+
+@pytest.fixture()
+def polyline(interval):
+    return Polyline(
+        value=[22, 44, 54.3, 99, 232, 21],
+        closed=True,
+        domain=interval,
+        units="m",
+        # These attributes are not handled in C#
+        # bbox=None,
+        # area=None,
+        # length=None,
+    )
+
+
+@pytest.fixture()
+def curve(interval):
+    return Curve(
+        degree=90,
+        periodic=True,
+        rational=False,
+        closed=True,
+        domain=interval,
+        points=[23, 21, 44, 43, 56, 76, 1, 3, 2],
+        weights=[23, 11, 23],
+        knots=[22, 45, 76, 11],
+        units="m",
+        # These attributes are not handled in C#
+        # displayValue=None,
+        # bbox=None,
+        # area=None,
+        # length=None,
+    )
+
+
+@pytest.fixture()
+def polycurve(interval, curve, polyline):
+    return Polycurve(
+        segments=[curve, polyline],
+        domain=interval,
+        closed=True,
+        units="m",
+        # These attributes are not handled in C#
+        # bbox=None,
+        # area=None,
+        # length=None
+    )
+
+
+@pytest.fixture()
+def mesh(box):
+    return Mesh(
+        vertices=[2, 1, 2, 4, 77.3, 5, 33, 4, 2],
+        faces=[1, 2, 3, 4, 5, 6, 7],
+        colors=[111, 222, 333, 444, 555, 666, 777],
+        bbox=box,
+        area=233,
+        volume=232.2,
+    )
+
+
+@pytest.fixture()
+def surface(interval):
+    return Surface(
+        degreeU=33,
+        degreeV=44,
+        rational=True,
+        pointData=[1, 2.2, 3, 4, 5, 6, 7, 8, 9],
+        countU=3,
+        countV=4,
+        closedU=True,
+        closedV=False,
+        domainU=interval,
+        domainV=interval,
+        knotsU=[1.1, 2.2, 3.3, 4.4],
+        knotsV=[9, 8, 7, 6, 5, 4.4],
+        units="m",
+        # These attributes are not handled in C#
+        # bbox=None,
+        # area=None,
+    )
+
+
+@pytest.fixture()
+def brep_face():
+    return BrepFace(
+        SurfaceIndex=3,
+        LoopIndices=[1, 2, 3, 4],
+        OuterLoopIndex=2,
+        OrientationReversed=False,
+    )
+
+
+@pytest.fixture()
+def brep_edge(interval):
+    return BrepEdge(
+        Curve3dIndex=2,
+        TrimIndices=[4, 5, 6, 7],
+        StartIndex=2,
+        EndIndex=6,
+        ProxyCurveIsReversed=True,
+        Domain=interval,
+    )
+
+
+@pytest.fixture()
+def brep_loop():
+    return BrepLoop(FaceIndex=5, TrimIndices=[3, 4, 5], Type="unknown")
+
+
+@pytest.fixture()
+def brep_trim():
+    return BrepTrim(
+        EdgeIndex=3,
+        StartIndex=4,
+        EndIndex=6,
+        FaceIndex=1,
+        LoopIndex=4,
+        CurveIndex=7,
+        IsoStatus=6,
+        TrimType="Mated",
+        IsReversed=False,
+        # These attributes are not handled in C#
+        # Domain=None,
+    )
+
+
+@pytest.fixture
+def brep(
+    mesh,
+    box,
+    surface,
+    curve,
+    polyline,
+    circle,
+    point,
+    brep_edge,
+    brep_loop,
+    brep_trim,
+    brep_face,
+):
+    return Brep(
+        provenance="pytest",
+        bbox=box,
+        area=32,
+        volume=54,
+        displayValue=mesh,
+        Surfaces=[surface, surface, surface],
+        Curve3D=[curve, polyline],
+        Curve2D=[circle],
+        Vertices=[point, point, point, point],
+        Edges=[brep_edge],
+        Loops=[brep_loop, brep_loop],
+        Trims=[brep_trim],
+        Faces=[brep_face, brep_face],
+        IsClosed=False,
+        Orientation=3,
+    )
+
+
+@pytest.fixture
+def geometry_objects_dict(
+    point,
+    vector,
+    plane,
+    line,
+    arc,
+    circle,
+    ellipse,
+    polyline,
+    curve,
+    polycurve,
+    surface,
+    brep_trim,
+):
+    return {
+        "point": point,
+        "vector": vector,
+        "plane": plane,
+        "line": line,
+        "arc": arc,
+        "circle": circle,
+        "ellipse": ellipse,
+        "polyline": polyline,
+        "curve": curve,
+        "polycurve": polycurve,
+        "surface": surface,
+        "brep_trim": brep_trim,
+    }
+
+
+@pytest.mark.parametrize(
+    "object_name",
+    [
+        "point",
+        "vector",
+        "plane",
+        "line",
+        "arc",
+        "circle",
+        "ellipse",
+        "polyline",
+        "curve",
+        "polycurve",
+        "surface",
+        "brep_trim",
+    ],
+)
+def test_to_and_from_list(object_name: str, geometry_objects_dict):
+    object = geometry_objects_dict[object_name]
+    assert hasattr(object, "to_list")
+    assert hasattr(object, "from_list")
+
+    chunks = object.to_list()
+    assert isinstance(chunks, list)
+
+    object_class = object.__class__
+    decoded_object: Base = object_class.from_list(chunks)
+    assert decoded_object.get_id() == object.get_id()
+
+
+def test_brep_surfaces_value_serialization(surface):
+    brep = Brep()
+    assert brep.Surfaces == None
+    assert brep.SurfacesValue == None
+    brep.Surfaces = [surface, surface]
+    assert brep.SurfacesValue == ObjectArray.from_objects([surface, surface]).data
+
+    brep.SurfacesValue = ObjectArray.from_objects([surface]).data
+    assert len(brep.Surfaces) == 1
+    assert brep.Surfaces[0].get_id() == surface.get_id()
+
+
+def test_brep_curve2d_values_serialization(curve, polyline, circle):
+    brep = Brep()
+    assert brep.Curve2D == None
+    assert brep.Curve2DValues == None
+    brep.Curve2D = [curve, polyline]
+    assert brep.Curve2DValues == CurveArray.from_curves([curve, polyline]).data
+
+    brep.Curve2DValues = CurveArray.from_curves([circle]).data
+    assert len(brep.Curve2D) == 1
+    assert brep.Curve2D[0].get_id() == circle.get_id()
+
+
+def test_brep_curve3d_values_serialization(curve, polyline, circle):
+    brep = Brep()
+    assert brep.Curve3D == None
+    assert brep.Curve3DValues == None
+    brep.Curve3D = [curve, polyline]
+    assert brep.Curve3DValues == CurveArray.from_curves([curve, polyline]).data
+
+    brep.Curve3DValues = CurveArray.from_curves([circle]).data
+    assert len(brep.Curve3D) == 1
+    assert brep.Curve3D[0].get_id() == circle.get_id()
+
+
+def test_brep_vertices_values_serialization():
+    brep = Brep()
+    brep.VerticesValue = [1, 1, 1, 1, 2, 2, 2, 3, 3, 3]
+    brep.Vertices[0].get_id() == Point(x=1, y=1, z=1, _units="mm").get_id()
+    brep.Vertices[1].get_id() == Point(x=2, y=2, z=2, _units="mm").get_id()
+    brep.Vertices[2].get_id() == Point(x=3, y=3, z=3, _units="mm").get_id()
+
+
+def test_trims_value_serialization():
+    brep = Brep()
+    brep.TrimsValue = [
+        0,
+        0,
+        0,
+        0,
+        0,
+        0,
+        1,
+        1,
+        1,
+        1,
+        0,
+        0,
+        0,
+        0,
+        1,
+        2,
+        1,
+        0,
+    ]
+
+    brep.Trims[0].get_id() == BrepTrim(
+        EdgeIndex=0,
+        StartIndex=0,
+        EndIndex=0,
+        FaceIndex=0,
+        LoopIndex=0,
+        CurveIndex=0,
+        IsoStatus=1,
+        TrimType=BrepTrimTypeEnum.Boundary,
+        IsReversed=False,
+    ).get_id()
+
+    brep.Trims[1].get_id() == BrepTrim(
+        EdgeIndex=1,
+        StartIndex=0,
+        EndIndex=0,
+        FaceIndex=0,
+        LoopIndex=0,
+        CurveIndex=1,
+        IsoStatus=2,
+        TrimType=BrepTrimTypeEnum.Boundary,
+        IsReversed=True,
+    ).get_id()
+
+
+def test_serialized_brep_attributes(brep: Brep):
+    transport = MemoryTransport()
+    serialized = operations.serialize(brep, [transport])
+    serialized_dict = json.loads(serialized)
+
+    removed_keys = ["Surfaces", "Curve3D", "Curve2D", "Vertices", "Trims"]
+
+    for k in removed_keys:
+        assert k not in serialized_dict.keys()
+
+
+def test_mesh_create():
+    vertices = [2, 1, 2, 4, 77.3, 5, 33, 4, 2]
+    faces = [1, 2, 3, 4, 5, 6, 7]
+    mesh = Mesh.create(vertices, faces)
+
+    with pytest.raises(SpeckleException):
+        bad_mesh = Mesh.create(vertices=7, faces=faces)
+
+    assert mesh.vertices == vertices
+    assert mesh.textureCoordinates == []

tests/test_objects.py

@@ -0,0 +1,46 @@
+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")
+    def stream(self, 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
+
+    def test_object_create(self, client, stream, base):
+        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):
+        fetched_base = client.object.get(
+            stream_id=stream.id, object_id=base.get_id(True)
+        )
+
+        assert isinstance(fetched_base, Base)
+        assert fetched_base.name == base.name
+        assert isinstance(fetched_base.vertices, list)
+        # 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]

tests/test_serialization.py

@@ -0,0 +1,97 @@
+import json
+import pytest
+from specklepy.api import operations
+from specklepy.transports.server import ServerTransport
+from specklepy.transports.memory import MemoryTransport
+from specklepy.serialization.base_object_serializer import BaseObjectSerializer
+from specklepy.objects import Base
+from specklepy.objects.geometry import Point
+from specklepy.objects.fakemesh import FakeMesh
+
+
+@pytest.mark.run(order=3)
+class TestSerialization:
+    def test_serialize(self, base):
+        serialized = operations.serialize(base)
+        deserialized = operations.deserialize(serialized)
+
+        assert base.get_id() == deserialized.get_id()
+        assert base.units == "mm"
+        assert isinstance(base.test_bases[0], Base)
+        assert base["@revit_thing"].speckle_type == "SpecialRevitFamily"
+        assert base["@detach"].name == deserialized["@detach"].name
+
+    def test_detaching(self, mesh):
+        transport = MemoryTransport()
+        serialized = operations.serialize(mesh, [transport])
+        deserialized = operations.deserialize(serialized, transport)
+
+        serialized_dict = json.loads(serialized)
+
+        assert serialized_dict["detach_this"]["speckle_type"] == "reference"
+        assert serialized_dict["@detach"]["speckle_type"] == "reference"
+        assert serialized_dict["origin"]["speckle_type"] == "reference"
+        assert serialized_dict["@detached_list"][-1]["speckle_type"] == "reference"
+        assert mesh.get_id() == deserialized.get_id()
+
+    def test_chunking(self, mesh):
+        transport = MemoryTransport()
+        serialized = operations.serialize(mesh, [transport])
+        deserialized = operations.deserialize(serialized, transport)
+
+        serialized_dict = json.loads(serialized)
+
+        assert len(serialized_dict["vertices"]) == 3
+        assert len(serialized_dict["@(100)colours"]) == 3
+        assert len(serialized_dict["@()default_chunk"]) == 1
+        assert serialized_dict["vertices"][0]["speckle_type"] == "reference"
+        assert serialized_dict["@(100)colours"][0]["speckle_type"] == "reference"
+        assert serialized_dict["@()default_chunk"][0]["speckle_type"] == "reference"
+        assert mesh.get_id() == deserialized.get_id()
+
+    def test_send_and_receive(self, client, sample_stream, mesh):
+        transport = ServerTransport(client=client, stream_id=sample_stream.id)
+        hash = operations.send(mesh, transports=[transport])
+
+        # also try constructing server transport with token and url
+        transport = ServerTransport(
+            stream_id=sample_stream.id, token=client.account.token, url=client.url
+        )
+        # use a fresh memory transport to force receiving from remote
+        received = operations.receive(
+            hash, remote_transport=transport, local_transport=MemoryTransport()
+        )
+
+        assert isinstance(received, FakeMesh)
+        assert received.vertices == mesh.vertices
+        assert isinstance(received.origin, Point)
+        assert received.origin.x == mesh.origin.x
+        # not comparing hashes as order is not guaranteed back from server
+
+        mesh.id = hash  # populate with decomposed id for use in proceeding tests
+
+    def test_receive_local(self, client, mesh):
+        hash = operations.send(mesh)  # defaults to SQLiteTransport
+        received = operations.receive(hash)
+
+        assert isinstance(received, Base)
+        assert mesh.get_id() == received.get_id()
+
+    def test_unknown_type(self):
+        unknown = '{"speckle_type": "mysterious.type"}'
+        deserialised = operations.deserialize(unknown)
+
+        assert isinstance(deserialised, Base)
+        assert deserialised.speckle_type == "mysterious.type"
+
+    def test_no_speckle_type(self):
+        untyped = '{"foo": "bar"}'
+        deserialised = operations.deserialize(untyped)
+
+        assert deserialised == {"foo": "bar"}
+
+    def test_big_int(self):
+        big_int = '{"big": ' + str(2 ** 64) + "}"
+        deserialised = operations.deserialize(big_int)
+
+        assert deserialised == {"big": 2 ** 64}

tests/test_server.py

@@ -0,0 +1,39 @@
+import pytest
+from specklepy.api.models import ServerInfo
+
+
+class TestServer:
+    @pytest.fixture(scope="module")
+    def token_info(self):
+        return {
+            "token": None,
+            "name": "super secret token",
+            "scopes": ["streams:read", "streams:write"],
+            "lifespan": 9001,
+        }
+
+    def test_server_get(self, client):
+        server = client.server.get()
+
+        assert isinstance(server, ServerInfo)
+
+    def test_server_apps(self, client):
+        apps = client.server.apps()
+
+        assert isinstance(apps, list)
+        assert len(apps) >= 1
+        assert any(app["name"] == "Speckle Web Manager" for app in apps)
+
+    def test_server_create_token(self, client, token_info):
+        token_info["token"] = client.server.create_token(
+            name=token_info["name"],
+            scopes=token_info["scopes"],
+            lifespan=token_info["lifespan"],
+        )
+
+        assert isinstance(token_info["token"], str)
+
+    def test_server_revoke_token(self, client, token_info):
+        revoked = client.server.revoke_token(token=token_info["token"])
+
+        assert revoked is True

tests/test_stream.py

@@ -0,0 +1,114 @@
+import pytest
+from datetime import datetime
+from specklepy.api.models import ActivityCollection, Activity, Stream
+from specklepy.api.client import SpeckleClient
+from specklepy.logging.exceptions import GraphQLException
+
+
+@pytest.mark.run(order=2)
+class TestStream:
+    @pytest.fixture(scope="session")
+    def stream(self):
+        return Stream(
+            name="a wonderful stream",
+            description="a stream created for testing",
+            isPublic=True,
+        )
+
+    @pytest.fixture(scope="module")
+    def updated_stream(
+        self,
+    ):
+        return Stream(
+            name="a wonderful updated stream",
+            description="an updated stream description for testing",
+            isPublic=False,
+        )
+
+    def test_stream_create(self, client, stream, updated_stream):
+        stream.id = updated_stream.id = client.stream.create(
+            name=stream.name,
+            description=stream.description,
+            is_public=stream.isPublic,
+        )
+
+        assert isinstance(stream.id, str)
+
+    def test_stream_get(self, client, stream):
+        fetched_stream = client.stream.get(stream.id)
+
+        assert fetched_stream.name == stream.name
+        assert fetched_stream.description == stream.description
+        assert fetched_stream.isPublic == stream.isPublic
+
+    def test_stream_update(self, client, updated_stream):
+        updated = client.stream.update(
+            id=updated_stream.id,
+            name=updated_stream.name,
+            description=updated_stream.description,
+            is_public=updated_stream.isPublic,
+        )
+        fetched_stream = client.stream.get(updated_stream.id)
+
+        assert updated is True
+        assert fetched_stream.name == updated_stream.name
+        assert fetched_stream.description == updated_stream.description
+        assert fetched_stream.isPublic == updated_stream.isPublic
+
+    def test_stream_list(self, client):
+        client.stream.create(name="a second wonderful stream")
+        client.stream.create(name="a third fantastic stream")
+
+        streams = client.stream.list()
+
+        assert len(streams) >= 3
+
+    def test_stream_search(self, client, updated_stream):
+        search_results = client.stream.search(updated_stream.name)
+
+        assert len(search_results) == 1
+        assert search_results[0].name == updated_stream.name
+
+    def test_stream_grant_permission(self, client, stream, second_user_dict):
+        granted = client.stream.grant_permission(
+            stream_id=stream.id,
+            user_id=second_user_dict["id"],
+            role="stream:contributor",
+        )
+
+        fetched_stream = client.stream.get(stream.id)
+
+        assert granted is True
+        assert len(fetched_stream.collaborators) == 2
+        assert fetched_stream.collaborators[0].name == second_user_dict["name"]
+
+    def test_stream_revoke_permission(self, client, stream, second_user_dict):
+        revoked = client.stream.revoke_permission(
+            stream_id=stream.id, user_id=second_user_dict["id"]
+        )
+
+        fetched_stream = client.stream.get(stream.id)
+
+        assert revoked is True
+        assert len(fetched_stream.collaborators) == 1
+
+    def test_stream_activity(self, client: SpeckleClient, stream: Stream):
+        activity = client.stream.activity(stream.id)
+
+        older_activity = client.stream.activity(
+            stream.id, before=activity.items[0].time
+        )
+
+        assert isinstance(activity, ActivityCollection)
+        assert isinstance(older_activity, ActivityCollection)
+        assert older_activity.totalCount < activity.totalCount
+        assert activity.items is not None
+        assert isinstance(activity.items[0], Activity)
+
+    def test_stream_delete(self, client, stream):
+        deleted = client.stream.delete(stream.id)
+
+        stream_get = client.stream.get(stream.id)
+
+        assert deleted is True
+        assert isinstance(stream_get, GraphQLException)

tests/test_transforms.py

@@ -0,0 +1,132 @@
+from typing import List
+import pytest
+from specklepy.api import operations
+from specklepy.objects.geometry import Point, Vector
+from specklepy.objects.other import (
+    Transform,
+    BlockInstance,
+    BlockDefinition,
+    IDENTITY_TRANSFORM,
+)
+
+
+@pytest.fixture()
+def point():
+    return Point(x=1, y=10, z=2)
+
+
+@pytest.fixture()
+def points():
+    return [Point(x=1 + i, y=10 + i, z=2 + i) for i in range(5)]
+
+
+@pytest.fixture()
+def point_value():
+    return [1, 10, 2]
+
+
+@pytest.fixture()
+def points_values():
+    coords = []
+    for i in range(5):
+        coords.extend([1 + i, 10 + i, 2 + 1])
+    return coords
+
+
+@pytest.fixture()
+def vector():
+    return Vector(x=1, y=10, z=2)
+
+
+@pytest.fixture()
+def vector_value():
+    return [1, 1, 2]
+
+
+@pytest.fixture()
+def transform():
+    """Translates to [1, 2, 0] and scales z by 0.5"""
+    return Transform.from_list(
+        [
+            1.0,
+            0.0,
+            0.0,
+            1.0,
+            0.0,
+            1.0,
+            0.0,
+            2.0,
+            0.0,
+            0.0,
+            0.5,
+            0.0,
+            0.0,
+            0.0,
+            0.0,
+            1.0,
+        ]
+    )
+
+
+def test_point_transform(point: Point, transform: Transform):
+    new_point = transform.apply_to_point(point)
+
+    assert new_point.x == point.x + 1
+    assert new_point.y == point.y + 2
+    assert new_point.z == point.z * 0.5
+
+
+def test_points_transform(points: List[Point], transform: Transform):
+    new_points = transform.apply_to_points(points)
+
+    for (i, new_point) in enumerate(new_points):
+        assert new_point.x == points[i].x + 1
+        assert new_point.y == points[i].y + 2
+        assert new_point.z == points[i].z * 0.5
+
+
+def test_point_value_transform(point_value: List[float], transform: Transform):
+    new_coords = transform.apply_to_point_value(point_value)
+
+    assert new_coords[0] == point_value[0] + 1
+    assert new_coords[1] == point_value[1] + 2
+    assert new_coords[2] == point_value[2] * 0.5
+
+
+def test_points_values_transform(points_values: List[float], transform: Transform):
+    new_coords = transform.apply_to_points_values(points_values)
+
+    for i in range(0, len(points_values), 3):
+        assert new_coords[i] == points_values[i] + 1
+        assert new_coords[i + 1] == points_values[i + 1] + 2
+        assert new_coords[i + 2] == points_values[i + 2] * 0.5
+
+
+def test_vector_transform(vector: Vector, transform: Transform):
+    new_vector = transform.apply_to_vector(vector)
+
+    assert new_vector.x == vector.x
+    assert new_vector.y == vector.y
+    assert new_vector.z == vector.z * 0.5
+
+
+def test_vector_value_transform(vector_value: List[float], transform: Transform):
+    new_coords = transform.apply_to_vector_value(vector_value)
+
+    assert new_coords[0] == vector_value[0]
+    assert new_coords[1] == vector_value[1]
+    assert new_coords[2] == vector_value[2] * 0.5
+
+
+def test_transform_fails_with_malformed_value():
+    with pytest.raises(ValueError):
+        Transform.from_list("asdf")
+    with pytest.raises(ValueError):
+        Transform.from_list([7, 8, 9])
+
+
+def test_transform_serialisation(transform: Transform):
+    serialized = operations.serialize(transform)
+    deserialized = operations.deserialize(serialized)
+
+    assert transform.get_id() == deserialized.get_id()

tests/test_user.py

@@ -0,0 +1,60 @@
+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=1)
+class TestUser:
+    def test_user_get_self(self, client, user_dict):
+        fetched_user = client.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_search(self, client, second_user_dict):
+        search_results = client.user.search(search_query=second_user_dict["name"][:5])
+
+        assert isinstance(search_results, list)
+        assert isinstance(search_results[0], User)
+        assert search_results[0].name == second_user_dict["name"]
+
+        second_user_dict["id"] = search_results[0].id
+
+    def test_user_get(self, client, second_user_dict):
+        fetched_user = client.user.get(id=second_user_dict["id"])
+
+        assert isinstance(fetched_user, User)
+        assert fetched_user.name == second_user_dict["name"]
+        assert fetched_user.email == second_user_dict["email"]
+
+        second_user_dict["id"] = fetched_user.id
+
+    def test_user_update(self, client):
+        bio = "i am a ghost in the machine"
+
+        failed_update = client.user.update()
+        updated = client.user.update(bio=bio)
+
+        me = client.user.get()
+
+        assert isinstance(failed_update, SpeckleException)
+        assert updated is True
+        assert me.bio == bio
+
+    def test_user_activity(self, client: SpeckleClient, second_user_dict):
+        my_activity = client.user.activity(limit=10)
+        their_activity = client.user.activity(second_user_dict["id"])
+
+        assert isinstance(my_activity, ActivityCollection)
+        assert isinstance(my_activity.items[0], Activity)
+        assert my_activity.totalCount > 0
+        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 < my_activity.totalCount

tests/test_wrapper.py

@@ -0,0 +1,81 @@
+import pytest
+from specklepy.api.wrapper import StreamWrapper
+
+
+def test_parse_stream():
+    wrap = StreamWrapper("https://testing.speckle.dev/streams/a75ab4f10f")
+    assert wrap.type == "stream"
+
+
+def test_parse_branch():
+    wacky_wrap = StreamWrapper(
+        "https://testing.speckle.dev/streams/4c3ce1459c/branches/%F0%9F%8D%95%E2%AC%85%F0%9F%8C%9F%20you%20wat%3F"
+    )
+    wrap = StreamWrapper(
+        "https://testing.speckle.dev/streams/4c3ce1459c/branches/next%20level"
+    )
+    assert wacky_wrap.type == "branch"
+    assert wacky_wrap.branch_name == "🍕⬅🌟 you wat?"
+    assert wrap.type == "branch"
+
+
+def test_parse_nested_branch():
+    wrap = StreamWrapper(
+        "https://testing.speckle.dev/streams/4c3ce1459c/branches/izzy/dev"
+    )
+
+    assert wrap.branch_name == "izzy/dev"
+    assert wrap.type == "branch"
+
+
+def test_parse_commit():
+    wrap = StreamWrapper(
+        "https://testing.speckle.dev/streams/4c3ce1459c/commits/8b9b831792"
+    )
+    assert wrap.type == "commit"
+
+
+def test_parse_object():
+    wrap = StreamWrapper(
+        "https://testing.speckle.dev/streams/a75ab4f10f/objects/5530363e6d51c904903dafc3ea1d2ec6"
+    )
+    assert wrap.type == "object"
+
+
+def test_parse_globals_as_branch():
+    wrap = StreamWrapper("https://testing.speckle.dev/streams/0c6ad366c4/globals/")
+    assert wrap.type == "branch"
+
+
+def test_parse_globals_as_commit():
+    wrap = StreamWrapper(
+        "https://testing.speckle.dev/streams/0c6ad366c4/globals/abd3787893"
+    )
+    assert wrap.type == "commit"
+
+
+#! NOTE: the following three tests may not pass locally if you have a `speckle.xyz` account in manager
+def test_get_client_without_auth():
+    wrap = StreamWrapper("https://speckle.xyz/streams/4c3ce1459c/commits/8b9b831792")
+    client = wrap.get_client()
+
+    assert client is not None
+
+
+def test_get_new_client_with_token():
+    wrap = StreamWrapper("https://speckle.xyz/streams/4c3ce1459c/commits/8b9b831792")
+    client = wrap.get_client()
+    client = wrap.get_client(token="super-secret-token")
+
+    assert client.account.token == "super-secret-token"
+
+
+def test_get_transport_with_token():
+    wrap = StreamWrapper("https://speckle.xyz/streams/4c3ce1459c/commits/8b9b831792")
+    client = wrap.get_client()
+    assert not client.account.token  # unauthenticated bc no local accounts
+
+    transport = wrap.get_transport(token="super-secret-token")
+
+    assert transport is not None
+    assert client.account.token == "super-secret-token"