griptape-nodes 0.34.2__tar.gz → 0.35.0__tar.gz

{griptape_nodes-0.34.2 → griptape_nodes-0.35.0}/.github/workflows/latest-release.yml

@@ -1,15 +1,11 @@
 name: Create Latest Release
-
 on:
   schedule:
     - cron: 20 17 * * *  # 10:20 AM PT
     - cron: 20 22 * * *  # 3:20 PM PT
   workflow_dispatch:      # allows manual triggering too
-
-
 permissions:
   contents: write
-
 jobs:
   release:
     name: Create release
@@ -19,6 +15,13 @@ jobs:
         uses: actions/checkout@v4
       - name: Init environment
         uses: ./.github/actions/init-environment
+      - name: Delete existing release
+        env:
+          GITHUB_TOKEN: ${{ secrets.RELEASE_PAT }}
+        run: |
+          # Delete the release if it exists (ignore errors if it doesn't exist)
+          gh release delete latest --yes || true
+        continue-on-error: true
       - name: Create latest tag
         env:
           GITHUB_TOKEN: ${{ secrets.RELEASE_PAT }}

griptape_nodes-0.35.0/.github/workflows/publish.yml

@@ -0,0 +1,74 @@
+# Adapted from https://docs.github.com/en/actions/use-cases-and-examples/publishing-packages/publishing-docker-images#publishing-images-to-docker-hub-and-github-packages
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish-pypi:
+    runs-on: ubuntu-latest
+    if: github.event.release.prerelease == false
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9"]
+    steps:
+      - name: Checkout actions
+        uses: actions/checkout@v4
+      - name: Init environment
+        uses: ./.github/actions/init-environment
+      - name: uv Build
+        run: uv build
+      - name: uv Publish
+        run: uv publish --token ${{ secrets.PYPI_TOKEN }} 
+
+
+  push_to_registries:
+    name: Push Docker image to multiple registries
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+      attestations: write
+      id-token: write
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v4
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            griptape/griptape-nodes
+            ghcr.io/${{ github.repository }}
+
+      - name: Build and push Docker images
+        id: push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      - name: Generate artifact attestation
+        uses: actions/attest-build-provenance@v2
+        with:
+          subject-name: ghcr.io/${{ github.repository }}
+          subject-digest: ${{ steps.push.outputs.digest }}
+          push-to-registry: true

{griptape_nodes-0.34.2 → griptape_nodes-0.35.0}/CONTRIBUTING.md

