stripe-agent-toolkit 0.1.16__tar.gz

stripe_agent_toolkit-0.1.16/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Stripe
+
+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.

stripe_agent_toolkit-0.1.16/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.1
+Name: stripe-agent-toolkit
+Version: 0.1.16
+Summary: Stripe Agent Toolkit
+Author-email: Stripe <support@stripe.com>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2024 Stripe
+        
+        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.
+        
+Project-URL: Bug Tracker, https://github.com/stripe/agent-toolkit/issues
+Project-URL: Source Code, https://github.com/stripe/agent-toolkit
+Keywords: stripe,api,payments
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Stripe Agent Toolkit - Python
+
+The Stripe Agent Toolkit library enables popular agent frameworks including LangChain and CrewAI to integrate with Stripe APIs through function calling. The
+library is not exhaustive of the entire Stripe API. It is built directly on top
+of the [Stripe Python SDK][python-sdk].
+
+## Installation
+
+You don't need this source code unless you want to modify the package. If you just
+want to use the package, just run:
+
+```sh
+pip install stripe-agent-toolkit
+```
+
+### Requirements
+
+- Python 3.11+
+
+## Usage
+
+The library needs to be configured with your account's secret key which is
+available in your [Stripe Dashboard][api-keys].
+
+```python
+from stripe_agent_toolkit.crewai.toolkit import StripeAgentToolkit
+
+stripe_agent_toolkit = StripeAgentToolkit(
+    secret_key="sk_test_...",
+    configuration={
+        "actions": {
+            "payment_links": {
+                "create": True,
+            },
+        }
+    },
+)
+```
+
+The toolkit works with LangChain and CrewAI and can be passed as a list of tools. For example:
+
+```python
+from crewai import Agent
+
+stripe_agent = Agent(
+    role="Stripe Agent",
+    goal="Integrate with Stripe",
+    backstory="You are an expert at integrating with Stripe",
+    tools=[*stripe_toolkit.get_tools()]
+)
+```
+
+Examples for LangChain and CrewAI are included in `/examples`.
+
+[python-sdk]: https://github.com/stripe/stripe-python
+[api-keys]: https://dashboard.stripe.com/account/apikeys
+
+## Development
+
+```
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+```

stripe_agent_toolkit-0.1.16/README.md

@@ -0,0 +1,64 @@
+# Stripe Agent Toolkit - Python
+
+The Stripe Agent Toolkit library enables popular agent frameworks including LangChain and CrewAI to integrate with Stripe APIs through function calling. The
+library is not exhaustive of the entire Stripe API. It is built directly on top
+of the [Stripe Python SDK][python-sdk].
+
+## Installation
+
+You don't need this source code unless you want to modify the package. If you just
+want to use the package, just run:
+
+```sh
+pip install stripe-agent-toolkit
+```
+
+### Requirements
+
+- Python 3.11+
+
+## Usage
+
+The library needs to be configured with your account's secret key which is
+available in your [Stripe Dashboard][api-keys].
+
+```python
+from stripe_agent_toolkit.crewai.toolkit import StripeAgentToolkit
+
+stripe_agent_toolkit = StripeAgentToolkit(
+    secret_key="sk_test_...",
+    configuration={
+        "actions": {
+            "payment_links": {
+                "create": True,
+            },
+        }
+    },
+)
+```
+
+The toolkit works with LangChain and CrewAI and can be passed as a list of tools. For example:
+
+```python
+from crewai import Agent
+
+stripe_agent = Agent(
+    role="Stripe Agent",
+    goal="Integrate with Stripe",
+    backstory="You are an expert at integrating with Stripe",
+    tools=[*stripe_toolkit.get_tools()]
+)
+```
+
+Examples for LangChain and CrewAI are included in `/examples`.
+
+[python-sdk]: https://github.com/stripe/stripe-python
+[api-keys]: https://dashboard.stripe.com/account/apikeys
+
+## Development
+
+```
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+```

stripe_agent_toolkit-0.1.16/pyproject.toml

