Speckle Automate - Python Example

This is a simple example of how to use the Speckle Automate Python package to automate the creation of a Speckle stream.

What this Speckle Function does

This Speckle Function creates a new comment in a Speckle Model. The phrase used in the comment is configured when the Speckle Automation is created; the Speckle Automation links a Speckle Function to a Speckle Model.

The comment is attributed to the user who registered the Function with Speckle Automate.

Using this Speckle Function

1. Create a new Speckle Automation.
2. Select your Speckle Project and Speckle Model.
3. Select the existing Speckle Function named Random comment on IFC beam.
4. Enter a phrase to use in the comment.
5. Click Create Automation.

Getting Started with creating your own Speckle Function

1. Fork this repository.
2. Clone your forked repository to your development environment, or use GitHub CodeSpaces.
3. Register your Function with Speckle Automate.
4. After completing the registration of the Function you will be shown a Function Publish Token and a Function ID. You will need these later.
5. Save your Function Publish Token as a GitHub Action Secret named SPECKLE_AUTOMATE_FUNCTION_PUBLISH_TOKEN.
6. Save your Function ID as a GitHub Action Secret named SPECKLE_AUTOMATE_FUNCTION_ID.
7. Make changes to your Function in main.py. See below for the Developer Requirements, and instructions on how to test.
8. Every commit to main branch will create a new version of your Speckle Function.

Developer Requirements

1. Install the following:
   • Python 3
   • Poetry
2. Run poetry install to install the required Python packages.

Building and Testing

The code can be tested locally by running poetry run pytest. The code should also be packaged into the format required by Speckle Automate, a Docker Container Image, and that should also be tested.

Resources

• Learn more about SpecklePy, and interacting with Speckle from Python.