diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4e7730d --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Scalekit Inc + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..9a8300f --- /dev/null +++ b/README.md @@ -0,0 +1,133 @@ +

+ + + + + +

+ +

+ Scalekit Python Connect Demos +

+ +

+ Auth stack for AI apps ⚡ Python agent integrations +

+ +

+ PyPI version + License: MIT + Documentation +

+ +

+ Python examples demonstrating third-party app integrations and AI agent connectivity with Scalekit Connect +

+ +## 🚀 Available Demos + +### 1. Direct Integration +**Direct Python SDK usage with third-party apps** + +- **OAuth Flows**: Connect to Gmail, Slack, and other third-party services +- **Tool Execution**: Execute pre-built tools for common app integrations +- **Authorization Links**: Generate OAuth authorization URLs for users +- **API Interactions**: Direct API calls to integrated third-party services + +### 2. LangChain Integration +**AI agents with third-party app access** + +- **LangChain Tools**: Pre-built tools for Gmail, Google Calendar, Salesforce, HubSpot +- **Agent Workflows**: AI agents that can read emails, manage calendars, update CRM +- **Authentication Flow**: OAuth-based access to user's third-party accounts +- **Multi-App Chains**: Complex workflows across multiple integrated apps + +### 3. OpenAI Integration +**OpenAI functions with app integrations** + +- **Function Calling**: OpenAI functions that can access Gmail, Slack, etc. +- **Email Management**: Read latest emails and send summaries to Slack +- **Automated Workflows**: AI-driven actions across multiple connected apps +- **OAuth Integration**: Secure access to user's authorized third-party accounts + +### 4. Model Context Protocol (MCP) +**MCP server with third-party app tools** + +- **MCP Server**: Expose third-party app tools through Model Context Protocol +- **Tool Mappings**: Configure which apps and tools are available to AI agents +- **Multi-App Access**: Single MCP server providing access to Gmail, Calendar, etc. +- **Client Compatibility**: Works with various MCP-compatible AI clients + +## Getting Started + +### Prerequisites + +- Python 3.8+ +- Scalekit account and credentials +- Virtual environment (recommended) + +### Installation + +1. Clone the repository: +```bash +git clone https://github.com/scalekit-inc/python-connect-demos.git +cd python-connect-demos +``` + +2. Create and activate virtual environment: +```bash +python -m venv venv +source venv/bin/activate # On Windows: venv\Scripts\activate +``` + +3. Install dependencies: +```bash +pip install -r requirements.txt +``` + +4. Configure environment variables: +```bash +# Create .env file with your Scalekit credentials +SCALEKIT_ENV_URL=your_environment_url +SCALEKIT_CLIENT_ID=your_client_id +SCALEKIT_CLIENT_SECRET=your_client_secret +``` + +### Running the Examples + +Each demo directory contains specific setup and running instructions. Navigate to the desired demo and follow its README: + +- `direct/` - Direct API integration examples +- `langchain/` - LangChain agent examples +- `openai/` - OpenAI assistant examples +- `mcp/` - Model Context Protocol server examples + +## Key Features + +- **Third-Party App Integrations**: OAuth connections to Gmail, Slack, Google Calendar, Salesforce, HubSpot +- **AI Agent Tools**: Pre-built tools for AI agents to interact with connected apps +- **Multi-Framework Support**: Examples for direct SDK usage, LangChain, OpenAI, and MCP +- **OAuth Flows**: Secure authorization and token management for third-party services +- **Tool Execution**: Execute actions like reading emails, sending messages, managing calendar events + +## Additional Resources + + - 📚 [Scalekit Documentation](https://docs.scalekit.com) + - 🔧 [API Reference](https://docs.scalekit.com/apis/) + - 🚀 [Full Stack Auth Quickstart](https://docs.scalekit.com/fsa/quickstart/) + - 💬 [Community Examples](https://github.com/orgs/scalekit-developers/repositories) + - 🐍 [Python SDK](https://github.com/scalekit-inc/scalekit-sdk-python) + +## Contributing + +We welcome contributions! Please feel free to submit a pull request with any improvements or additional examples. + +## License + +This project is licensed under the MIT License - see the LICENSE file for details. + +--- + +

+ Made with ❤️ by Scalekit +

\ No newline at end of file