@@ -0,0 +1,40 @@
+[project]
+name = "stripe-agent-toolkit"
+version = "0.1.16"
+description = "Stripe Agent Toolkit"
+readme = "README.md"
+license = {file = "LICENSE"}
+authors = [
+  {name = "Stripe", email = "support@stripe.com"}
+]
+keywords = ["stripe", "api", "payments"]
+
+[project.urls]
+"Bug Tracker" = "https://github.com/stripe/agent-toolkit/issues"
+"Source Code" = "https://github.com/stripe/agent-toolkit"
+
+[tool.setuptools.packages.find]
+include = ["stripe_agent_toolkit*"]
+exclude = ["tests*", "examples*"]
+
+[tool.ruff]
+# same as our black config
+line-length = 79
+extend-exclude = ["build"]
+
+[tool.ruff.format]
+# currently the default value, but opt-out in the future
+docstring-code-format = false
+
+[tool.pyright]
+include = [
+  "*",
+]
+exclude = ["build", "**/__pycache__"]
+reportMissingTypeArgument = true
+reportUnnecessaryCast = true
+reportUnnecessaryComparison = true
+reportUnnecessaryContains = true
+reportUnnecessaryIsInstance = true
+reportPrivateImportUsage = true
+reportUnnecessaryTypeIgnoreComment = true

stripe_agent_toolkit-0.1.16/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

stripe_agent_toolkit-0.1.16/stripe_agent_toolkit/api.py

@@ -0,0 +1,60 @@
+"""Util that calls Stripe."""
+
+from __future__ import annotations
+
+import json
+import stripe
+from pydantic import BaseModel
+
+from .functions import (
+    create_customer,
+    list_customers,
+    create_product,
+    list_products,
+    create_price,
+    list_prices,
+    create_payment_link,
+    create_invoice,
+    create_invoice_item,
+    finalize_invoice,
+    retrieve_balance,
+)
+
+
+class StripeAPI(BaseModel):
+    """ "Wrapper for Stripe API"""
+
+    def __init__(self, secret_key: str):
+        super().__init__()
+        stripe.api_key = secret_key
+        stripe.set_app_info(
+            "stripe-agent-toolkit-python",
+            version="0.1.16",
+            url="https://github.com/stripe/agent-toolkit",
+        )
+
+    def run(self, method: str, *args, **kwargs) -> str:
+        if method == "create_customer":
+            return json.dumps(create_customer(*args, **kwargs))
+        elif method == "list_customers":
+            return json.dumps(list_customers(*args, **kwargs))
+        elif method == "create_product":
+            return json.dumps(create_product(*args, **kwargs))
+        elif method == "list_products":
+            return json.dumps(list_products(*args, **kwargs))
+        elif method == "create_price":
+            return json.dumps(create_price(*args, **kwargs))
+        elif method == "list_prices":
+            return json.dumps(list_prices(*args, **kwargs))
+        elif method == "create_payment_link":
+            return json.dumps(create_payment_link(*args, **kwargs))
+        elif method == "create_invoice":
+            return json.dumps(create_invoice(*args, **kwargs))
+        elif method == "create_invoice_item":
+            return json.dumps(create_invoice_item(*args, **kwargs))
+        elif method == "finalize_invoice":
+            return json.dumps(finalize_invoice(*args, **kwargs))
+        elif method == "retrieve_balance":
+            return json.dumps(retrieve_balance(*args, **kwargs))
+        else:
+            raise ValueError("Invalid method " + method)

stripe_agent_toolkit-0.1.16/stripe_agent_toolkit/configuration.py

@@ -0,0 +1,54 @@
+from typing import TypedDict, Literal, Optional
+
+# Define Object type
+Object = Literal[
+    "customers",
+    "invoices",
+    "invoiceItems",
+    "paymentLinks",
+    "products",
+    "prices",
+    "balance",
+]
+
+
+# Define Permission type
+class Permission(TypedDict, total=False):
+    create: Optional[bool]
+    update: Optional[bool]
+    read: Optional[bool]
+
+
+# Define BalancePermission type
+class BalancePermission(TypedDict, total=False):
+    read: Optional[bool]
+
+
+# Define Actions type
+class Actions(TypedDict, total=False):
+    customers: Optional[Permission]
+    invoices: Optional[Permission]
+    invoice_items: Optional[Permission]
+    payment_links: Optional[Permission]
+    products: Optional[Permission]
+    prices: Optional[Permission]
+    balance: Optional[BalancePermission]
+
+
+# Define Configuration type
+class Configuration(TypedDict, total=False):
+    actions: Optional[Actions]
+
+
+def is_tool_allowed(tool, configuration):
+    for resource, permissions in tool.get("actions").items():
+        if resource not in configuration.get("actions", {}):
+            return False
+        for permission in permissions:
+            if (
+                not configuration["actions"]
+                .get(resource, {})
+                .get(permission, False)
+            ):
+                return False
+    return True

