Polish

PythonStarter/Readme.md

@@ -0,0 +1,14 @@
+# AEC Tech Python Starter
+
+# Usage
+
+This is a demo script 
+
+# Prerequisites
+
+Install `specklepy`
+
+```
+pip install specklepy
+```
+

PythonStarter/test.py

@@ -1,51 +1,56 @@
+# Running this script will pull the latest commit from the main branch
+# of the specified stream and duplicate it inside a different branch.
+# (branch should exist already or the script will fail
+
 from specklepy.api.client import SpeckleClient
 from specklepy.api.credentials import get_default_account, get_local_accounts
 from specklepy.transports.server import ServerTransport
 from specklepy.api import operations
 
+# The id of the stream to work with (we're assuming it already exists in your default account's server)
+streamId = "c1800d795b"
+branchName = "processed"
 # Initialise the Speckle client pointing to your specific server.
 client = SpeckleClient(host="https://speckle.xyz") 
 
 # Get the default account
-# If you have more than one account, or the account is not the default, use get_local_accounts
 account = get_default_account()
+# If you have more than one account, or the account is not the default, use get_local_accounts
+# accounts = get_local_accounts()
+# account = accounts[0]
 
 # Authenticate using the account token
 client.authenticate(token=account.token)
-
-# Your account email
-print('Welcome!!',account.userInfo.email, account.serverInfo.url)
-
-
-# use that stream id to get the stream from the server
-streamId = "42c06de34f"
+# Get the main branch with it's latest commit reference
 branch = client.branch.get(streamId, "main", 1)
+# Get the id of the object referenced in the commit
 hash = branch.commits.items[0].referencedObject
 
 
-
-
-# next create a server transport - this is the vehicle through which you will send and receive
+# Create the server transport for the specified stream.
 transport = ServerTransport(client=client, stream_id=streamId)
 
-# this receives the object back from the transport.
-# the received data will be deserialised back into a `Block` 
+# Receive the object
 received_base = operations.receive(obj_id=hash, remote_transport=transport)
 
-for list in received_base["@data"]:
-    for item in list:
-        item.z += 1
+
+
+
+# The received object, process it as you wish.
+print("Received object:", received_base)
+
 
 
 # this serialises the modified points and sends it to the transport
-hash = operations.send(base=received_base, transports=[transport])
+newHash = operations.send(base=received_base, transports=[transport])
 
 # you can now create a commit on your stream with this object
 commit_id = client.commit.create(
     stream_id=streamId,
-    branch_name="python",
+    branch_name=branchName,
     object_id=hash, 
-    message="Points were modified by AECTechDemo.py script",
+    message="Automatic commit created by AEC Tech Demo by AECTechDemo.py script",
+    source_application="AEC Tech Python Script"
     )
 
-print("Successfully created commit with id:", commit_id)
+print("Successfully created commit with id: ", commit_id)