composio-core 0.7.21
[DEPRECATED] Core package to act as a bridge between composio platform and other services. Please use 'composio' instead.
Requires Python: <4,>=3.9

<p>
  <a href="https://github.com/composiohq/composio/blob/master/README.md">EN</a> | <a
    href="https://github.com/composiohq/composio/blob/master/README-CN.md">CN</a> | <a
    href="https://github.com/composiohq/composio/blob/master/README-JP.md">JP</a>
</p>
<p align="center">
  <a href="https://composio.dev//#gh-dark-mode-only">
    <img src="./python/docs/imgs/composio_white_font.svg" width="318px" alt="Composio logo" />
  </a>
  <a href="https://composio.dev//#gh-light-mode-only">
    <img src="./python/docs/imgs/composio_black_font.svg" width="318px" alt="Composio Logo" />
  </a>
</p>
<p align="center">
  <a href="https://docs.composio.dev">
    <img
      src="https://img.shields.io/badge/Read%20the%20Documentation-Click%20Here-green?style=for-the-badge&logo=read-the-docs"
      alt="Read the Docs">
  </a>
</p>

<p align="center">
  <a href="https://pypi.org/project/composio-core/">
    <img alt="PyPI"
      src="https://img.shields.io/pypi/v/composio_core?label=Latest&style=plastic&logo=pypi&color=blue&cacheSeconds=60&logoColor=white">
  </a>
  <a href="https://www.npmjs.com/package/composio-core">
    <img alt="NPM"
      src="https://img.shields.io/npm/v/composio-core?style=plastic&logo=npm&logoColor=white&label=latest&color=blue&cacheSeconds=60">
  </a>
  <a href="https://pypi.org/project/composio-core/">
    <img alt="Downloads"
      src="https://img.shields.io/pypi/dm/composio-core?label=Downloads&style=plastic&logo=github&color=blue&cacheSeconds=60">
  </a>
</p>

<h2 align="center">
  Production Ready Toolset for AI Agents
</h2>

<p align="center">
  <a href="https://docs.composio.dev/mcp/overview?utm=readme">
    <img src="./assets/mcp-banner.png" alt="Composio MCP Servers" width="100%" style="border-radius: 8px; margin: 20px 0;" />
  </a>
</p>
<a href="https://docs.composio.dev/mcp/overview?utm=readme">
  <img alt="Composio Cursor" src="./assets/cursor-mcp.webp" style="border-radius: 5px" />
</a>


<h2 align="center">🚀 Now launching Composio MCP🚀</h2>

<p align="center">
  We're excited to announce the launch of <strong>Composio MCP Servers</strong>!
  Connect Claude, Cursor and Windsurf to 100+ fully-managed MCP Servers with built-in auth! Check it out <a href="https://mcp.composio.dev">here</a>
</p>

<p align="center">

</p>

<p align="center">
  <a href="https://docs.composio.dev/mcp/overview">
    <img src="https://img.shields.io/badge/Learn%20More-MCP%20Servers-blue?style=for-the-badge" alt="Learn More About MCP Servers">
  </a>
</p>



<h2>What is Composio?</h2>
<p><strong>Composio provides production-ready toolset for AI agents</strong>, offering:</p>
<ul>
  <li>Support for over 250+ tools across multiple categories:
    <ul>
      <li>Software tools like GitHub, Notion, Linear, Gmail, Slack, Hubspot, Salesforce &
        <a href="https://app.composio.dev/apps">
          more
        </a>
      </li>
      <li>OS operations including file tool, shell tool, code analysis tool &
        <a href="https://app.composio.dev/apps">
          more
        </a>
      </li>
      <li>Search capabilities through Google, Perplexity, Tavily, and Exa &
        <a href="https://app.composio.dev/apps">
          more
        </a>
      </li>
    </ul>
  </li>
  <li>Comprehensive framework support including OpenAI, Groq, Claude, LlamaIndex, Langchain, CrewAI, Autogen, Gemini,
    and <a href="https://docs.composio.dev/framework">more</a></li>
  <li>Managed authentication supporting multiple protocols (OAuth, API Keys, Basic JWT)</li>
  <li>Up to 40% improved tool call accuracy through optimized design</li>
  <li>Whitelabel solution for backend integration</li>
  <li>Pluggable architecture supporting custom tools and extensions</li>