stripe_agent_toolkit-0.1.16/stripe_agent_toolkit/crewai/tool.py

@@ -0,0 +1,30 @@
+"""
+This tool allows agents to interact with the Stripe API.
+"""
+
+from __future__ import annotations
+
+from typing import Any, Optional, Type
+from pydantic import BaseModel
+
+from crewai_tools import BaseTool
+
+from ..api import StripeAPI
+
+
+class StripeTool(BaseTool):
+    """Tool for interacting with the Stripe API."""
+
+    stripe_api: StripeAPI
+    method: str
+    name: str = ""
+    description: str = ""
+    args_schema: Optional[Type[BaseModel]] = None
+
+    def _run(
+        self,
+        *args: Any,
+        **kwargs: Any,
+    ) -> str:
+        """Use the Stripe API to run an operation."""
+        return self.stripe_api.run(self.method, *args, **kwargs)

stripe_agent_toolkit-0.1.16/stripe_agent_toolkit/crewai/toolkit.py

@@ -0,0 +1,37 @@
+"""Stripe Agent Toolkit."""
+
+from typing import List
+from pydantic import PrivateAttr
+
+from ..api import StripeAPI
+from ..tools import tools
+from ..configuration import Configuration, is_tool_allowed
+from .tool import StripeTool
+
+
+class StripeAgentToolkit:
+    _tools: List = PrivateAttr(default=[])
+
+    def __init__(self, secret_key: str, configuration: Configuration = None):
+        super().__init__()
+
+        stripe_api = StripeAPI(secret_key=secret_key)
+
+        filtered_tools = [
+            tool for tool in tools if is_tool_allowed(tool, configuration)
+        ]
+
+        self._tools = [
+            StripeTool(
+                name=tool["name"],
+                description=tool["description"],
+                method=tool["method"],
+                stripe_api=stripe_api,
+                args_schema=tool.get("args_schema", None),
+            )
+            for tool in filtered_tools
+        ]
+
+    def get_tools(self) -> List:
+        """Get the tools in the toolkit."""
+        return self._tools

stripe_agent_toolkit-0.1.16/stripe_agent_toolkit/functions.py

