fix(dockerfile): improve documentation and change working directory (#4)

- Installs code at /home/speckle to prevent collisions with files & directories in the root (/) directory
- Updates the README and provides instructions for building and testing the docker image locally
- Updated inline documentation in Dockerfile

Author: iainsproat

Dockerfile

@@ -1,6 +1,16 @@
+# 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.11-slim
 
+# We install poetry to generate a list of dependencies which will be required by our application
 RUN pip install poetry
 
-COPY . .
-RUN poetry export -f requirements.txt --output requirements.txt && pip install -r requirements.txt
+# We set the working directory to be the /home/speckle directory; all of our files will be copied here.
+WORKDIR /home/speckle
+
+# 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
+
+# Using poetry, we generate a list of requirements, save them to requirements.txt, and then use pip to install them
+RUN poetry export --format requirements.txt --output /home/speckle/requirements.txt && pip install --requirement /home/speckle/requirements.txt

README.md

@@ -1,6 +1,5 @@
 # Speckle Automate function template - 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.
 
@@ -24,20 +23,9 @@ describe how the launch.json should be edited
 
 ### Github Codespaces
 
-create new repo from template, and use the create new code
-
-
-### Local dev environment
-
-
-
-
-# Archive
+Create a new repo from this template, and use the create new code.
 
-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
+### Using this Speckle Function
 
 1. [Create](https://automate.speckle.dev/) a new Speckle Automation.
 1. Select your Speckle Project and Speckle Model.
@@ -47,14 +35,10 @@ This is a simple example of how to use the Speckle Automate Python package to au
 
 ## Getting Started with creating your own Speckle Function
 
-1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repository.
-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. [Register](https://automate.speckle.dev/) your Function with [Speckle Automate](https://automate.speckle.dev/).
-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. 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. [Register](https://automate.speckle.dev/) your Function with [Speckle Automate](https://automate.speckle.dev/) and select the Python template.
+1. A new repository will be created in your GitHub account.
 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.
+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.
 
 ## Developer Requirements
 
@@ -66,7 +50,50 @@ This is a simple example of how to use the Speckle Automate Python package to au
 ## 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.
+
+### Building and running the Docker Container Image
+
+Running and testing your code on your own 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
+
+Your code is packaged by the GitHub Action into the format required by Speckle Automate. This is done by building a Docker Image, which is then run by Speckle Automate. You can attempt to build the Docker Image yourself to test the building process locally.
+
+To build the Docker Container Image, you will need to 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 image has been built by the GitHub Action, 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 by running it 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 that we built earlier. `speckle_automate_python_example` is the name of the Docker Container Image that we built earlier. The `--rm` flag tells docker to remove the container after it has finished running, this frees up space on your machine.
+
+The line `python -u main.py run` is the command that is run inside the Docker Container Image. The rest of the command is the arguments that are 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 that the Automation creator is able to set. Here they are blank, but you can add your own parameters to test your function.
+- `yourSpeckleServerAuthenticationToken` - the authentication token for the Speckle Server that the Automation can connect to. This is required to be able to interact with the Speckle Server, for example to get data from the Model.
 
 ## Resources