Overhaul repo to support plugins #3

collindutter · 2024-11-18T17:28:03Z

Overhauls the repo to support more than just Tools. Would like feedback on:

Does the term "plugin" make sense? "Extension"?
Do the README instructions make sense? Would you know how to create a Prompt Driver?

collindutter · 2024-11-18T17:33:06Z

3.12 failing is expected, it's already fixed on griptape@dev

dylanholmes

I'm fine with "plugin".

I think it's pretty straight forward on how you'd add a prompt driver, but you could provide links to griptape maintained plugin repos for more in depth examples (once we have them).

dylanholmes · 2024-11-18T18:17:33Z

.github/actions/init-environment/action.yml

-          source .venv/bin/activate
+          source $VENV


dylanholmes · 2024-11-18T18:19:11Z

.github/workflows/unit-tests.yml

-  test:
+  test-ubuntu:


Windows too?

SavagePencil

We've said what but not why. Small inserts can fix that.

SavagePencil · 2024-11-18T21:13:28Z

README.md


-A Github template repository for creating Griptape tools.
+A Github template repository for creating Griptape plugins.


Suggest "extensions" as it implies extending functionality and capabilities. Opinion, tho.

I don't have a strong opinion either way.. plugins or extensions both work for me.

I think I like extension more. Plugin, to me, suggests some sort of modification of core behavior. This template is for providing new, extended functionality.

SavagePencil · 2024-11-18T21:14:41Z

README.md

