chatgpt plugin

.env

@@ -0,0 +1,6 @@
+# .env
+export FLASK_HOST=0.0.0.0
+export FLASK_PORT=5085
+export ALPHA_VANTAGE_API_KEY=1095SN3T01WJENIZ
+export ALPHA_VANTAGE_BASE_URL="https://www.alphavantage.co/query"
+export MY_API_DOMAIN_URL="http://192.168.1.235:5085"

Dockerfile

@@ -0,0 +1,42 @@
+# set base image (host OS)
+FROM python:3.11-slim
+
+# Install gettext for envsubst
+RUN apt-get update && apt-get install -y gettext && rm -rf /var/lib/apt/lists/*
+
+
+RUN pip install --upgrade pip
+
+RUN adduser --disabled-password -q worker
+USER worker
+ENV PATH="/home/user/.local/bin:$PATH"
+
+# set the working directory in the container
+WORKDIR /code
+
+# ENV PATH='/home/worker/.local/bin:$PATH'
+RUN mkdir /code/app
+
+COPY --chown=worker:worker app /code/app
+
+# install dependencies
+COPY --chown=worker:worker requirements.txt requirements.txt
+RUN pip install --user -r requirements.txt
+
+LABEL maintainer="Satya Dillikar <satya.dillikar@gmail.com>" \
+      version="1.0.0"
+
+ARG FLASK_PORT
+# Expose port for Flask
+EXPOSE ${FLASK_PORT}
+RUN echo FLASK_PORT $FLASK_PORT
+
+# ARG MY_API_DOMAIN_URL
+# ENV MY_API_DOMAIN_URL=${MY_API_DOMAIN_URL}
+# RUN echo MY_API_DOMAIN_URL $MY_API_DOMAIN_URL
+
+# Set the entrypoint
+ENTRYPOINT ["app/entrypoint.sh"]
+
+# command to run on container start
+CMD ["python", "app/main.py" ]

README.md

@@ -1,10 +1,8 @@
----
-title: Chatgptplugins
-emoji: 🐢
-colorFrom: green
-colorTo: purple
-sdk: docker
-pinned: false
----
+# Project Summary
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+In this repo, you'll find the code files needed to create a simple ChatGPT plugin that retrieves information for a single stock.
+- **main.py**: A simple Flask program written to retrieve stock informatiom from an external API (Alpha Vantage)
+- **ai-plugin.json**: The plugin manifest file that contains plugin metadata (name, logo, etc.) and auth type
+- **openapi.yaml**: The OpenAPI specification with details about your API so ChatGPT understands what it does
+
+For a step-by-step walk-through of how to set up a development environment and install the plugin in ChatGPT, check out [this YouTube video](https://youtu.be/-GV7DAJ4dVU).

app/ai-plugin.json

@@ -0,0 +1,17 @@
+{
+    "schema_version": "v1",
+    "name_for_human": "Stock Quote",
+    "name_for_model": "StockQuote",
+    "description_for_human": "Get price and volume information for a given stock.",
+    "description_for_model": "Get price and volume information for a given stock.  Always display results using markdown tables.",
+    "auth": {
+        "type": "none"
+    },
+    "api": {
+        "type": "openapi",
+        "url": "https://localhost.com/openapi.yaml"
+    },
+    "logo_url": "https://localhost.com/logo.png",
+    "contact_email": "support@example.com",
+    "legal_info_url": "https://localhost.com/legal"
+}

app/ai-plugin.json.template

@@ -0,0 +1,17 @@
+{
+    "schema_version": "v1",
+    "name_for_human": "Stock Quote",
+    "name_for_model": "StockQuote",
+    "description_for_human": "Get price and volume information for a given stock.",
+    "description_for_model": "Get price and volume information for a given stock.  Always display results using markdown tables.",
+    "auth": {
+        "type": "none"
+    },
+    "api": {
+        "type": "openapi",
+        "url": "${MY_API_DOMAIN_URL}/openapi.yaml"
+    },
+    "logo_url": "${MY_API_DOMAIN_URL}/logo.png",
+    "contact_email": "support@example.com",
+    "legal_info_url": "${MY_API_DOMAIN_URL}/legal"
+}

app/entrypoint.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# Use envsubst to replace variables in the config file template
+envsubst < app/openapi.yaml.template > app/openapi.yaml
+envsubst < app/ai-plugin.json.template > app/ai-plugin.json
+
+# Print substituted config for verification (optional)
+echo "file openapi.yaml"
+cat app/openapi.yaml
+echo "file ai-plugin.json"
+cat app/ai-plugin.json
+
+# Execute the main application command
+exec "$@"

app/main.py

@@ -0,0 +1,49 @@
+from flask import Flask, request, send_from_directory
+import os
+import requests
+from dotenv import load_dotenv
+
+# Replace "YOUR_API_KEY_HERE" with your actual API key.
+# API_KEY = "YOUR_API_KEY_HERE"
+# BASE_URL = "https://www.alphavantage.co/query"
+# Load environment variables from .env file
+load_dotenv()
+app = Flask(__name__)
+
+
+@app.route("/")
+def index():
+  return "Hello chatgptplugins! Your web application is working!"
+
+
+@app.route('/stock', methods=['GET'])
+def get_stock_data():
+  API_KEY = os.getenv("ALPHA_VANTAGE_API_KEY")
+  BASE_URL = os.getenv("ALPHA_VANTAGE_BASE_URL")
+  print("BASE_URL: ", BASE_URL)
+  symbol = request.args.get('symbol')
+
+  params = {"function": "GLOBAL_QUOTE", "symbol": symbol, "apikey": API_KEY}
+
+  response = requests.get(BASE_URL, params=params)
+  return response.json()
+
+
+@app.route('/.well-known/ai-plugin.json')
+def serve_ai_plugin():
+  return send_from_directory(".",
+                             'ai-plugin.json',
+                             mimetype='application/json')
+
+
+@app.route('/openapi.yaml')
+def serve_openapi_yaml():
+  return send_from_directory('.', 'openapi.yaml', mimetype='text/yaml')
+
+
+if __name__ == "__main__":
+  host = os.getenv("FLASK_HOST", "0.0.0.0")
+  port = int(os.getenv("FLASK_PORT", 5000))
+  print("host: ", host)
+  print(" port: ", port)
+  app.run(host=host, port=port, debug=True)

app/openapi.yaml

@@ -0,0 +1,21 @@
+openapi: 3.0.1
+info:
+    title: Stock Quote
+    description: Get price and volume information for a given stock.
+    version: "v1"
+servers:
+    - url: "https://localhost.com"
+paths:
+    /stock:
+        get:
+            operationId: getStockData
+            summary: Retrieves the price and volume information for a given stock symbol.
+            parameters:
+                - in: query
+                  name: symbol
+                  schema:
+                      type: string
+                  description: The symbol of the stock to get a quote for. For example, the stock symbol MSFT represents the company Microsoft.
+            responses:
+                "200":
+                    description: OK

app/openapi.yaml.template

@@ -0,0 +1,21 @@
+openapi: 3.0.1
+info:
+    title: Stock Quote
+    description: Get price and volume information for a given stock.
+    version: "v1"
+servers:
+    - url: "${MY_API_DOMAIN_URL}"
+paths:
+    /stock:
+        get:
+            operationId: getStockData
+            summary: Retrieves the price and volume information for a given stock symbol.
+            parameters:
+                - in: query
+                  name: symbol
+                  schema:
+                      type: string
+                  description: The symbol of the stock to get a quote for. For example, the stock symbol MSFT represents the company Microsoft.
+            responses:
+                "200":
+                    description: OK

archive/Makefile

@@ -0,0 +1,40 @@
+NAME:=chatgptplugins
+DOCKER_REPOSITORY:=dsatya6
+VERSION:=v1
+DOCKER_IMAGE_NAME:=$(DOCKER_REPOSITORY)/$(NAME):$(VERSION)
+
+.PHONY: build clean test build-container push-container test-container
+
+build :
+	python app/main.py
+
+clean :
+	@echo ""
+
+test:
+	python app/main.py
+
+
+build-container :
+	@docker build $(grep -v '^#' dot_env | sed 's/^/--build-arg /') -t $(DOCKER_IMAGE_NAME) --no-cache --progress plain .
+
+push-container :
+	@docker push $(DOCKER_IMAGE_NAME)
+
+test-container :
+	@docker rm -f $(DOCKER_IMAGE_NAME) || true
+	# python server is running a 5000, map to docker 5000
+	@docker run -dp 5082:5082 --name=$(NAME) $(DOCKER_IMAGE_NAME)
+	@docker ps
+	@sleep 5
+	@curl http://localhost:5082/
+	@echo ""
+	@sleep 2
+	@curl http://localhost:5082/openapi.yaml
+	@echo ""
+	@sleep 2
+	@curl http://localhost:5082/.well-known/ai-plugin.json
+	@echo ""
+	@sleep 2	
+	@docker stop $(NAME) || true
+	@docker rm -f $(NAME) || true%

archive/docker-compose.yaml

@@ -0,0 +1,16 @@
+services:
+  web:
+    build:
+      context: .
+      dockerfile: Dockerfile
+      args:
+        FLASK_HOST: ${FLASK_HOST}
+        FLASK_PORT: ${FLASK_PORT}
+        MY_API_DOMAIN_URL: ${MY_API_DOMAIN_URL}
+    ports:
+      - "${FLASK_PORT}:${FLASK_PORT}"
+    env_file:
+      - .env  # Load environment variables from .env file
+    environment:
+        FLASK_HOST: ${FLASK_HOST}
+        FLASK_PORT: ${FLASK_PORT}

archive/dot_env_export

@@ -0,0 +1,6 @@
+# .env
+export FLASK_HOST=0.0.0.0
+export FLASK_PORT=5085
+export ALPHA_VANTAGE_API_KEY=1095SN3T01WJENIZ
+export ALPHA_VANTAGE_BASE_URL="https://www.alphavantage.co/query"
+export MY_API_DOMAIN_URL="http://192.168.1.235:5085"

dot_env

@@ -0,0 +1,6 @@
+# .env
+FLASK_HOST=0.0.0.0
+FLASK_PORT=5085
+ALPHA_VANTAGE_API_KEY=1095SN3T01WJENIZ
+ALPHA_VANTAGE_BASE_URL="https://www.alphavantage.co/query"
+MY_API_DOMAIN_URL="http://192.168.1.235:5085"

requirements.txt

@@ -0,0 +1,3 @@
+Flask==2.3.3
+requests==2.32.2
+python-dotenv==1.0.0

script.sh

@@ -0,0 +1,12 @@
+docker build $(grep -v '^#' dot_env | sed 's/^/--build-arg /') -t dsatya6/chatgptplugins:v1 .
+
+docker run -p 5082:5082 --name=chatgptplugins --env-file dot_env dsatya6/chatgptplugins:v1
+docker stop chatgptplugins
+docker rm chatgptplugins
+
+curl http://172.17.0.2:5085
+curl http://172.17.0.2:5085/openapi.yaml
+curl http://172.17.0.2:5085/.well-known/ai-plugin.json
+
+
+docker rmi dsatya6/chatgptplugins:v1