fix(serializer): wrap traverse_base

moving `begin` and `end_write` to the seriazlier due to the new
sqlite transport with batched writes necessitates a wrapper around
`traverse_base` so end/begin write can be called once at the top level.
just adding begin/end write to the original traversal method would make
tons of calls to `end_write` since the traversal is recursive

.circleci/config.yml

@@ -0,0 +1,79 @@
+version: 2.1
+
+orbs:
+  python: circleci/python@2.0.3
+  codecov: codecov/codecov@3.2.2
+
+jobs:
+  test:
+    docker:
+      - image: "cimg/python:<<parameters.tag>>"
+      - image: "cimg/node:16.15"
+      - image: "cimg/redis:6.2"
+      - image: "cimg/postgres:14.2"
+        environment:
+          POSTGRES_DB: speckle2_test
+          POSTGRES_PASSWORD: speckle
+          POSTGRES_USER: speckle
+      - image: "speckle/speckle-server"
+        command: ["bash", "-c", "/wait && node bin/www"]
+        environment:
+          POSTGRES_URL: "localhost"
+          POSTGRES_USER: "speckle"
+          POSTGRES_PASSWORD: "speckle"
+          POSTGRES_DB: "speckle2_test"
+          REDIS_URL: "redis://localhost"
+          SESSION_SECRET: "keyboard cat"
+          STRATEGY_LOCAL: "true"
+          CANONICAL_URL: "http://localhost:3000"
+          WAIT_HOSTS: localhost:5432, localhost:6379
+          DISABLE_FILE_UPLOADS: "true"
+    parameters:
+      tag:
+        default: "3.8"
+        type: string
+    steps:
+      - checkout
+      - run: python --version
+      - run:
+          command: python -m pip install --upgrade pip
+          name: upgrade pip
+      - python/install-packages:
+          pkg-manager: poetry
+      - run: poetry run pytest --cov --cov-report xml:reports/coverage.xml --junitxml=reports/test-results.xml
+
+      - store_test_results:
+          path: reports
+
+      - store_artifacts:
+          path: reports
+
+      - codecov/upload
+
+  deploy:
+    docker:
+      - image: "cimg/python:3.8"
+    steps:
+      - checkout
+      - run: python patch_version.py $CIRCLE_TAG
+      - run: poetry build
+      - run: poetry publish -u specklesystems -p $PYPI_PASSWORD
+
+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,50 @@
+version: "3.3"  # optional since v1.27.0
+services:
+  postgres:
+    image: cimg/postgres:14.2
+    environment:
+      POSTGRES_DB: speckle2_test
+      POSTGRES_PASSWORD: speckle
+      POSTGRES_USER: speckle
+      # ports:
+      #   - "5432:5432"
+    network_mode: host
+  redis:
+    image: cimg/redis:6.2
+    # ports:
+    #   - "6379:6379"
+    network_mode: host
+  speckle-server:
+    image: speckle/speckle-server
+    command: ["bash", "-c", "/wait && node bin/www"]
+    environment:
+      POSTGRES_URL: "localhost"
+      POSTGRES_USER: "speckle"
+      POSTGRES_PASSWORD: "speckle"
+      POSTGRES_DB: "speckle2_test"
+      REDIS_URL: "redis://localhost"
+      SESSION_SECRET: "keyboard cat"
+      STRATEGY_LOCAL: "true"
+      CANONICAL_URL: "http://localhost:3000"
+      WAIT_HOSTS: localhost:5432, localhost:6379
+      DISABLE_FILE_UPLOADS: "true"
+    # ports:
+    #   - "3000:3000"
+    network_mode: host
+
+  specklepy:
+    build:
+      dockerfile: Dockerfile
+      context: .
+      args:
+        VARIANT: 3.9
+        NODE_VERSION: lts/*
+    volumes:
+      # Mounts the project folder to '/workspace'. While this file is in .devcontainer,
+      # mounts are relative to the first file in the list, which is a level up.
+      - ..:/workspaces/specklepy:cached
+    # Overrides default command so things don't shut down after the process ends.
+    command: /bin/sh -c "while sleep 1000; do :; done"
+    network_mode: host
+# networks:
+#     default:

.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

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

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/many_children.py

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

example/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)
+
+    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)

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,52 @@
+[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 = {extras = ["requests", "websockets"], version = "^3.3.0"}
+ujson = "^4.3.0"
+Deprecated = "^1.2.13"
+
+[tool.poetry.dev-dependencies]
+black = "^20.8b1"
+isort = "^5.7.0"
+pytest = "^6.2.2"
+pytest-ordering = "^0.6"
+pytest-cov = "^3.0.0"
+devtools = "^0.8.0"
+
+
+[tool.black]
+exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+)/
+'''
+include = '\.pyi?$'
+line-length = 88
+target-version = ["py36", "py37", "py38"]
+
+
+[build-system]
+requires = ["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

speckle/objects/built_elements/beam.py

@@ -1,51 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Beam.json
-#   timestamp: 2020-11-24T16:33:00+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Beam(BaseModel):
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/built_elements/brace.py

@@ -1,51 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Brace.json
-#   timestamp: 2020-11-24T16:33:02+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Brace(BaseModel):
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/built_elements/column.py

@@ -1,52 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Column.json
-#   timestamp: 2020-11-24T16:33:04+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Column(BaseModel):
-    height: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/built_elements/duct.py

@@ -1,57 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Duct.json
-#   timestamp: 2020-11-24T16:33:07+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Duct(BaseModel):
-    width: Optional[float] = None
-    height: Optional[float] = None
-    diameter: Optional[float] = None
-    length: Optional[float] = None
-    level: Optional[Level] = None
-    velocity: Optional[float] = None
-    system: Optional[Optional[str]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/built_elements/element.py

@@ -1,51 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Element.json
-#   timestamp: 2020-11-24T16:33:08+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Element(BaseModel):
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/built_elements/floor.py

@@ -1,56 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Floor.json
-#   timestamp: 2020-11-24T16:33:10+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class ICurve(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Floor(BaseModel):
-    holes: Optional[List[ICurve]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/built_elements/grid_line.py

@@ -1,67 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  GridLine.json
-#   timestamp: 2020-11-24T16:33:12+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Interval(BaseModel):
-    start: Optional[Optional[float]] = None
-    end: Optional[Optional[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Line(BaseModel):
-    value: Optional[List[float]] = None
-    domain: Optional[Interval] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class GridLine(BaseModel):
-    baseLine: Optional[Line] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/built_elements/level.py

@@ -1,40 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Level.json
-#   timestamp: 2020-11-24T16:33:15+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/built_elements/opening.py

@@ -1,51 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Opening.json
-#   timestamp: 2020-11-24T16:33:18+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Opening(BaseModel):
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/built_elements/roof.py

@@ -1,56 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Roof.json
-#   timestamp: 2020-11-24T16:33:33+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class ICurve(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Roof(BaseModel):
-    holes: Optional[List[ICurve]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/built_elements/room.py

@@ -1,59 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Room.json
-#   timestamp: 2020-11-24T16:33:34+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class ICurve(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Room(BaseModel):
-    number: Optional[Optional[str]] = None
-    area: Optional[float] = None
-    volume: Optional[float] = None
-    holes: Optional[List[ICurve]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/built_elements/topography.py

@@ -1,28 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Topography.json
-#   timestamp: 2020-11-24T16:33:35+00:00
-
-from __future__ import annotations
-
-from typing import List, Optional
-
-from pydantic import BaseModel
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Topography(BaseModel):
-    baseGeometry: Optional[Mesh] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/built_elements/wall.py

@@ -1,52 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Wall.json
-#   timestamp: 2020-11-24T16:33:37+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Wall(BaseModel):
-    height: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/geometry/Arc.py

@@ -1,61 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Arc.json
-#   timestamp: 2020-11-24T16:32:59+00:00
-
-from __future__ import annotations
-
-from typing import List, Optional
-
-from pydantic import BaseModel
-
-
-class Interval(BaseModel):
-    start: Optional[Optional[float]] = None
-    end: Optional[Optional[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Point(BaseModel):
-    value: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Vector(BaseModel):
-    value: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Plane(BaseModel):
-    origin: Optional[Point] = None
-    normal: Optional[Vector] = None
-    xdir: Optional[Vector] = None
-    ydir: Optional[Vector] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Arc(BaseModel):
-    radius: Optional[Optional[float]] = None
-    startAngle: Optional[Optional[float]] = None
-    endAngle: Optional[Optional[float]] = None
-    angleRadians: Optional[Optional[float]] = None
-    plane: Optional[Plane] = None
-    domain: Optional[Interval] = None
-    startPoint: Optional[Point] = None
-    midPoint: Optional[Point] = None
-    endPoint: Optional[Point] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/geometry/Block.py

@@ -1,25 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Block.json
-#   timestamp: 2020-11-24T16:33:01+00:00
-
-from __future__ import annotations
-
-from typing import List, Optional
-
-from pydantic import BaseModel
-
-
-class Base(BaseModel):
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Block(BaseModel):
-    description: Optional[Optional[str]] = None
-    objects: Optional[List[Base]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/geometry/Box.py

@@ -1,56 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Box.json
-#   timestamp: 2020-11-24T16:33:02+00:00
-
-from __future__ import annotations
-
-from typing import List, Optional
-
-from pydantic import BaseModel
-
-
-class Interval(BaseModel):
-    start: Optional[Optional[float]] = None
-    end: Optional[Optional[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Point(BaseModel):
-    value: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Vector(BaseModel):
-    value: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Plane(BaseModel):
-    origin: Optional[Point] = None
-    normal: Optional[Vector] = None
-    xdir: Optional[Vector] = None
-    ydir: Optional[Vector] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Box(BaseModel):
-    basePlane: Optional[Plane] = None
-    xSize: Optional[Interval] = None
-    ySize: Optional[Interval] = None
-    zSize: Optional[Interval] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/geometry/Circle.py

@@ -1,55 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Circle.json
-#   timestamp: 2020-11-24T16:33:04+00:00
-
-from __future__ import annotations
-
-from typing import List, Optional
-
-from pydantic import BaseModel
-
-
-class Interval(BaseModel):
-    start: Optional[Optional[float]] = None
-    end: Optional[Optional[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Point(BaseModel):
-    value: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Vector(BaseModel):
-    value: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Plane(BaseModel):
-    origin: Optional[Point] = None
-    normal: Optional[Vector] = None
-    xdir: Optional[Vector] = None
-    ydir: Optional[Vector] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Circle(BaseModel):
-    radius: Optional[Optional[float]] = None
-    plane: Optional[Plane] = None
-    domain: Optional[Interval] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/geometry/Curve.py

@@ -1,44 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Curve.json
-#   timestamp: 2020-11-24T16:33:05+00:00
-
-from __future__ import annotations
-
-from typing import List, Optional
-
-from pydantic import BaseModel
-
-
-class Interval(BaseModel):
-    start: Optional[Optional[float]] = None
-    end: Optional[Optional[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Polyline(BaseModel):
-    value: Optional[List[float]] = None
-    closed: Optional[bool] = None
-    domain: Optional[Interval] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Curve(BaseModel):
-    degree: Optional[int] = None
-    periodic: Optional[bool] = None
-    rational: Optional[bool] = None
-    points: Optional[List[float]] = None
-    weights: Optional[List[float]] = None
-    knots: Optional[List[float]] = None
-    domain: Optional[Interval] = None
-    displayValue: Optional[Polyline] = None
-    closed: Optional[bool] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/geometry/Ellipse.py

@@ -1,56 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Ellipse.json
-#   timestamp: 2020-11-24T16:33:08+00:00
-
-from __future__ import annotations
-
-from typing import List, Optional
-
-from pydantic import BaseModel
-
-
-class Interval(BaseModel):
-    start: Optional[Optional[float]] = None
-    end: Optional[Optional[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Point(BaseModel):
-    value: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Vector(BaseModel):
-    value: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Plane(BaseModel):
-    origin: Optional[Point] = None
-    normal: Optional[Vector] = None
-    xdir: Optional[Vector] = None
-    ydir: Optional[Vector] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Ellipse(BaseModel):
-    firstRadius: Optional[Optional[float]] = None
-    secondRadius: Optional[Optional[float]] = None
-    plane: Optional[Plane] = None
-    domain: Optional[Interval] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/geometry/Extrusion.py

@@ -1,39 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Extrusion.json
-#   timestamp: 2020-11-24T16:33:09+00:00
-
-from __future__ import annotations
-
-from typing import List, Optional
-
-from pydantic import BaseModel
-
-
-class Base(BaseModel):
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Point(BaseModel):
-    value: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Extrusion(BaseModel):
-    length: Optional[Optional[float]] = None
-    capped: Optional[Optional[bool]] = None
-    profile: Optional[Base] = None
-    pathStart: Optional[Point] = None
-    pathEnd: Optional[Point] = None
-    pathCurve: Optional[Base] = None
-    pathTangent: Optional[Base] = None
-    profiles: Optional[List[Base]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/geometry/Line.py

@@ -1,27 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Line.json
-#   timestamp: 2020-11-24T16:33:16+00:00
-
-from __future__ import annotations
-
-from typing import List, Optional
-
-from pydantic import BaseModel
-
-
-class Interval(BaseModel):
-    start: Optional[Optional[float]] = None
-    end: Optional[Optional[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Line(BaseModel):
-    value: Optional[List[float]] = None
-    domain: Optional[Interval] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/geometry/Mesh.py

@@ -1,20 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Mesh.json
-#   timestamp: 2020-11-24T16:33:16+00:00
-
-from __future__ import annotations
-
-from typing import List, Optional
-
-from pydantic import BaseModel
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/geometry/Plane.py

@@ -1,36 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Plane.json
-#   timestamp: 2020-11-24T16:33:19+00:00
-
-from __future__ import annotations
-
-from typing import List, Optional
-
-from pydantic import BaseModel
-
-
-class Point(BaseModel):
-    value: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Vector(BaseModel):
-    value: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Plane(BaseModel):
-    origin: Optional[Point] = None
-    normal: Optional[Vector] = None
-    xdir: Optional[Vector] = None
-    ydir: Optional[Vector] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/geometry/Point.py

@@ -1,17 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Point.json
-#   timestamp: 2020-11-24T16:33:20+00:00
-
-from __future__ import annotations
-
-from typing import List, Optional
-
-from pydantic import BaseModel
-
-
-class Point(BaseModel):
-    value: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/geometry/Polycurve.py

@@ -1,32 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Polycurve.json
-#   timestamp: 2020-11-24T16:33:20+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class ICurve(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Interval(BaseModel):
-    start: Optional[Optional[float]] = None
-    end: Optional[Optional[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Polycurve(BaseModel):
-    segments: Optional[List[ICurve]] = None
-    domain: Optional[Interval] = None
-    closed: Optional[bool] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/geometry/Polyline.py

@@ -1,28 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Polyline.json
-#   timestamp: 2020-11-24T16:33:21+00:00
-
-from __future__ import annotations
-
-from typing import List, Optional
-
-from pydantic import BaseModel
-
-
-class Interval(BaseModel):
-    start: Optional[Optional[float]] = None
-    end: Optional[Optional[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Polyline(BaseModel):
-    value: Optional[List[float]] = None
-    closed: Optional[bool] = None
-    domain: Optional[Interval] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/geometry/Vector.py

@@ -1,17 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Vector.json
-#   timestamp: 2020-11-24T16:33:36+00:00
-
-from __future__ import annotations
-
-from typing import List, Optional
-
-from pydantic import BaseModel
-
-
-class Vector(BaseModel):
-    value: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/primitives/interval.py

@@ -1,18 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Interval.json
-#   timestamp: 2020-11-24T16:33:14+00:00
-
-from __future__ import annotations
-
-from typing import Optional
-
-from pydantic import BaseModel
-
-
-class Interval(BaseModel):
-    start: Optional[Optional[float]] = None
-    end: Optional[Optional[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/primitives/interval2d.py

@@ -1,27 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  Interval2d.json
-#   timestamp: 2020-11-24T16:33:14+00:00
-
-from __future__ import annotations
-
-from typing import Optional
-
-from pydantic import BaseModel
-
-
-class Interval(BaseModel):
-    start: Optional[Optional[float]] = None
-    end: Optional[Optional[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Interval2d(BaseModel):
-    u: Optional[Interval] = None
-    v: Optional[Interval] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/revit/adaptive_component.py

@@ -1,54 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  AdaptiveComponent.json
-#   timestamp: 2020-11-24T16:32:59+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class AdaptiveComponent(BaseModel):
-    family: Optional[Optional[str]] = None
-    flipped: Optional[bool] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/detail_curve.py

@@ -1,22 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  DetailCurve.json
-#   timestamp: 2020-11-24T16:33:06+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, Optional
-
-from pydantic import BaseModel
-
-
-class ICurve(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class DetailCurve(BaseModel):
-    baseCurve: Optional[ICurve] = None
-    lineStyle: Optional[Optional[str]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/revit/direct_shape.py

@@ -1,94 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  DirectShape.json
-#   timestamp: 2020-11-24T16:33:06+00:00
-
-from __future__ import annotations
-
-from enum import Enum
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class Category(Enum):
-    integer_0 = 0
-    integer_1 = 1
-    integer_2 = 2
-    integer_3 = 3
-    integer_4 = 4
-    integer_5 = 5
-    integer_6 = 6
-    integer_7 = 7
-    integer_8 = 8
-    integer_9 = 9
-    integer_10 = 10
-    integer_11 = 11
-    integer_12 = 12
-    integer_13 = 13
-    integer_14 = 14
-    integer_15 = 15
-    integer_16 = 16
-    integer_17 = 17
-    integer_18 = 18
-    integer_19 = 19
-    integer_20 = 20
-    integer_21 = 21
-    integer_22 = 22
-    integer_23 = 23
-    integer_24 = 24
-    integer_25 = 25
-    integer_26 = 26
-    integer_27 = 27
-    integer_28 = 28
-    integer_29 = 29
-    integer_30 = 30
-    integer_31 = 31
-    integer_32 = 32
-    integer_33 = 33
-    integer_34 = 34
-    integer_35 = 35
-    integer_36 = 36
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class DirectShape(BaseModel):
-    category: Optional[Category] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/family_instance.py

@@ -1,66 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  FamilyInstance.json
-#   timestamp: 2020-11-24T16:33:10+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Element(BaseModel):
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class FamilyInstance(BaseModel):
-    family: Optional[Optional[str]] = None
-    flipped: Optional[bool] = None
-    host: Optional[Element] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/model_curve.py

@@ -1,22 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  ModelCurve.json
-#   timestamp: 2020-11-24T16:33:17+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, Optional
-
-from pydantic import BaseModel
-
-
-class ICurve(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class ModelCurve(BaseModel):
-    baseCurve: Optional[ICurve] = None
-    lineStyle: Optional[Optional[str]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/revit/revit_beam.py

@@ -1,53 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitBeam.json
-#   timestamp: 2020-11-24T16:33:22+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class RevitBeam(BaseModel):
-    family: Optional[Optional[str]] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/revit_brace.py

@@ -1,53 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitBrace.json
-#   timestamp: 2020-11-24T16:33:22+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class RevitBrace(BaseModel):
-    family: Optional[Optional[str]] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/revit_category.py

@@ -1,47 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitCategory.json
-#   timestamp: 2020-11-24T16:33:23+00:00
-
-from __future__ import annotations
-
-from enum import Enum
-
-
-class RevitCategory(Enum):
-    integer_0 = 0
-    integer_1 = 1
-    integer_2 = 2
-    integer_3 = 3
-    integer_4 = 4
-    integer_5 = 5
-    integer_6 = 6
-    integer_7 = 7
-    integer_8 = 8
-    integer_9 = 9
-    integer_10 = 10
-    integer_11 = 11
-    integer_12 = 12
-    integer_13 = 13
-    integer_14 = 14
-    integer_15 = 15
-    integer_16 = 16
-    integer_17 = 17
-    integer_18 = 18
-    integer_19 = 19
-    integer_20 = 20
-    integer_21 = 21
-    integer_22 = 22
-    integer_23 = 23
-    integer_24 = 24
-    integer_25 = 25
-    integer_26 = 26
-    integer_27 = 27
-    integer_28 = 28
-    integer_29 = 29
-    integer_30 = 30
-    integer_31 = 31
-    integer_32 = 32
-    integer_33 = 33
-    integer_34 = 34
-    integer_35 = 35
-    integer_36 = 36

speckle/objects/revit/revit_column.py

@@ -1,57 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitColumn.json
-#   timestamp: 2020-11-24T16:33:24+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class RevitColumn(BaseModel):
-    family: Optional[Optional[str]] = None
-    topLevel: Optional[Level] = None
-    baseOffset: Optional[float] = None
-    topOffset: Optional[float] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-    height: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/revit_duct.py

@@ -1,59 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitDuct.json
-#   timestamp: 2020-11-24T16:33:25+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class RevitDuct(BaseModel):
-    family: Optional[Optional[str]] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-    width: Optional[float] = None
-    height: Optional[float] = None
-    diameter: Optional[float] = None
-    length: Optional[float] = None
-    level: Optional[Level] = None
-    velocity: Optional[float] = None
-    system: Optional[Optional[str]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/revit_extrusion_roof.py

@@ -1,78 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitExtrusionRoof.json
-#   timestamp: 2020-11-24T16:33:25+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class ICurve(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Interval(BaseModel):
-    start: Optional[Optional[float]] = None
-    end: Optional[Optional[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Line(BaseModel):
-    value: Optional[List[float]] = None
-    domain: Optional[Interval] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class RevitExtrusionRoof(BaseModel):
-    start: Optional[float] = None
-    end: Optional[float] = None
-    referenceLine: Optional[Line] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-    holes: Optional[List[ICurve]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/revit_floor.py

@@ -1,57 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitFloor.json
-#   timestamp: 2020-11-24T16:33:26+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class ICurve(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class RevitFloor(BaseModel):
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-    holes: Optional[List[ICurve]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/revit_footprint_roof.py

@@ -1,58 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitFootprintRoof.json
-#   timestamp: 2020-11-24T16:33:27+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class ICurve(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class RevitFootprintRoof(BaseModel):
-    cutOffLevel: Optional[Level] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-    holes: Optional[List[ICurve]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/revit_level.py

@@ -1,55 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitLevel.json
-#   timestamp: 2020-11-24T16:33:28+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class RevitLevel(BaseModel):
-    createView: Optional[bool] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/revit_room.py

@@ -1,68 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitRoom.json
-#   timestamp: 2020-11-24T16:33:28+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class ICurve(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Point(BaseModel):
-    value: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class RevitRoom(BaseModel):
-    basePoint: Optional[Point] = None
-    number: Optional[Optional[str]] = None
-    area: Optional[float] = None
-    volume: Optional[float] = None
-    holes: Optional[List[ICurve]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/revit_shaft.py

@@ -1,53 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitShaft.json
-#   timestamp: 2020-11-24T16:33:29+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class RevitShaft(BaseModel):
-    topLevel: Optional[Level] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/revit_topography.py

@@ -1,28 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitTopography.json
-#   timestamp: 2020-11-24T16:33:30+00:00
-
-from __future__ import annotations
-
-from typing import List, Optional
-
-from pydantic import BaseModel
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class RevitTopography(BaseModel):
-    baseGeometry: Optional[Mesh] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

speckle/objects/revit/revit_utils.py

@@ -1,11 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitUtils.json
-#   timestamp: 2020-11-24T16:33:30+00:00
-
-from __future__ import annotations
-
-from pydantic import BaseModel
-
-
-class RevitUtils(BaseModel):
-    pass

speckle/objects/revit/revit_vertical_opening.py

@@ -1,64 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitVerticalOpening.json
-#   timestamp: 2020-11-24T16:33:31+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Element(BaseModel):
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class RevitVerticalOpening(BaseModel):
-    host: Optional[Element] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/revit_wall.py

@@ -1,45 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitWall.json
-#   timestamp: 2020-11-24T16:33:32+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class RevitWall(BaseModel):
-    topLevel: Optional[Level] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/revit_wall_opening.py

@@ -1,58 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RevitWallOpening.json
-#   timestamp: 2020-11-24T16:33:33+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import BaseModel
-
-
-class IGeometry(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class Mesh(BaseModel):
-    vertices: Optional[List[float]] = None
-    faces: Optional[List[int]] = None
-    colors: Optional[List[int]] = None
-    textureCoordinates: Optional[List[float]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class Level(BaseModel):
-    name: Optional[Optional[str]] = None
-    elevation: Optional[float] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-class RevitWall(BaseModel):
-    topLevel: Optional[Level] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-
-
-class RevitWallOpening(BaseModel):
-    host: Optional[RevitWall] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-    baseGeometry: Optional[IGeometry] = None
-    displayMesh: Optional[Mesh] = None
-    type: Optional[Optional[str]] = None
-    level: Optional[Level] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None
-
-
-Level.update_forward_refs()

speckle/objects/revit/room_boundary_line.py

@@ -1,22 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  RoomBoundaryLine.json
-#   timestamp: 2020-11-24T16:33:35+00:00
-
-from __future__ import annotations
-
-from typing import Any, Dict, Optional
-
-from pydantic import BaseModel
-
-
-class ICurve(BaseModel):
-    __root__: Optional[Dict[str, Any]]
-
-
-class RoomBoundaryLine(BaseModel):
-    baseCurve: Optional[ICurve] = None
-    parameters: Optional[Optional[Dict[str, Any]]] = None
-    id: Optional[Optional[str]] = None
-    totalChildrenCount: Optional[int] = None
-    applicationId: Optional[Optional[str]] = None
-    speckle_type: Optional[Optional[str]] = None

specklepy/api/client.py

@@ -0,0 +1,196 @@
+import re
+from warnings import warn
+from deprecated import deprecated
+from specklepy.api.credentials import Account, get_account_from_token
+from specklepy.logging import metrics
+from specklepy.logging.exceptions import (
+    SpeckleException,
+    SpeckleWarning,
+)
+from typing import Dict
+
+from specklepy.api import resources
+from specklepy.api.resources import (
+    branch,
+    commit,
+    stream,
+    object,
+    server,
+    user,
+    subscriptions,
+)
+from specklepy.api.models import ServerInfo
+from gql import Client
+from gql.transport.requests import RequestsHTTPTransport
+from gql.transport.websockets import WebsocketsTransport
+
+
+class SpeckleClient:
+    """
+    The `SpeckleClient` is your entry point for interacting with your Speckle Server's GraphQL API.
+    You'll need to have access to a server to use it, or you can use our public server `speckle.xyz`.
+
+    To authenticate the client, you'll need to have downloaded the [Speckle Manager](https://speckle.guide/#speckle-manager)
+    and added your account.
+
+    ```py
+    from specklepy.api.client import SpeckleClient
+    from specklepy.api.credentials import get_default_account
+
+    # initialise the client
+    client = SpeckleClient(host="speckle.xyz") # or whatever your host is
+    # client = SpeckleClient(host="localhost:3000", use_ssl=False) or use local server
+
+    # authenticate the client with an account (account has been added in Speckle Manager)
+    account = get_default_account()
+    client.authenticate_with_account(account)
+
+    # create a new stream. this returns the stream id
+    new_stream_id = client.stream.create(name="a shiny new stream")
+
+    # use that stream id to get the stream from the server
+    new_stream = client.stream.get(id=new_stream_id)
+    ```
+    """
+
+    DEFAULT_HOST = "speckle.xyz"
+    USE_SSL = True
+
+    def __init__(self, host: str = DEFAULT_HOST, use_ssl: bool = USE_SSL) -> None:
+        metrics.track(metrics.CLIENT, custom_props={"name": "create"})
+        ws_protocol = "ws"
+        http_protocol = "http"
+
+        if use_ssl:
+            ws_protocol = "wss"
+            http_protocol = "https"
+
+        # sanitise host input by removing protocol and trailing slash
+        host = re.sub(r"((^\w+:|^)\/\/)|(\/$)", "", host)
+
+        self.url = f"{http_protocol}://{host}"
+        self.graphql = f"{self.url}/graphql"
+        self.ws_url = f"{ws_protocol}://{host}/graphql"
+        self.account = Account()
+
+        self.httpclient = Client(
+            transport=RequestsHTTPTransport(url=self.graphql, verify=True, retries=3)
+        )
+        self.wsclient = None
+
+        self._init_resources()
+
+        # ? Check compatibility with the server - i think we can skip this at this point? save a request
+        # try:
+        #     server_info = self.server.get()
+        #     if isinstance(server_info, Exception):
+        #         raise server_info
+        #     if not isinstance(server_info, ServerInfo):
+        #         raise Exception("Couldn't get ServerInfo")
+        # except Exception as ex:
+        #     raise SpeckleException(
+        #         f"{self.url} is not a compatible Speckle Server", ex
+        #     ) from ex
+
+    def __repr__(self):
+        return f"SpeckleClient( server: {self.url}, authenticated: {self.account.token is not None} )"
+
+    @deprecated(
+        version="2.6.0",
+        reason="Renamed: please use `authenticate_with_account` or `authenticate_with_token` instead.",
+    )
+    def authenticate(self, token: str) -> None:
+        """Authenticate the client using a personal access token
+        The token is saved in the client object and a synchronous GraphQL entrypoint is created
+
+        Arguments:
+            token {str} -- an api token
+        """
+        self.authenticate_with_token(token)
+        self._set_up_client()
+
+    def authenticate_with_token(self, token: str) -> None:
+        """Authenticate the client using a personal access token
+        The token is saved in the client object and a synchronous GraphQL entrypoint is created
+
+        Arguments:
+            token {str} -- an api token
+        """
+        self.account = get_account_from_token(token, self.url)
+        metrics.track(metrics.CLIENT, self.account, {"name": "authenticate with token"})
+        self._set_up_client()
+
+    def authenticate_with_account(self, account: Account) -> None:
+        """Authenticate the client using an Account object
+        The account is saved in the client object and a synchronous GraphQL entrypoint is created
+
+        Arguments:
+            account {Account} -- the account object which can be found with `get_default_account` or `get_local_accounts`
+        """
+        metrics.track(metrics.CLIENT, account, {"name": "authenticate with account"})
+        self.account = account
+        self._set_up_client()
+
+    def _set_up_client(self) -> None:
+        metrics.track(metrics.CLIENT, self.account, {"name": "set up client"})
+        headers = {
+            "Authorization": f"Bearer {self.account.token}",
+            "Content-Type": "application/json",
+        }
+        httptransport = RequestsHTTPTransport(
+            url=self.graphql, headers=headers, verify=True, retries=3
+        )
+        wstransport = WebsocketsTransport(
+            url=self.ws_url,
+            init_payload={"Authorization": f"Bearer {self.account.token}"},
+        )
+        self.httpclient = Client(transport=httptransport)
+        self.wsclient = Client(transport=wstransport)
+
+        self._init_resources()
+
+        if self.user.get() is None:
+            warn(
+                SpeckleWarning(
+                    f"Possibly invalid token - could not authenticate Speckle Client for server {self.url}"
+                )
+            )
+
+    def execute_query(self, query: str) -> Dict:
+        return self.httpclient.execute(query)
+
+    def _init_resources(self) -> None:
+        self.stream = stream.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.commit = commit.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.branch = branch.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.object = object.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.server = server.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.user = user.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.subscribe = subscriptions.Resource(
+            account=self.account,
+            basepath=self.ws_url,
+            client=self.wsclient,
+        )
+
+    def __getattr__(self, name):
+        try:
+            attr = getattr(resources, name)
+            return attr.Resource(
+                account=self.account, basepath=self.url, client=self.httpclient
+            )
+        except:
+            raise SpeckleException(
+                f"Method {name} is not supported by the SpeckleClient class"
+            )

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

specklepy/api/operations.py

@@ -0,0 +1,123 @@
+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)
+
+    obj_hash, _ = serializer.write_json(base=base)
+
+    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 with deserialisation using the local transport
+    obj_string = local_transport.get_object(obj_id)
+    if obj_string:
+        return serializer.read_json(obj_string=obj_string)
+
+    if not remote_transport:
+        raise SpeckleException(
+            message="Could not find the specified object using the local transport, and you didn't provide a fallback remote from which to pull it."
+        )
+
+    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 successful
+        """
+        metrics.track(metrics.BRANCH, self.account, {"name": "update"})
+        query = gql(
+            """
+            mutation  BranchUpdate($branch: BranchUpdateInput!) {
+                branchUpdate(branch: $branch)
+                }
+            """
+        )
+        params = {
+            "branch": {
+                "streamId": stream_id,
+                "id": branch_id,
+            }
+        }
+
+        if name:
+            params["branch"]["name"] = name
+        if description:
+            params["branch"]["description"] = description
+
+        return self.make_request(
+            query=query, params=params, return_type="branchUpdate", parse_response=False
+        )
+
+    def delete(self, stream_id: str, branch_id: str):
+        """Delete a branch
+
+        Arguments:
+            stream_id {str} -- the id of the stream containing the branch to delete
+            branch_id {str} -- the branch to delete
+
+        Returns:
+            bool -- True if deletion is successful
+        """
+        metrics.track(metrics.BRANCH, self.account, {"name": "delete"})
+        query = gql(
+            """
+            mutation BranchDelete($branch: BranchDeleteInput!) {
+                branchDelete(branch: $branch)
+            }
+            """
+        )
+
+        params = {"branch": {"streamId": stream_id, "id": branch_id}}
+
+        return self.make_request(
+            query=query, params=params, return_type="branchDelete", parse_response=False
+        )

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

specklepy/api/resources/server.py

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

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/speckle2schema.graphql

@@ -445,7 +445,7 @@ input ServerInfoUpdateInput {
   stream( id: String! ): Stream
 
   """
-  All the streams of the current user, pass in the `query` parameter to seach by name, description or ID.
+  All the streams of the current user, pass in the `query` parameter to search by name, description or ID.
   """
   streams( query: String, limit: Int = 25, cursor: String ): StreamCollection
     @hasScope(scope: "streams:read")

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,142 @@
+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"
+HOST_APP_VERSION = f"python {'.'.join(map(str, sys.version_info[:3]))}"
+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"
+SERVER = "Server Action"
+CLIENT = "Speckle Client"
+STREAM_WRAPPER = "Stream Wrapper"
+
+ACCOUNTS = "Get Local Accounts"
+
+SERIALIZE = "serialization/serialize"
+DESERIALIZE = "serialization/deserialize"
+
+
+def disable():
+    global TRACK
+    TRACK = False
+
+
+def enable():
+    global TRACK
+    TRACK = True
+
+
+def set_host_app(host_app: str, host_app_version: str = None):
+    global HOST_APP, HOST_APP_VERSION
+    HOST_APP = host_app
+    HOST_APP_VERSION = host_app_version or HOST_APP_VERSION
+
+
+def track(action: str, account: "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,
+                "hostAppVersion": HOST_APP_VERSION,
+                "$os": METRICS_TRACKER.platform,
+                "type": "action",
+            },
+        }
+        if custom_props:
+            event_params["properties"].update(custom_props)
+
+        METRICS_TRACKER.queue.put_nowait(event_params)
+    except Exception as ex:
+        # wrapping this whole thing in a try except as we never want a failure here to annoy users!
+        LOG.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 = int(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