</ul>

## Table of contents

- [Getting Started with Python](#1-installation)
  - [1. Installation](#1-installation)
  - [2. Creating an agent & executing a tool](#2-creating-an-agent--executing-a-tool)
- [Getting Started with Javascript](#getting-started-with-javascript)
  - [1. Installation](#1-installation-1)
  - [2. Creating an agent & executing a tool](#2-creating-an-agent--executing-a-tool-1)
- [Examples](#examples)
  - [Python Examples](#python-examples)
  - [Javascript Examples](#javascript-examples)
- [Star History](#star-history)
- [Getting help](#getting-help)
- [Contributions](#contributions)
- [Request a feature](#request-a-feature)
- [Thanks To All Contributors](#thanks-to-all-contributors)


## Getting Started with Python

### 1. Installation

Start by installing the package

```bash
pip install composio-core
```

If you want to install the 'composio' package along with its openai plugin: `pip install composio-openai`.

### 2. Creating an agent & executing a tool

Let's create an AI Agent using OpenAI and use Composio's GitHub tool to star a GitHub repository

> [!NOTE]
> Set your COMPOSIO_API_KEY & OPENAI_API_KEY in your environment variables.

Connect your GitHub account to Composio
```bash
composio add github # Run this in terminal
```

```python

from openai import OpenAI
from composio_openai import ComposioToolSet, App, Action

# Initialize OpenAI client
openai_client = OpenAI(
    api_key="{{OPENAIKEY}}"
)

# Initialize the Composio Tool Set
composio_tool_set = ComposioToolSet()

# Get GitHub tools that are pre-configured
actions = composio_tool_set.get_actions(
    actions=[Action.GITHUB_STAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER]
)

my_task = "Star a repo composiodev/composio on GitHub"

# Setup OpenAI assistant
assistant_instruction = "You are a super intelligent personal assistant"
assistant = openai_client.beta.assistants.create(
    name="Personal Assistant",
    instructions=assistant_instruction,
    model="gpt-4-turbo",
    tools=actions,
)

# Create a thread
thread = openai_client.beta.threads.create()

# Add user message to thread
message = openai_client.beta.threads.messages.create(
    thread_id=thread.id,
    role="user",
    content=my_task
)

# Execute Agent with integrations
run = openai_client.beta.threads.runs.create(
    thread_id=thread.id,
    assistant_id=assistant.id
)

# Execute Function calls
response_after_tool_calls = composio_tool_set.wait_and_handle_assistant_tool_calls(
    client=openai_client,
    run=run,
    thread=thread,
)

print(response_after_tool_calls)
```

## Getting Started with JavaScript

To get started with the Composio SDK in JavaScript, follow these steps:

### 1. Installation:
```bash
npm install composio-core
```

### 2. Creating an agent & executing a tool

Let's create an AI Agent using OpenAI and use Composio's GitHub tool to star a GitHub repository

> [!NOTE]
> Set your COMPOSIO_API_KEY & OPENAI_API_KEY in your environment variables.

Connect your GitHub account to Composio
```bash
composio add github # Run this in terminal
```

```javascript
import { OpenAIToolSet } from "composio-core";
import OpenAI from "openai";

const toolset = new OpenAIToolSet({ apiKey: process.env.COMPOSIO_API_KEY });
const openai = new OpenAI({ apiKey: process.env.OPENAI_API_KEY });

const tools = await toolset.getTools({ 
  actions: ["GITHUB_STAR_A_REPOSITORY_FOR_THE_AUTHENTICATED_USER"] 
});

async function createGithubAssistant(openai, tools) {
  return await openai.beta.assistants.create({
    name: "Github Assistant",
    instructions: "You're a GitHub Assistant, you can do operations on GitHub",
    tools: tools,
    model: "gpt-4o"
  });
}

async function executeAssistantTask(openai, toolset, assistant, task) {
  const thread = await openai.beta.threads.create();
  
  const run = await openai.beta.threads.runs.create(thread.id, {
    assistant_id: assistant.id,
    instructions: task,
    tools: tools,
    model: "gpt-4o",
    stream: false
  });
  
  const call = await toolset.waitAndHandleAssistantToolCalls(openai, run, thread);
  console.log(call);
}

(async () => {
  const githubAssistant = await createGithubAssistant(openai, tools);
  
  await executeAssistantTask(
    openai,
    toolset,
    githubAssistant,
    "Star the repository 'composiohq/composio'"
  );
})();
```

## Examples

### [Python Examples](https://docs.composio.dev/guides/python/)

### [Javascript Examples](https://docs.composio.dev/guides/javascript/)

## Star History

[![Star History
Chart](https://api.star-history.com/svg?repos=composiohq/composio&type=Date)](https://star-history.com/#composiohq/composio&Date)

## Getting help

- Read the docs at <a href="https://docs.composio.dev" target="_blank" rel="noopener noreferrer">docs.composio.dev</a>
- Post your questions on <a href="https://discord.com/channels/1170785031560646836/1268871288156323901" target="_blank"
  rel="noopener noreferrer">discord</a>

## Contributions

We're an open-source project and welcome contributions. Please read the <a
  href="https://github.com/composiodev/composio/blob/master/CONTRIBUTING.md" target="_blank"
  rel="noopener noreferrer">contributing guide</a> for more information and check our <a
  href="https://github.com/composiodev/composio/blob/master/CODE_OF_CONDUCT.md" target="_blank"
  rel="noopener noreferrer">code of conduct</a> before you start.

## Request a feature

- If you have a feature request, please open an <a
  href="https://github.com/composiodev/composio/issues/new?assignees=&labels=feature&template=feature_request.yml&title=%F0%9F%9A%80+Feature%3A+">issue</a>,
make a pull request, or submit it in our <a href="https://discord.com/channels/1170785031560646836/1247166813205303379"
  target="_blank" rel="noopener noreferrer">feature requests channel</a>.
- If you have ideas for improvements, you can also start a discussion in our GitHub repository.

## Thanks To All Contributors

<a href="https://github.com/composiohq/composio/graphs/contributors">
  <img src="https://contributors-img.web.app/image?repo=composiodev/composio" alt="List of Contributors" />
</a>

<br><br>

<div align="center">
  <p>
    <a href="https://dub.composio.dev/JoinHQ" target="_blank" rel="noopener noreferrer">
      <img src="https://github.com/user-attachments/assets/c499721b-d3c2-4bfc-891f-4d74b587911f" alt="discord" />
    </a>&nbsp;&nbsp;&nbsp;
    <a href="https://www.youtube.com/@Composio" target="_blank" rel="noopener noreferrer">
      <img src="https://github.com/user-attachments/assets/57072338-3e7a-42a5-bd2b-c58b143ffa29" alt="youtube" />
    </a>&nbsp;&nbsp;&nbsp;
    <a href="https://twitter.com/composiohq" target="_blank" rel="noopener noreferrer">
      <img src="https://github.com/user-attachments/assets/14b87a1d-8ac7-48b4-ae7c-3a36aacc260b" alt="x" />
    </a>&nbsp;&nbsp;&nbsp;
    <a href="https://www.linkedin.com/company/composio-dev" target="_blank" rel="noopener noreferrer">
      <img src="https://github.com/user-attachments/assets/cb6cc650-672e-41f6-8abf-dfc97fddfcbc" alt="linkedin" />
    </a>
  </p>
</div>