@@ -0,0 +1,181 @@
+import stripe
+
+
+def create_customer(name: str, email: str = None):
+    """
+    Create a customer.
+
+    Parameters:
+        name (str): The name of the customer.
+        email (str, optional): The email address of the customer.
+
+    Returns:
+        stripe.Customer: The created customer.
+    """
+    customer = stripe.Customer.create(name=name, email=email)
+    return {"id": customer.id}
+
+
+def list_customers(email: str = None, limit: int = None):
+    """
+    List Customers.
+
+    Parameters:
+        email (str, optional): The email address of the customer.
+        limit (int, optional): The number of customers to return.
+
+    Returns:
+        stripe.ListObject: A list of customers.
+    """
+    customers = stripe.Customer.list(email=email, limit=limit)
+    return [{"id": customer.id} for customer in customers.data]
+
+
+def create_product(name: str, description: str = None):
+    """
+    Create a product.
+
+    Parameters:
+        name (str): The name of the product.
+        description (str, optional): The description of the product.
+
+    Returns:
+        stripe.Product: The created product.
+    """
+    return stripe.Product.create(name=name, description=description)
+
+
+def list_products(limit: int = None):
+    """
+    List Products.
+    Parameters:
+        limit (int, optional): The number of products to return.
+
+    Returns:
+        stripe.ListObject: A list of products.
+    """
+    return stripe.Product.list(limit=limit).data
+
+
+def create_price(product: str, currency: str, unit_amount: int):
+    """
+    Create a price.
+
+    Parameters:
+        product (str): The ID of the product.
+        currency (str): The currency of the price.
+        unit_amount (int): The unit amount of the price.
+
+    Returns:
+        stripe.Price: The created price.
+    """
+    return stripe.Price.create(
+        product=product, currency=currency, unit_amount=unit_amount
+    )
+
+
+def list_prices(product: str = None, limit: int = None):
+    """
+    List Prices.
+
+    Parameters:
+        product (str, optional): The ID of the product to list prices for.
+        limit (int, optional): The number of prices to return.
+
+    Returns:
+        stripe.ListObject: A list of prices.
+    """
+    return stripe.Price.list(product=product, limit=limit).data
+
+
+def create_payment_link(price: str, quantity: int):
+    """
+    Create a payment link.
+
+    Parameters:
+        price (str): The ID of the price.
+        quantity (int): The quantity of the product.
+
+    Returns:
+        stripe.PaymentLink: The created payment link.
+    """
+    payment_link = stripe.PaymentLink.create(
+        line_items=[{"price": price, "quantity": quantity}]
+    )
+    return {"id": payment_link.id, "url": payment_link.url}
+
+
+def create_invoice(customer: str, days_until_due: int = 30):
+    """
+    Create an invoice.
+
+    Parameters:
+        customer (str): The ID of the customer.
+        days_until_due (int, optional): The number of days until the
+        invoice is due.
+
+    Returns:
+        stripe.Invoice: The created invoice.
+    """
+    invoice = stripe.Invoice.create(
+        customer=customer,
+        collection_method="send_invoice",
+        days_until_due=days_until_due,
+    )
+
+    return {
+        "id": invoice.id,
+        "hosted_invoice_url": invoice.hosted_invoice_url,
+        "customer": invoice.customer,
+        "status": invoice.status,
+    }
+
+
+def create_invoice_item(customer: str, price: str, invoice: str):
+    """
+    Create an invoice item.
+
+    Parameters:
+        customer (str): The ID of the customer.
+        price (str): The ID of the price.
+        invoice (str): The ID of the invoice.
+
+    Returns:
+        stripe.InvoiceItem: The created invoice item.
+    """
+    invoice_item = stripe.InvoiceItem.create(
+        customer=customer,
+        price=price,
+        invoice=invoice,
+    )
+    return {"id": invoice_item.id, "invoice": invoice_item.invoice}
+
+
+def finalize_invoice(invoice: str):
+    """
+    Finalize an invoice.
+
+    Parameters:
+        invoice (str): The ID of the invoice.
+
+    Returns:
+        stripe.Invoice: The finalized invoice.
+    """
+    invoice = stripe.Invoice.finalize_invoice(invoice=invoice)
+
+    return {
+        "id": invoice.id,
+        "hosted_invoice_url": invoice.hosted_invoice_url,
+        "customer": invoice.customer,
+        "status": invoice.status,
+    }
+
+
+def retrieve_balance():
+    """
+    Retrieve the balance.
+
+    Returns:
+        stripe.Balance: The balance.
+    """
+    return stripe.Balance.retrieve()

stripe_agent_toolkit-0.1.16/stripe_agent_toolkit/langchain/tool.py

@@ -0,0 +1,30 @@
+"""
+This tool allows agents to interact with the Stripe API.
+"""
+
+from __future__ import annotations
+
+from typing import Any, Optional, Type
+from pydantic import BaseModel
+
+from langchain.tools import BaseTool
+
+from ..api import StripeAPI
+
+
+class StripeTool(BaseTool):
+    """Tool for interacting with the Stripe API."""
+
+    stripe_api: StripeAPI
+    method: str
+    name: str = ""
+    description: str = ""
+    args_schema: Optional[Type[BaseModel]] = None
+
+    def _run(
+        self,
+        *args: Any,
+        **kwargs: Any,
+    ) -> str:
+        """Use the Stripe API to run an operation."""
+        return self.stripe_api.run(self.method, *args, **kwargs)

stripe_agent_toolkit-0.1.16/stripe_agent_toolkit/langchain/toolkit.py

@@ -0,0 +1,37 @@
+"""Stripe Agent Toolkit."""
+
+from typing import List
+from pydantic import PrivateAttr
+
+from ..api import StripeAPI
+from ..tools import tools
+from ..configuration import Configuration, is_tool_allowed
+from .tool import StripeTool
+
+
+class StripeAgentToolkit:
+    _tools: List = PrivateAttr(default=[])
+
+    def __init__(self, secret_key: str, configuration: Configuration = None):
+        super().__init__()
+
+        stripe_api = StripeAPI(secret_key=secret_key)
+
+        filtered_tools = [
+            tool for tool in tools if is_tool_allowed(tool, configuration)
+        ]
+
+        self._tools = [
+            StripeTool(
+                name=tool["name"],
+                description=tool["description"],
+                method=tool["method"],
+                stripe_api=stripe_api,
+                args_schema=tool.get("args_schema", None),
+            )
+            for tool in filtered_tools
+        ]
+
+    def get_tools(self) -> List:
+        """Get the tools in the toolkit."""
+        return self._tools