@@ -174,17 +174,29 @@ Griptape Nodes uses a variety of environment variables for influencing its low-l
 
 The documentation website ([docs.griptapenodes.com](https://docs.griptapenodes.com)) is built using MkDocs with the Material theme.
 
-1. **Setup:** Ensure you've installed dependencies using `uv sync -p --all-extras` (this includes the `docs` group).
+1. **Setup:** Ensure you've installed dependencies using `make install`.
 
 1. **Source Files:** Documentation source files are located in the `/docs` directory in Markdown format. The site structure is defined in `mkdocs.yml` in the project root.
 
-1. **Serving Locally:** To preview your changes live, run the MkDocs development server:
+1. **Serving Locally:** To preview your changes live, first ensure that you have run:
+
+    ```shell
+    make install
+    ```
+
+    Then run the MkDocs development server:
 
     ```shell
     uv run mkdocs serve
     ```
 
-    This will start a local webserver (usually at `http://127.0.0.1:8000/`). The site will automatically reload when you save changes to the documentation files or `mkdocs.yml`.
+    Or use the Makefile shortcut:
+
+    ```shell
+    make docs/serve
+    ```
+
+This will start a local webserver (usually at `http://127.0.0.1:8000/`). The site will automatically reload when you save changes to the documentation files or `mkdocs.yml`.
 
 1. **Making Changes:** Edit the Markdown files in the `/docs` directory. Add new pages by creating new `.md` files and updating the `nav` section in `mkdocs.yml`.
 

griptape_nodes-0.35.0/Dockerfile

@@ -0,0 +1,37 @@
+FROM python:3.12-slim AS builder
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+WORKDIR /griptape-nodes
+
+# Install dependencies
+RUN --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --locked --no-install-project --no-editable
+
+COPY pyproject.toml pyproject.toml
+COPY uv.lock uv.lock
+COPY README.md README.md
+COPY src src
+COPY libraries libraries
+
+# Sync the project
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --locked --no-editable
+
+FROM python:3.12-slim
+
+# Copy the environment, but not the source code
+COPY --from=builder --chown=griptape-nodes:griptape-nodes /griptape-nodes/.venv /griptape-nodes/.venv
+
+LABEL org.opencontainers.image.source="https://github.com/griptape-ai/griptape-nodes"
+LABEL org.opencontainers.image.description="Griptape Nodes."
+LABEL org.opencontainers.image.licenses="Apache-2.0"
+
+COPY entrypoint.sh /entrypoint.sh
+RUN chmod +x /entrypoint.sh
+
+EXPOSE 8124
+
+ENTRYPOINT ["/entrypoint.sh"]
+CMD ["/griptape-nodes/.venv/bin/griptape-nodes", "--no-update"]

{griptape_nodes-0.34.2 → griptape_nodes-0.35.0}/Makefile

@@ -34,7 +34,8 @@ version/publish: ## Create and push git tags.
 	@git tag v$$(make version/get)
 	@git tag stable -f
 	@git push -f --tags
-	@git push
+	# Push to a release branch (e.g. release/v0.34).
+	@git push -u origin release/v$$(make version/get | awk -F. '{print $$1 "." $$2}')
 	
 .PHONY: run
 run: ## Run the project.

{griptape_nodes-0.34.2 → griptape_nodes-0.35.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: griptape-nodes
-Version: 0.34.2
+Version: 0.35.0
 Summary: Add your description here
 License-File: LICENSE
 Requires-Python: ~=3.12

{griptape_nodes-0.34.2 → griptape_nodes-0.35.0}/docs/installation.md

@@ -1,15 +1,19 @@
 # Installing Griptape Nodes
 
-An important bit of overview before we begin: Griptape Nodes is actually two things that work together - an Engine and an Editor. The Engine will install and run on your computer, while the Editor is served from the web, and you'll interact with your Engine through a web browser.
+Griptape Nodes is comprised of two components - an Editor and an Engine. The Editor is served from the web, so there is no need to install that, and you'll interact with your Engine through the Editor in your web browser.
 
-> - If you'd rather not install the Engine locally, it is also easy to run it in a hosted environment. The instructions that follow will work the same for either approach.
+The Engine can be installed on your local machine, whether that runs MacOS, Windows or Linux.
 
-> - There is no locally-hosted Editor option
+If you'd rather not install the Engine locally, perhaps because you want it to be able to access more resources than you have available on your laptop, it is easy to run it in on a separate machine. The instructions that follow will work the same for either approach.
 
-There are just 4 easy steps:
+The Editor and the Engine are decoupled and communicate with each other through an event service. There is no locally-hosted Editor option
+
+#### Summary
+
+There are just 4 steps required to install Griptape Nodes:
 
 1. Sign up or Log in
-1. Install Your Engine
+1. Install the Griptape Nodes Engine
 1. Configuration
 1. Start Your Engine
 
@@ -27,21 +31,27 @@ You'll be presented with a Griptape account authorization form.
 
 Once you've logged in, you'll be presented with a setup screen which walks you through installing the Engine.
 
-## 2. Install Your Engine
+## 2. Install the Griptape Nodes Engine
+
+!!! info
 
-1. On the **New Installation** tab, copy the installation command from the first step: **Iinstall Griptape nodes Engine** (it's the bit that starts with `curl`).
+    You can install the Griptape Nodes Engine on your local machine *or* on a separate machine. That could be a cloud based machine equipped with a powerful GPU, or a similar high performance machine on the network in your studio.
 
-1. Open a Terminal on your machine
+1. If it's not already the active tab, select the **New Installation** tab.
 
-1. Paste and run the command.
+1. On the **New Installation** tab, copy the installation command from the first step: **Install Griptape nodes Engine**.
 
-    !!! info
+1. Open a Terminal on the machine where you wish to install the engine
 
-        You can install this on your local machine *or* a cloud-based workstation.
+1. Paste and run the appropriate installation command for your operating system
 
 ![Installation Page](assets/img/getting_started/getting_started-installation_page.webp)
 
-You'll see this message when installation has completed:
+!!! info
+
+    In most cases, the browser will automatically detect the platform that you are using and show the correct installation command for your system. If this is not the case - for example if you want to install the engine on a system using a different operating system from your local machine - select the target operating system from the dropdown on the right. The available operations are macOS, Windows & Linux.
+
+Once installation is complete, you'll see this message appear in the terminal where you entered the installation command:
 
 ```
 **************************************
@@ -55,7 +65,7 @@ You'll see this message when installation has completed:
 
     You'll notice this message gives you two options for commands to run. As previously mentioned, there is no difference between running `griptape-nodes` or `gtn`. They both do the exact same thing.
 
-*After* typing and running `griptape-nodes` or `gtn` in the terminal *for the first time*, you will be asked a series of configuration questions.
+After typing and running `griptape-nodes` or `gtn` in the terminal *for the first time*, you will be asked a series of configuration questions.
 
 ## 3. Configuration
 
@@ -85,9 +95,9 @@ Pressing Enter will use the default: `<current_working_directory>/GriptapeNodes`
 
 1. Click the *Generate API Key* button.
 
-1. Copy that key and enter it in the next step.
+1. Copy the key that is generated and enter it in the next step. Note that the API key will not be saved.
 
-![Installation Page wKey hint](assets/img/getting_started/getting_started-installation_page_key_hint.webp)
+![Installation Page Key hint](assets/img/getting_started/getting_started-installation_page_key_hint.webp)
 
 ```
 Workspace directory set to: /Users/user/Documents/local-dev/nodes-test-eng/GriptapeNodes
@@ -108,7 +118,7 @@ Griptape API Key (YOUR-KEY-HERE):
 
 ## 4. Start Your Engine
 
-You're ready to proceed. Run `griptape-nodes` or `gtn` and return to your browser. Your browser tab at https://nodes.griptape.ai will be updated to an untitled workflow in Griptape Nodes!
+Your installation is now complete and you're ready to proceed to creating your first Workflow or trying out one of the sample workflows. To get started, return to your terminal and run `griptape-nodes` or `gtn`, then return to your browser. Your browser tab at [https://nodes.griptape.ai](https://nodes.griptape.ai) will update to show *Create from scratch*, allowing you to start from a blank canvas, together with several sample Griptape Nodes workflows that you can experiment with!
 
 ![A Blank Griptape_nodes_ editor](assets/img/getting_started/getting_started-blank_editor.png)
 

griptape_nodes-0.35.0/docs/nodes/audio/load_audio.md

@@ -0,0 +1,42 @@
+# LoadAudio
+
+## What is it?
+
+The LoadAudio node is a simple building block that lets you bring an audio file into your workflow. Think of it as picking up an audio recording so you can use it in your project.
+
+## When would I use it?
+
+Use this node when you want to:
+
+- Use an audio file that was created by another node
+- Pass an audio file to other nodes in your workflow
+- Process an audio file as part of your project
+
+## How to use it
+
+### Basic Setup
+
+1. Add the LoadAudio node to your workflow
+1. Connect it to a source of audio (like the Transcribe Audio node)
+
+### Parameters
+
+- **audio**: The audio to load (this can be connected to an output from another node)
+
+### Outputs
+
+- **audio**: The loaded audio that can be used by other nodes in your flow
+
+## Example
+
+Imagine you've recorded some audio and have it saved on your computer, and you'd like to use it elsewhere:
+
+1. Create a LoadAudio node
+1. Click on the load audio button, and choose your audio file from disk
+1. The LoadAudio will make the audio available to use in the rest of your workflow
+
+## Important Notes
+
+- The LoadAudio simply passes the audio through - it doesn't change the audio itself
+- You can click the file browser icon to select an audio file from your computer
+- The audio can be played by clicking the play button

griptape_nodes-0.35.0/docs/nodes/audio/microphone.md

@@ -0,0 +1,53 @@
+# Microphone
+
+## What is it?
+
+The Microphone node allows you to capture audio directly from your computer's microphone. It's a simple way to record audio input that can be used in your workflow.
+
+## When would I use it?
+
+Use this node when you want to:
+
+- Record audio directly from your microphone
+- Capture voice input for transcription
+- Create audio recordings as part of your workflow
+- Provide real-time audio input to other nodes
+
+## How to use it
+
+### Basic Setup
+
+1. Add the Microphone node to your workflow
+1. Click the microphone icon to start recording
+1. Speak or provide audio input
+1. Stop recording when finished
+
+### Parameters
+
+- **audio**: The captured audio output (AudioArtifact)
+
+### Outputs
+
+- **audio**: The recorded audio that can be used by other nodes in your flow
+
+## Example
+
+A simple workflow to record and transcribe audio:
+
+1. Add a Microphone node to your workflow
+1. Record your audio input
+1. Connect the "audio" output to a TranscribeAudio node
+1. The transcription will be available in the TranscribeAudio node's output
+
+## Important Notes
+
+- The node requires microphone permissions in your browser
+- Audio is captured in real-time
+- The quality of the recording depends on your microphone and system settings
+- The node supports various audio formats through the AudioArtifact interface
+
+## Common Issues
+
+- **No Microphone Access**: Ensure your browser has permission to access your microphone
+- **Poor Audio Quality**: Check your microphone settings and system audio configuration
+- **Recording Not Starting**: Make sure no other application is using the microphone

griptape_nodes-0.35.0/docs/nodes/audio/transcribe_audio.md

@@ -0,0 +1,63 @@
+# TranscribeAudio
+
+## What is it?
+
+The TranscribeAudio node uses OpenAI's models to convert audio into text. It supports multiple transcription models and can work with both direct model configuration and agent-based transcription.
+
+## When would I use it?
+
+Use this node when you want to:
+
+- Convert speech to text
+- Transcribe audio recordings
+- Extract text from audio files
+- Process voice input into written form
+- Create transcripts of audio content
+
+## How to use it
+
+### Basic Setup
+
+1. Add the TranscribeAudio node to your workflow
+1. Connect an audio source to the "audio" input
+1. Choose a transcription model or connect an agent
+1. Run the node to generate the transcription
+
+### Parameters
+
+- **agent**: An optional existing agent configuration to use for transcription
+- **model**: The transcription model to use (defaults to "gpt-4o-mini-transcribe")
+- **audio**: The audio file to transcribe (required)
+- **output**: The transcribed text output
+
+### Outputs
+
+- **output**: The transcribed text from the audio
+- **agent**: The agent object used for transcription, which can be connected to other nodes
+
+## Example
+
+A complete workflow for recording and transcribing audio:
+
+1. Add a Microphone node to capture audio
+1. Connect the Microphone's "audio" output to the TranscribeAudio node's "audio" input
+1. Select your preferred transcription model
+1. Run the workflow
+1. The transcribed text will be available in the "output" parameter
+
+## Important Notes
+
+- The node requires a valid OpenAI API key set up in your environment as `OPENAI_API_KEY`
+- Available models include:
+    - gpt-4o-mini-transcribe
+    - gpt-4o-transcribe
+    - whisper-1
+- You can provide your own agent configuration for more customized behavior
+- The quality of transcription depends on the audio quality and the selected model
+
+## Common Issues
+
+- **Missing API Key**: Ensure your OpenAI API key is properly set up as the environment variable
+- **No Audio Provided**: Make sure you've connected a valid audio source to the "audio" input
+- **Poor Transcription Quality**: Try using a different model or improving the audio quality
+- **Processing Errors**: Very long audio files or poor audio quality might result in less accurate transcriptions

griptape_nodes-0.35.0/docs/nodes/text/random_text.md

@@ -0,0 +1,77 @@
+# Random Text
+
+The Random Text node allows you to select random content from input text or generate random content when no input is provided. It supports selecting random characters, words, sentences, or paragraphs.
+
+## Parameters
+
+### Input Text
+
+- **Type**: String
+- **Mode**: Input/Property
+- **Description**: The text to select random content from. If empty, the node will generate random content based on the selection type.
+- **UI Options**: Multiline enabled
+
+### Seed
+
+- **Type**: Integer
+- **Mode**: Property
+- **Description**: A seed value (0-10,000) for reproducible random selection. Using the same seed will produce the same random selection.
+- **UI Options**: Slider with range 0-10,000
+
+### Selection Type
+
+- **Type**: String
+
+- **Mode**: Property
+
+- **Description**: The type of content to select or generate:
+
+    - `character`: Selects a random character
+    - `word`: Selects a random word
+    - `sentence`: Selects a random sentence or generates a new one
+    - `paragraph`: Selects a random paragraph or generates a new one
+
+### Output
+
+- **Type**: String
+- **Mode**: Output
+- **Description**: The randomly selected or generated content
+- **UI Options**: Multiline enabled
+
+## Behavior
+
+- When input text is provided:
+
+    - The node selects random content from the input based on the selection type
+    - For sentences and paragraphs, it splits the input on appropriate delimiters
+    - If no matching content is found, it falls back to generating new content
+
+- When no input text is provided:
+
+    - For characters: Generates a random character from letters, digits, and punctuation
+    - For words: Generates a random English word
+    - For sentences: Uses an AI agent to generate a natural-sounding sentence
+    - For paragraphs: Uses an AI agent to generate a coherent paragraph
+
+## Examples
+
+### Selecting Random Content
+
+```python
+# Input text: "Hello world! This is a test. How are you today?"
+# Selection type: word
+# Output: "world" (randomly selected word)
+```
+
+### Generating Random Content
+
+```python
+# Input text: "" (empty)
+# Selection type: sentence
+# Output: "The quick brown fox jumps over the lazy dog." (AI-generated sentence)
+```
+
+## Notes
+
+- The seed parameter ensures reproducible results when using the same value
+- The node will show a loading message while generating content with the AI agent