This repository provides a quickstart for developing ChatGPT plugins using Python and FastAPI, targeting developers who want to integrate their services with ChatGPT. It simplifies the process from local development to production deployment on Azure, leveraging GitHub Codespaces and Azure Developer CLI for a streamlined workflow.

How It Works

The project utilizes FastAPI, a modern Python web framework, to build the plugin's API. It includes a basic structure for defining API routes and generating the necessary ai-plugin.json manifest file. The sample emphasizes rapid iteration through features like hot-reloading in Codespaces and VS Code's debugging capabilities, making it easy to develop and test plugin functionality.

Quick Start & Requirements

• Codespaces: Click "Open in GitHub Codespaces" for a pre-configured environment.
• Local Development: Clone the repository, create a Python virtual environment, and run python main.py (requires Python 3.7+).
• Azure Deployment: Requires Azure Developer CLI (azd) and an Azure subscription.
• ChatGPT Plugin Access: Requires joining the ChatGPT plugin waitlist.
• Documentation: ChatGPT Plugin Quickstart

Highlighted Details

• One-click setup via GitHub Codespaces.
• Integration with GitHub Copilot for accelerated API development.
• Deployment options to Azure Container Apps using Azure Developer CLI.
• Support for deployment via GitHub Actions.

Maintenance & Community

The project is an official Azure sample, indicating backing from Microsoft. Contributions are welcomed, subject to a Contributor License Agreement (CLA). The project adheres to the Microsoft Open Source Code of Conduct.

Licensing & Compatibility

The repository does not explicitly state a license in the provided README. However, as an Azure sample, it is likely intended for broad use, but users should verify licensing for commercial or closed-source integration.

Limitations & Caveats

The README notes potential security restrictions with Codespaces in the browser, recommending opening the project directly in VS Code if issues arise. Access to ChatGPT plugins is subject to waitlist approval.