bump dependencies (#88)

* bump dependencies

* chore: bump python in more places

.devcontainer/devcontainer.json

@@ -4,9 +4,6 @@
   "name": "Python 3",
   // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
   "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
-  "features": {
-    "ghcr.io/devcontainers-contrib/features/poetry:2": {}
-  },
 
   "remoteEnv": {
     "SPECKLE_TOKEN": "foobar"
@@ -22,7 +19,7 @@
   // "forwardPorts": [],
 
   // Use 'postCreateCommand' to run commands after the container is created.
-  "postCreateCommand": "cp .env.example .env && POETRY_VIRTUALENVS_IN_PROJECT=true poetry install --no-root",
+  "postCreateCommand": "cp .env.example .env && python -m venv .venv && . .venv/bin/activate && pip install --upgrade pip && pip install .[dev]",
 
   // Configure tool-specific properties.
   "customizations": {

.env.example

@@ -1 +1,4 @@
-SPECKLE_TOKEN=mytoken
+SPECKLE_TOKEN="mytoken"
+SPECKLE_SERVER_URL="http://127.0.0.1:3000"
+SPECKLE_PROJECT_ID=""
+SPECKLE_AUTOMATION_ID=""

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/main.yml

@@ -1,9 +1,9 @@
-name: 'build and deploy Speckle functions'
+name: "build and deploy Speckle functions"
 on:
   workflow_dispatch:
   push:
     tags:
-      - '*'
+      - "*"
 
 jobs:
   publish-automate-function-version: # make sure the action works on a clean machine without building
@@ -11,28 +11,22 @@ jobs:
       FUNCTION_SCHEMA_FILE_NAME: functionSchema.json
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3.4.0
+      - uses: actions/checkout@v5.0.0
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
+          python-version: "3.13"
-      - name: Install and configure Poetry
+      - name: Install dependencies
-        uses: snok/install-poetry@v1
+        run: |
-        with:
+          pip install .[dev]
-          version: 1.3.2
-          virtualenvs-create: false
-          virtualenvs-in-project: false
-          installer-parallel: true
-      - name: Restore dependencies
-        run: poetry install --no-root
       - name: Extract functionInputSchema
         id: extract_schema
         run: |
           python main.py generate_schema ${HOME}/${{ env.FUNCTION_SCHEMA_FILE_NAME }}
       - name: Speckle Automate Function - Build and Publish
-        uses: specklesystems/speckle-automate-github-composite-action@0.6.7
+        uses: specklesystems/speckle-automate-github-composite-action@0.8.1
         with:
-          speckle_automate_url: ${{ env.SPECKLE_AUTOMATE_URL || 'https://automate.speckle.dev' }} 
+          speckle_automate_url: ${{ env.SPECKLE_AUTOMATE_URL || vars.SPECKLE_AUTOMATE_URL || 'https://automate.speckle.dev' }}
           speckle_token: ${{ secrets.SPECKLE_FUNCTION_TOKEN }}
           speckle_function_id: ${{ secrets.SPECKLE_FUNCTION_ID }}
           speckle_function_input_schema_file_path: ${{ env.FUNCTION_SCHEMA_FILE_NAME }}
-          speckle_function_command: 'python main.py run'
+          speckle_function_command: "python -u main.py run"

.gitignore

@@ -1,6 +1,8 @@
 # Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,python,pycharm
 # Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,python,pycharm
 
+function_inputs.json
+
 **/.env
 **/.envrc
 

.vscode/launch.json

@@ -6,18 +6,13 @@
   "configurations": [
     {
       "name": "Speckle Automate function",
-      "type": "python",
+      "type": "debugpy",
       "request": "launch",
       "program": "main.py",
       "console": "integratedTerminal",
       "justMyCode": true,
       "envFile": "${workspaceFolder}/.env",
-      "args": [
+      "args": ["run", "function_inputs.json"]
-        "run",
-        "{\"projectId\": \"843d07eb10\", \"modelId\": \"base design\", \"versionId\": \"2a32ccfee1\", \"speckleServerUrl\": \"https://latest.speckle.systems\"}",
-        // make sure to use camelCase for variable names
-        "{\"forbiddenSpeckleType\": \"Objects.Geometry.Brep\"}"
-      ]
     }
   ]
 }

Dockerfile

@@ -1,6 +1,16 @@
-FROM python:3.11-slim
+# We use the official Python 3.11 image as our base image and will add our code to it. For more details, see https://hub.docker.com/_/python
+FROM python:3.13-slim
 
-RUN pip install poetry
+# We set the working directory to be the /home/speckle directory; all of our files will be copied here.
+WORKDIR /home/speckle
 
-COPY . .
+# Copy pyproject.toml first to leverage Docker layer caching
-RUN poetry export -f requirements.txt --output requirements.txt && pip install -r requirements.txt
+COPY pyproject.toml /home/speckle/
+
+# Install the required Python packages (production dependencies only)
+RUN pip install --no-cache-dir .
+
+# Copy all of our code and assets from the local directory into the /home/speckle directory of the container.
+# We also ensure that the user 'speckle' owns these files, so it can access them
+# This assumes that the Dockerfile is in the same directory as the rest of the code
+COPY . /home/speckle

LICENSE

@@ -0,0 +1,208 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 AEC Systems
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+   
+   NOTICE: Unless otherwise described, the code in this repository is 
+   licensed under the license above. Some modules, extensions or code herein 
+   might be otherwise licensed. This is indicated either in the root of the 
+   containing folder under a different license file, or in the respective 
+   file's header. If you have any questions, don't hesitate to get in touch 
+   with us via [email](mailto:hello@speckle.systems).

README.md

@@ -1,73 +1,174 @@
 # Speckle Automate function template - Python
 
-
+This template repository is for a Speckle Automate function written in Python
-This is a template repository for a Speckle Automate functions written in python
 using the [specklepy](https://pypi.org/project/specklepy/) SDK to interact with Speckle data.
 
-This template contains the full scaffolding required to publish a function to the automate environment.
+This template contains the full scaffolding required to publish a function to the Automate environment.
-Also has some sane defaults for a development environment setups.
+It also has some sane defaults for development environment setups.
 
 ## Getting started
 
 1. Use this template repository to create a new repository in your own / organization's profile.
-
+1. Register the function
-Register the function 
 
 ### Add new dependencies
 
-To add new python package dependencies to the project, use:
+To add new Python package dependencies to the project, edit the `pyproject.toml` file:
-`$ poetry add pandas`
+
+**For packages your function needs to run** (like pandas, requests, etc.):
+```toml
+dependencies = [
+    "specklepy==3.0.0",
+    "pandas==2.1.0",  # Add production dependencies here
+]
+```
+
+**For development tools** (like testing or formatting tools):
+```toml
+[project.optional-dependencies]
+dev = [
+    "black==23.12.1",
+    "pytest-mock==3.11.1",  # Add development dependencies here
+    # ... other dev tools
+]
+```
+
+**How to decide which section?**
+- If your `main.py` (or other function logic) imports it → `dependencies`
+- If it's just a tool to help you code → `[project.optional-dependencies].dev`
+
+Example:
+```python
+# In your main.py
+import pandas as pd  # ← This goes in dependencies
+import specklepy     # ← This goes in dependencies
+
+# You won't import these in main.py:
+# pytest, black, mypy ← These go in [project.optional-dependencies].dev
+```
 
 ### Change launch variables
 
-describe how the launch.json should be edited
+Describe how the launch.json should be edited.
 
-### Github Codespaces
+### GitHub Codespaces
 
-create new repo from template, and use the create new code
+Create a new repo from this template, and use the create new code.
 
-
+### Using this Speckle Function
-### Local dev environment
-
-
-
-
-# Archive
-
-This is a simple example of how to use the Speckle Automate Python package to automate the creation of a Speckle stream.
-
-
-## Using this Speckle Function
 
 1. [Create](https://automate.speckle.dev/) a new Speckle Automation.
 1. Select your Speckle Project and Speckle Model.
-1. Select the existing Speckle Function named [`Random comment on IFC beam`](https://automate.speckle.dev/functions/e110be8fad).
+1. Select the deployed Speckle Function.
 1. Enter a phrase to use in the comment.
 1. Click `Create Automation`.
 
-## Getting Started with creating your own Speckle Function
+## Getting Started with Creating Your Own Speckle Function
 
-1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repository.
+1. [Register](https://automate.speckle.dev/) your Function with [Speckle Automate](https://automate.speckle.dev/) and select the Python template.
-1. [Clone](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository) your forked repository to your development environment, or use [GitHub CodeSpaces](https://github.com/features/codespaces).
+1. A new repository will be created in your GitHub account.
-1. [Register](https://automate.speckle.dev/) your Function with [Speckle Automate](https://automate.speckle.dev/).
+1. Make changes to your Function in `main.py`. See below for the Developer Requirements and instructions on how to test.
-1. After completing the registration of the Function you will be shown a Function Publish Token and a Function ID. You will need these later.
+1. To create a new version of your Function, create a new [GitHub release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) in your repository.
-1. Save your Function Publish Token as a [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) named `SPECKLE_AUTOMATE_FUNCTION_PUBLISH_TOKEN`.
-1. Save your Function ID as a [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) named `SPECKLE_AUTOMATE_FUNCTION_ID`.
-1. Make changes to your Function in `main.py`. See below for the Developer Requirements, and instructions on how to test.
-1. Every commit to `main` branch will create a new version of your Speckle Function.
 
 ## Developer Requirements
 
 1. Install the following:
-    - [Python 3](https://www.python.org/downloads/)
+    - [Python 3.11+](https://www.python.org/downloads/)
-    - [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)
+1. Run the following to set up your development environment:
-1. Run `poetry shell && poetry install` to install the required Python packages.
+    ```bash
+    python -m venv .venv
+    # On Windows
+    .venv\Scripts\activate
+    # On macOS/Linux
+    source .venv/bin/activate
+
+    pip install --upgrade pip
+    pip install .[dev]
+    ```
+
+**What this installs:**
+- All the packages your function needs to run (`dependencies`)
+- Plus development tools like testing and code formatting (`[project.optional-dependencies].dev`)
+
+**Why separate sections?**
+- `dependencies`: Only what gets deployed with your function (lightweight)
+- `dev` dependencies: Extra tools to help you write better code locally
 
 ## Building and Testing
 
-The code can be tested locally by running `poetry run pytest`.
+The code can be tested locally by running `pytest`.
-The code should also be packaged into the format required by Speckle Automate, a Docker Container Image, and that should also be tested.
+
+### Alternative dependency managers
+
+This template uses the modern **PEP 621** standard in `pyproject.toml`, which works with all modern Python dependency managers:
+
+#### Using Poetry
+```bash
+poetry install  # Automatically reads pyproject.toml
+```
+
+#### Using uv
+```bash
+uv sync  # Automatically reads pyproject.toml
+```
+
+#### Using pip-tools
+```bash
+pip-compile pyproject.toml  # Generate requirements.txt from pyproject.toml
+pip install -r requirements.txt
+```
+
+#### Using pdm
+```bash
+pdm install  # Automatically reads pyproject.toml
+```
+
+**Advantage**: All tools read the same `pyproject.toml` file, so there's no need to keep multiple files in sync!
+
+### Building and running the Docker Container Image
+
+Running and testing your code on your machine is a great way to develop your Function; the following instructions are a bit more in-depth and only required if you are having issues with your Function in GitHub Actions or on Speckle Automate.
+
+#### Building the Docker Container Image
+
+The GitHub Action packages your code into the format required by Speckle Automate. This is done by building a Docker Image, which Speckle Automate runs. You can attempt to build the Docker Image locally to test the building process.
+
+To build the Docker Container Image, you must have [Docker](https://docs.docker.com/get-docker/) installed.
+
+Once you have Docker running on your local machine:
+
+1. Open a terminal
+1. Navigate to the directory in which you cloned this repository
+1. Run the following command:
+
+    ```bash
+    docker build -f ./Dockerfile -t speckle_automate_python_example .
+    ```
+
+#### Running the Docker Container Image
+
+Once the GitHub Action has built the image, it is sent to Speckle Automate. When Speckle Automate runs your Function as part of an Automation, it will run the Docker Container Image. You can test that your Docker Container Image runs correctly locally.
+
+1. To then run the Docker Container Image, run the following command:
+
+    ```bash
+    docker run --rm speckle_automate_python_example \
+    python -u main.py run \
+    '{"projectId": "1234", "modelId": "1234", "branchName": "myBranch", "versionId": "1234", "speckleServerUrl": "https://speckle.xyz", "automationId": "1234", "automationRevisionId": "1234", "automationRunId": "1234", "functionId": "1234", "functionName": "my function", "functionLogo": "base64EncodedPng"}' \
+    '{}' \
+    yourSpeckleServerAuthenticationToken
+    ```
+
+Let's explain this in more detail:
+
+`docker run—-rm speckle_automate_python_example` tells Docker to run the Docker Container Image we built earlier. `speckle_automate_python_example` is the name of the Docker Container Image. The `--rm` flag tells Docker to remove the container after it has finished running, freeing up space on your machine.
+
+The line `python -u main.py run` is the command run inside the Docker Container Image. The rest of the command is the arguments passed to the command. The arguments are:
+
+- `'{"projectId": "1234", "modelId": "1234", "branchName": "myBranch", "versionId": "1234", "speckleServerUrl": "https://speckle.xyz", "automationId": "1234", "automationRevisionId": "1234", "automationRunId": "1234", "functionId": "1234", "functionName": "my function", "functionLogo": "base64EncodedPng"}'` - the metadata that describes the automation and the function.
+- `{}` - the input parameters for the function the Automation creator can set. Here, they are blank, but you can add your parameters to test your function.
+- `yourSpeckleServerAuthenticationToken`—the authentication token for the Speckle Server that the Automation can connect to. This is required to interact with the Speckle Server, for example, to get data from the Model.
 
 ## Resources
 
-- [Learn](https://speckle.guide/dev/python.html) more about SpecklePy, and interacting with Speckle from Python.
+- [Learn](https://speckle.guide/dev/python.html) more about SpecklePy and interacting with Speckle from Python.

example.function_inputs.json

@@ -0,0 +1,20 @@
+{
+  "speckleToken": "YOUR SPEKCLE TOKEN",
+  "functionInputs": {
+    "whisperMessage": "you are doing something weird",
+    "forbiddenSpeckleType": "wall"
+  },
+  "automationRunData": {
+    "project_id": "project id",
+    "speckle_server_url": "https://latest.speckle.systems",
+    "automation_id": "automation id",
+    "automation_run_id": "automation run id",
+    "function_run_id": "function run id",
+    "triggers": [
+      {
+        "payload": { "modelId": "model id", "versionId": "version id" },
+        "triggerType": "versionCreation"
+      }
+    ]
+  }
+}

flatten.py

@@ -6,8 +6,22 @@ from specklepy.objects import Base
 
 
 def flatten_base(base: Base) -> Iterable[Base]:
-    """Take a base and flatten it to an iterable of bases."""
+    """Flatten a base object into an iterable of bases.
-    if hasattr(base, "elements"):
+
-        for element in base["elements"]:
+    This function recursively traverses the `elements` or `@elements` attribute of the
+    base object, yielding each nested base object.
+
+    Args:
+        base (Base): The base object to flatten.
+
+    Yields:
+        Base: Each nested base object in the hierarchy.
+    """
+    # Attempt to get the elements attribute, fallback to @elements if necessary
+    elements = getattr(base, "elements", getattr(base, "@elements", None))
+
+    if elements is not None:
+        for element in elements:
             yield from flatten_base(element)
+
     yield base

main.py

@@ -1,9 +1,9 @@
-"""This module contains the business logic of the function.
+"""This module contains the function's business logic.
 
-use the automation_context module to wrap your function in an Autamate context helper
+Use the automation_context module to wrap your function in an Automate context helper.
 """
 
-from pydantic import Field
+from pydantic import Field, SecretStr
 from speckle_automate import (
     AutomateBase,
     AutomationContext,
@@ -14,13 +14,15 @@ from flatten import flatten_base
 
 
 class FunctionInputs(AutomateBase):
-    """These are function author defined values.
+    """These are function author-defined values.
 
     Automate will make sure to supply them matching the types specified here.
     Please use the pydantic model schema to define your inputs:
     https://docs.pydantic.dev/latest/usage/models/
     """
 
+    # An example of how to use secret values.
+    whisper_message: SecretStr = Field(title="This is a secret message")
     forbidden_speckle_type: str = Field(
         title="Forbidden speckle type",
         description=(
@@ -37,42 +39,46 @@ def automate_function(
     """This is an example Speckle Automate function.
 
     Args:
-        automate_context: A context helper object, that carries relevant information
+        automate_context: A context-helper object that carries relevant information
             about the runtime context of this function.
-            It gives access to the Speckle project data, that triggered this run.
+            It gives access to the Speckle project data that triggered this run.
-            It also has conveniece methods attach result data to the Speckle model.
+            It also has convenient methods for attaching results to the Speckle model.
         function_inputs: An instance object matching the defined schema.
     """
-    # the context provides a conveniet way, to receive the triggering version
+    # The context provides a convenient way to receive the triggering version.
     version_root_object = automate_context.receive_version()
 
-    count = 0
+    objects_with_forbidden_speckle_type = [
-    for b in flatten_base(version_root_object):
+        b
-        if b.speckle_type == function_inputs.forbidden_speckle_type:
+        for b in flatten_base(version_root_object)
-            if not b.id:
+        if b.speckle_type == function_inputs.forbidden_speckle_type
-                raise ValueError("Cannot operate on objects without their id's.")
+    ]
-
+    count = len(objects_with_forbidden_speckle_type)
-            automate_context.attach_error_to_objects(
-                category="Forbidden speckle_type",
-                object_ids=b.id,
-                message="This project should not contain the type: "
-                f"{b.speckle_type}",
-            )
-            count += 1
 
     if count > 0:
-        # this is how a run is marked with a failure cause
+        # This is how a run is marked with a failure cause.
+        automate_context.attach_error_to_objects(
+            category="Forbidden speckle_type"
+            f" ({function_inputs.forbidden_speckle_type})",
+            affected_objects=objects_with_forbidden_speckle_type,
+            message="This project should not contain the type: "
+            f"{function_inputs.forbidden_speckle_type}",
+        )
         automate_context.mark_run_failed(
             "Automation failed: "
             f"Found {count} object that have one of the forbidden speckle types: "
             f"{function_inputs.forbidden_speckle_type}"
         )
 
+        # Set the automation context view to the original model/version view
+        # to show the offending objects.
+        automate_context.set_context_view()
+
     else:
         automate_context.mark_run_success("No forbidden types found.")
 
-    # if the function generates file results, this is how it can be
+    # If the function generates file results, this is how it can be
-    # attached to the Speckle project / model
+    # attached to the Speckle project/model
     # automate_context.store_file_result("./report.pdf")
 
 
@@ -88,10 +94,10 @@ def automate_function_without_inputs(automate_context: AutomationContext) -> Non
 
 # make sure to call the function with the executor
 if __name__ == "__main__":
-    # NOTE: always pass in the automate function by its reference, do not invoke it!
+    # NOTE: always pass in the automate function by its reference; do not invoke it!
 
-    # pass in the function reference with the inputs schema to the executor
+    # Pass in the function reference with the inputs schema to the executor.
     execute_automate_function(automate_function, FunctionInputs)
 
-    # if the function has no arguments, the executor can handle it like so
+    # If the function has no arguments, the executor can handle it like so
     # execute_automate_function(automate_function_without_inputs)

mise.toml

@@ -0,0 +1,2 @@
+[tools]
+python = '3.13'

pyproject.toml

@@ -1,33 +1,37 @@
-[tool.poetry]
+[project]
-name = "speckle-automate-py"
+name = "speckle-automate-function"
 version = "0.1.0"
-description = "Example function for Speckle Automate using specklepy"
+requires-python = ">=3.13"
-authors = ["Gergő Jedlicska <gergo@jedlicska.com>"]
+authors = [{ name = "Speckle Systems", email = "hello@speckle.systems" }]
+maintainers = [{ name = "Speckle Systems", email = "hello@speckle.systems" }]
+description = "A Speckle Automate function template using specklepy"
 readme = "README.md"
-packages = [{include = "src/speckle_automate_py"}]
+license = "Apache-2.0"
+keywords = ["speckle", "automate", "bim", "aec"]
 
-[tool.poetry.dependencies]
+dependencies = ["specklepy==3.1.0"]
-python = "^3.11"
-specklepy = "^2.17.5"
 
-[tool.poetry.group.dev.dependencies]
+[project.optional-dependencies]
-black = "^23.3.0"
+dev = [
-mypy = "^1.3.0"
+    "mypy==1.13.0",
-ruff = "^0.0.271"
+    "pytest==7.4.4",
-pytest = "^7.4.2"
+    "ruff==0.11.12",
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.ruff]
-select = [
-  "E",   # pycodestyle
-  "F",   # pyflakes
-  "UP",  # pyupgrade
-  "D",   # pydocstyle
-  "I",   # isort
 ]
 
-[tool.ruff.pydocstyle]
+[tool.ruff]
+exclude = [".venv", "**/*.yml"]
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle
+    "F",  # pyflakes
+    "UP", # pyupgrade
+    "D",  # pydocstyle
+    "I",  # isort
+]
+
+[tool.ruff.lint.pydocstyle]
 convention = "google"
+
+[tool.setuptools]
+py-modules = []

tests/__init__.py

@@ -0,0 +1 @@
+"""Tests for the automate function."""

tests/test_function.py

@@ -1,158 +1,31 @@
 """Run integration tests with a speckle server."""
-import os
-import secrets
-import string
 
-import pytest
+from pydantic import SecretStr
-from gql import gql
 from speckle_automate import (
+    AutomationContext,
     AutomationRunData,
     AutomationStatus,
     run_function,
 )
-from specklepy.api import operations
+from speckle_automate.fixtures import *  # noqa: F403
-from specklepy.api.client import SpeckleClient
-from specklepy.objects.base import Base
-from specklepy.transports.server import ServerTransport
 
 from main import FunctionInputs, automate_function
 
 
-def crypto_random_string(length: int) -> str:
+def test_function_run(
-    """Generate a semi crypto random string of a given length."""
+    test_automation_run_data: AutomationRunData, test_automation_token: str
-    alphabet = string.ascii_letters + string.digits
-    return "".join(secrets.choice(alphabet) for _ in range(length))
-
-
-def register_new_automation(
-    project_id: str,
-    model_id: str,
-    speckle_client: SpeckleClient,
-    automation_id: str,
-    automation_name: str,
-    automation_revision_id: str,
 ):
-    """Register a new automation in the speckle server."""
-    query = gql(
-        """
-        mutation CreateAutomation(
-            $projectId: String! 
-            $modelId: String! 
-            $automationName: String!
-            $automationId: String! 
-            $automationRevisionId: String!
-        ) {
-                automationMutations {
-                    create(
-                        input: {
-                            projectId: $projectId
-                            modelId: $modelId
-                            automationName: $automationName 
-                            automationId: $automationId
-                            automationRevisionId: $automationRevisionId
-                        }
-                    )
-                }
-            }
-        """
-    )
-    params = {
-        "projectId": project_id,
-        "modelId": model_id,
-        "automationName": automation_name,
-        "automationId": automation_id,
-        "automationRevisionId": automation_revision_id,
-    }
-    speckle_client.httpclient.execute(query, params)
-
-
-@pytest.fixture()
-def speckle_token() -> str:
-    """Provide a speckle token for the test suite."""
-    env_var = "SPECKLE_TOKEN"
-    token = os.getenv(env_var)
-    if not token:
-        raise ValueError(f"Cannot run tests without a {env_var} environment variable")
-    return token
-
-
-@pytest.fixture()
-def speckle_server_url() -> str:
-    """Provide a speckle server url for the test suite, default to localhost."""
-    return os.getenv("SPECKLE_SERVER_URL", "http://127.0.0.1:3000")
-
-
-@pytest.fixture()
-def test_client(speckle_server_url: str, speckle_token: str) -> SpeckleClient:
-    """Initialize a SpeckleClient for testing."""
-    test_client = SpeckleClient(
-        speckle_server_url, speckle_server_url.startswith("https")
-    )
-    test_client.authenticate_with_token(speckle_token)
-    return test_client
-
-
-@pytest.fixture()
-def test_object() -> Base:
-    """Create a Base model for testing."""
-    root_object = Base()
-    root_object.foo = "bar"
-    return root_object
-
-
-@pytest.fixture()
-def automation_run_data(
-    test_object: Base, test_client: SpeckleClient, speckle_server_url: str
-) -> AutomationRunData:
-    """Set up an automation context for testing."""
-    project_id = test_client.stream.create("Automate function e2e test")
-    branch_name = "main"
-
-    model = test_client.branch.get(project_id, branch_name, commits_limit=1)
-    model_id: str = model.id
-
-    root_obj_id = operations.send(
-        test_object, [ServerTransport(project_id, test_client)]
-    )
-    version_id = test_client.commit.create(project_id, root_obj_id)
-
-    automation_name = crypto_random_string(10)
-    automation_id = crypto_random_string(10)
-    automation_revision_id = crypto_random_string(10)
-
-    register_new_automation(
-        project_id,
-        model_id,
-        test_client,
-        automation_id,
-        automation_name,
-        automation_revision_id,
-    )
-
-    automation_run_id = crypto_random_string(10)
-    function_id = crypto_random_string(10)
-    function_revision = crypto_random_string(10)
-    return AutomationRunData(
-        project_id=project_id,
-        model_id=model_id,
-        branch_name=branch_name,
-        version_id=version_id,
-        speckle_server_url=speckle_server_url,
-        automation_id=automation_id,
-        automation_revision_id=automation_revision_id,
-        automation_run_id=automation_run_id,
-        function_id=function_id,
-        function_revision=function_revision,
-    )
-
-
-def test_function_run(automation_run_data: AutomationRunData, speckle_token: str):
     """Run an integration test for the automate function."""
+    automation_context = AutomationContext.initialize(
+        test_automation_run_data, test_automation_token
+    )
     automate_sdk = run_function(
+        automation_context,
         automate_function,
-        automation_run_data,
+        FunctionInputs(
-        speckle_token,
+            forbidden_speckle_type="None",
-        FunctionInputs(forbidden_speckle_type="Base"),
+            whisper_message=SecretStr("testing automatically"),
+        ),
     )
 
-    assert automate_sdk.run_status == AutomationStatus.FAILED
+    assert automate_sdk.run_status == AutomationStatus.SUCCEEDED