Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 3.16 KB

README.md

File metadata and controls

81 lines (55 loc) · 3.16 KB
Raw

Cassandra Todolist ChatGPT plugin Quickstart

Get a todo list ChatGPT plugin up and running in under 5 minutes using Python. This plugin is designed to work in conjunction with the ChatGPT Plugins Documentation. If you do not already have plugin developer access, please join the waitlist.

Quickstart in Gitpod

You can either follow the directions below or open this in gitpod.

Open in Gitpod

Setup

Clone the Repo

Before you can run the plugin, you need to get the code onto your computer. This is done by cloning the GitHub repository. If you have git installed, you can do this by running the following command in your terminal:

git clone https://github.com/CassioML/cassandra-todolist-chatgpt-plugin

This will create a copy of the repository on your local machine. Once you have cloned the repository, navigate into the directory:

cd cassandra-todolist-chatgpt-plugin

Install Prerequisites

To install the required packages for this plugin, run the following command:

pip install -r requirements.txt

Setup DB & API

You can read up on how to setup the database and configure the API spec. It's important to either have a Cassandra server or use Datastax Astra DB, otherwise this example won't work.

  • Database setup - Create a database, keyspace, and import the schema/
  • API setup - Update plugin and openapi spec for ChatGPT to discover your API's capabilities.

Create/edit .env and add the DB details to your .env file

touch .env

and add (if you are using DataStax Astra) the two components of the Astra Token to your .env file:

astra_clientID="<<your clientID"
astra_clientSecret="<<your clientSecret>>"

If you are using Astra, you'll also need to download and add the Secure Connect Bundle into your ./setup folder.

Run the API

To run the plugin, enter the following command:

python main.py

Once the local server is running:

  1. Navigate to https://chat.openai.com.
  2. In the Model drop down, select "Plugins" (note, if you don't see it there, you don't have access yet).
  3. Select "Plugin store"
  4. Select "Develop your own plugin"
  5. Enter in localhost:5003 since this is the URL the server is running on locally, then select "Find manifest file".

The plugin should now be installed and enabled! You can start with a question like "What is on my todo list" and then try adding something to it as well!

Getting help

If you run into issues or have questions building a plugin, please join our Developer community forum.

Todo

  • Update links to connect w/ CassioML community on Github , PlanetCassandra discord
  • Add Cassandra Driver/Cassio Lib to interact w/ Cassandra/Astra
  • Add CRUD code for TODOs in main.py

Done

  • Add instructions to create schema in Cassandra/Astra