+Via github web page:
+
+Click on `Use this template`
+
+![](https://docs.github.com/assets/cb-36544/images/help/repository/use-this-template-button.png)


Make this one first. Everyone here will know that one, not everyone will be as familiar with the CLI

SavagePencil · 2024-11-18T21:17:29Z

README.md

+
+## What is a Griptape Plugin?
+
+A Griptape Plugin is nothing more than a python class that implements one of Griptape's interfaces.


Start with what it affords, e.g., "A Griptape [extension/plugin] allows you to make your own functionality for your Griptape agents..." Since you are already using the 2nd person elsewhere in this document, the second sentence can be "You create one as a Python class that implements a Griptape interface."

You've told me what one is but now why I would want to use one. Give some concrete examples.

I understand the reason behind saying "nothing more than" because it makes it sound simple and easy.. but it ends up sounding not very impressive. Maybe just simplify?

also, not sure what "implements one of Griptape's interfaces" means. When I hear "interfaces" I think "UI".

SavagePencil · 2024-11-18T21:19:27Z

README.md

+### Installing Dependencies
+
+```bash
+make install
+```
+
+### Running Tests
+
+```bash
+make test
+```
+
+### Running Checks
+
+```bash
+make check
+```
+
+### Running Formatter
+
+```bash
+make format
+```
+


Should these be at #### (four indents) as they appear to be subsets of make setup

SavagePencil · 2024-11-18T21:20:16Z

README.md

+```bash
+make setup
+```
+


Summarize what that results in (e.g., "This will install all dependencies, run tests to validate no regressions, run checks (what is that?), and run the formatter (why isn't it formatted already?).

SavagePencil · 2024-11-18T21:22:22Z

README.md

+
+### Running Example
+
+1. Set appropriate environment variables. The example requires an `OPENAI_API_KEY` environment variable to be set.


can you do a 1a. that says "each example will require its own environment variables. See the XXX in each example to understand which environment variables are required to run them."

SavagePencil · 2024-11-18T21:22:46Z

README.md

+```
+
+### Installing In Other Projects
+


Talk about why and when you would want to do this, possibly with an example.

shhlife · 2024-11-18T21:43:59Z

README.md

+2. Run the example:
+
+```bash
+poetry run python examples/example.py


This assumes the user is using poetry - should we make that assumption? do we want to include pip instructions as well?

This repo is heavily dependent on poetry. I think it's fine as long we provide some justification for it. I'll include some more context about what poetry is and why we're using it.

shhlife · 2024-11-18T21:44:45Z

README.md

+
+The template repository is structured as follows:
+
+├── griptape


This wasn't showing as a clean hierarchy in the preview for me - do you want to wrap it in ```?

shhlife

made a couple of notes

SavagePencil · 2024-11-18T22:46:57Z

README.md

+```
+
+#### Running Example
+


We gave you an example you can run

Here's what it does in plain English

Here's what role the plugin/extension plays in that experience

Here's where to look for when you want to learn how the plugin/extension was built and hooked up

SavagePencil

get ahead...ahead of that dread!

SavagePencil · 2024-11-18T22:49:59Z

README.md

+
+## What is a Griptape Extension?
+
+Griptape Extensions can add new functionality to the [griptape framework](https://github.com/griptape-ai/griptape), such as new Tools, Drivers, Tasks, or Structures.


Be clear what that affords. "With Griptape Extensions, your Agents can now do X, Y, Z."

Also capitalize Griptape framework

What do you have in mind for X, Y, Z? Extensions don't do anything concrete on their own, they simply enable the user to develop functionality like new Tools, Drivers, Tasks, or Structures.

right, but that may not be obvious what that affords. "With extensions, your Griptape Agents can leverage your team's APIs, perform custom business logic, and access proprietary data sources, all as part of their reasoning."

Added a sentence.

SavagePencil · 2024-11-18T22:53:49Z

README.md

+
+### Installing in Other Projects
+
+Extensions are designed to be shared and installed in projects that can benefit from them.


How about Extensions are designed to be shared. Extensions are made to easily install (include? import?) into existing Python projects.

SavagePencil · 2024-11-18T22:56:44Z

README.md

+
+Extensions are designed to be shared and installed in projects that can benefit from them.
+
+Although publishing to [PyPI](https://pypi.org/) is an option, it is beyond the scope of this template. Instead, extensions can be installed directly from the repository.


I'd remove the PyPi comment, because it gives the reader a sense of dread (n.b.: I am always sensing dread). Be optimistic: The easiest way to include your extension into an existing project is to install directly from the repository, like so:

...

later:
Advanced customers may seek to publish their extensions to PyPi. Those instructions are beyond the scope of this README.

collindutter requested review from vasinov, dylanholmes, shhlife and SavagePencil November 18, 2024 17:28

collindutter force-pushed the refactor/plugin-overhaul branch 2 times, most recently from 195e966 to 4a09284 Compare November 18, 2024 17:32

collindutter force-pushed the refactor/plugin-overhaul branch from 4a09284 to 6377f28 Compare November 18, 2024 17:34

dylanholmes reviewed Nov 18, 2024

View reviewed changes

collindutter force-pushed the refactor/plugin-overhaul branch 3 times, most recently from 07f44dc to 0c72d3a Compare November 18, 2024 18:57

SavagePencil requested changes Nov 18, 2024

View reviewed changes

shhlife reviewed Nov 18, 2024

View reviewed changes

shhlife requested changes Nov 18, 2024

View reviewed changes

collindutter force-pushed the refactor/plugin-overhaul branch from 0c72d3a to a5f3a21 Compare November 18, 2024 22:44

collindutter requested review from SavagePencil and shhlife November 18, 2024 22:44

SavagePencil reviewed Nov 18, 2024

View reviewed changes

SavagePencil requested changes Nov 18, 2024

View reviewed changes

collindutter force-pushed the refactor/plugin-overhaul branch from a5f3a21 to 8728935 Compare November 18, 2024 23:03

collindutter requested a review from SavagePencil November 18, 2024 23:03

collindutter mentioned this pull request Nov 19, 2024

Feature/Luma Ai Video Generation Driver griptape-ai/griptape#1199

Closed

1 task

Overhaul repo to support plugins

32428ca

collindutter force-pushed the refactor/plugin-overhaul branch from 8728935 to 32428ca Compare November 19, 2024 16:55

collindutter merged commit 02138f1 into main Nov 19, 2024
8 of 9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Overhaul repo to support plugins #3

Overhaul repo to support plugins #3

collindutter commented Nov 18, 2024

collindutter commented Nov 18, 2024

dylanholmes left a comment •

edited

Loading

dylanholmes Nov 18, 2024

dylanholmes Nov 18, 2024

SavagePencil left a comment

SavagePencil Nov 18, 2024

shhlife Nov 18, 2024

collindutter Nov 18, 2024

SavagePencil Nov 18, 2024

shhlife Nov 18, 2024

SavagePencil Nov 18, 2024

shhlife Nov 18, 2024

SavagePencil Nov 18, 2024

SavagePencil Nov 18, 2024

SavagePencil Nov 18, 2024

SavagePencil Nov 18, 2024

shhlife Nov 18, 2024

collindutter Nov 18, 2024

shhlife Nov 18, 2024

shhlife left a comment

SavagePencil Nov 18, 2024

SavagePencil left a comment

SavagePencil Nov 18, 2024

collindutter Nov 18, 2024

SavagePencil Nov 19, 2024

collindutter Nov 19, 2024

SavagePencil Nov 18, 2024

SavagePencil Nov 18, 2024


		A Github template repository for creating Griptape tools.
		A Github template repository for creating Griptape plugins.


		## What is a Griptape Plugin?

		A Griptape Plugin is nothing more than a python class that implements one of Griptape's interfaces.


		### Running Example

		1. Set appropriate environment variables. The example requires an `OPENAI_API_KEY` environment variable to be set.


		The template repository is structured as follows:

		├── griptape


		## What is a Griptape Extension?

		Griptape Extensions can add new functionality to the [griptape framework](https://github.com/griptape-ai/griptape), such as new Tools, Drivers, Tasks, or Structures.


		### Installing in Other Projects

		Extensions are designed to be shared and installed in projects that can benefit from them.


		Extensions are designed to be shared and installed in projects that can benefit from them.

		Although publishing to [PyPI](https://pypi.org/) is an option, it is beyond the scope of this template. Instead, extensions can be installed directly from the repository.

		```

		#### Running Example

Overhaul repo to support plugins #3

Overhaul repo to support plugins #3

Conversation

collindutter commented Nov 18, 2024

collindutter commented Nov 18, 2024

dylanholmes left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SavagePencil left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shhlife left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SavagePencil left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dylanholmes left a comment •

edited

Loading