toolhouse


Nametoolhouse JSON
Version 1.3.1 PyPI version JSON
download
home_pageNone
SummaryThe official Python SDK for the Toolhouse API
upload_time2024-12-23 22:50:43
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
license Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2024 Toolhouse Technologies, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
keywords ai llm sdk toolhouse
VCS
bugtrack_url
requirements requests http-exceptions pytest responses
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![Banner](repository-assets/Banner.png)

# Toolhouse Python SDK

Welcome to the [Toolhouse Python SDK](https://docs.toolhouse.ai/toolhouse/quick-start-python) documentation. This guide will help you get started with integrating and using the SDK in your project.

Toolhouse allows you to unlock the best LLM knowledge and actions. It works across a wide ranges or LLMs and providers.

With Toolhouse, you can install tools from the [Tool Store](https://app.toolhouse.ai/store) and execute them in the cloud, without the need to handling their execution locally.

For more details, you can check out our [documentation](https://docs.toolhouse.ai).

![Tool Use](repository-assets/1.png)

## Table of Contents

- [Toolhouse Python SDK](#toolhouse-python-sdk)
  - [Table of Contents](#table-of-contents)
  - [About the API](#about-the-api)
  - [Installation](#installation)
    - [Getting started](#getting-started)
    - [Providers](#providers)
  - [Sample usage](#sample-usage)
  - [Use Local Tools](#use-local-tools)
  - [Use Bundles](#use-bundles)
  - [Contributing](#contributing)
  - [Publishing tools](#publishing-tools)
  - [License](#license)

## About the API

The Toolhouse API provides access to various AI-powered tools and services, that you can install from the [Tool Store](https://app.toolhouse.ai/store).

## Installation

With `pip`:

```pip install toolhouse```

With `poetry`:

```poetry add toolhouse```

### Getting started

In order to use the SDK, you will need a Toolhouse API key. To get the API key:

1. [Sign up for Toolhouse](https://app.toolhouse.ai/auth/sign-up) or [log in](https://app.toolhouse.ai/auth/login) if you are an existing Toolhouse user.
1. Go to your user ➡️ API Keys ([direct link](https://app.toolhouse.ai/settings/api-keys))
1. Give your API key a name and click Generate.

Copy the API Key and save it where you save your secrets. We'll assume you have a .env file.

We suggest saving your API Key as `TOOLHOUSE_API_KEY` in your environment file. This allows Toolhouse to pick up its value directly in your code.

```bash
TOOLHOUSE_API_KEY=<Your API Key value>
```

Alternatively, you can set the API key when you initialize the SDK. You can do this in the constructor:

```py
tools = Toolhouse('YOUR_API_KEY')
```

You can also use the `set_api_key` method:

```py
tools = Toolhouse()
tools.set_api_key('YOUR_API_KEY')
```

Our [Quick start guide](https://docs.toolhouse.ai/toolhouse/quick-start) has all you need to get you set up quickly.

### Providers

Toolhouse works with the widest possible range of LLMs across different providers. By default, the Toolhouse API will work with any LLM that is compatible with the OpenAI chat completions API.

You can switch providers when initializing the SDK through the constructor:

```py
from toolhouse import Toolhouse, Provider
tools = Toolhouse(provider=provider.ANTHROPIC)
```

If you are passing your API key:

```py
from toolhouse import Toolhouse, Provider
tools = Toolhouse('YOUR_API_KEY', provider.ANTHROPIC)
```

## Sample usage

In this example, we'll use the OpenAI SDK as well as dotenv.

```sh
pip install python-dotenv
```

Create a `.env` and add your API keys there.

```bash
TOOLHOUSE_API_KEY=
OPENAI_API_KEY=
```

Head over to Toolhouse and install the [Current time tool](https://app.toolhouse.ai/store/current_time).

```py
import os
from dotenv import load_dotenv
from toolhouse import Toolhouse
from openai import OpenAI
from typing import List

load_dotenv()

TH_API_KEY = os.getenv("TOOLHOUSE_API_KEY")
OAI_KEY = os.getenv("OPENAI_API_KEY")

client = OpenAI(api_key=OAI_KEY)
th = Toolhouse(api_key=TH_API_KEY, provider="openai")

#Metadata to convert UTC time to your localtime
th.set_metadata("timezone", -7)

messages: List = [{
    "role": "user",
    "content": "What's the current time?"
}]

response = client.chat.completions.create(
    model='gpt-4o',
    messages=messages,
    tools=th.get_tools(),
    tool_choice="auto"
)

messages += th.run_tools(response)

response = client.chat.completions.create(
            model="gpt-4o-mini",
            messages=messages,
            tools=th.get_tools(),
            tool_choice="auto"
        )
print(response.choices[0].message.content)
```

## Use Local Tools

To utilize a local tool, you need to define the tool, its JSON schema, and register it with the Toolhouse SDK. Here's a step-by-step guide:

1. Create the local tool function.
2. Define the JSON schema for the local tool function.
3. Register the local tool with the Toolhouse SDK.
4. Add the local tool to the messages.
5. Utilize the local tool within the Toolhouse SDK.

Here is a sample code:

```py
"""OpenAI Sample"""
import os
from typing import List
from dotenv import load_dotenv
from openai import OpenAI
from toolhouse import Toolhouse

#  Make sure to set up the .env file according to the .env.example file.
load_dotenv()

TH_API_KEY = os.getenv("TOOLHOUSE_API_KEY")
OAI_KEY = os.getenv("OPENAI_API_KEY")

local_tools = [
    {'type': 'function',
     'function':
         {
             'name': 'hello',
             'description': 'The user receives a customized hello message from a city and returns it to the user.', 
             'parameters': {
                 'type': 'object',
                 'properties': {
                     'city': {'type': 'string', 'description': 'The city where you are from'}
                 }},
             'required': ['city']
         }}]

th = Toolhouse(api_key=TH_API_KEY, provider="openai")
th.set_metadata("id", "fabio")
th.set_metadata("timezone", 5)


@th.register_local_tool("hello")  # the name used to register the tool should be the same as the name in the json schema
def hello_tool(city: str):
    """Return a Hello message from a specific city."""
    return f"Hello from {city}!!!"


client = OpenAI(api_key=OAI_KEY)

messages: List = [{
    "role": "user",
    "content":
        "Can I get a hello from Rome?"
    }]

response = client.chat.completions.create(
    model='gpt-4o',
    messages=messages,
    tools=th.get_tools() + local_tools
)

messages += th.run_tools(response)

response = client.chat.completions.create(
            model="gpt-4o",
            messages=messages,
            tools=th.get_tools() + local_tools
        )

print(response.choices[0].message.content)
```

## Use Bundles

Bundles help you define groups of tools you want to pass to the LLM based on specific contextual need.

For example, if you want to enhance your LLM's knowledge with live stock market data, you can create a Bundle with a stock price API call, a RAG for stock news, and summarization of SEC filings.
In order to create a bundle, you need to:

1. Go to the [Tool Store - Bundles](https://app.toolhouse.ai/bundles) and create a new bundle. eg: "stock_bundle"
2. Add tools to the bundle.
3. Use the bundle in the Toolhouse SDK.

Here is a sample code:

```py
import os
from typing import List
from dotenv import load_dotenv
from openai import OpenAI
from toolhouse import Toolhouse

#  Make sure to set up the .env file according to the .env.example file.
load_dotenv()

th = Toolhouse(api_key=TH_API_KEY, provider="openai")
th.set_metadata("id", "fabio")  # metadata is optional based on the tools you are using
th.set_metadata("timezone", 5)  # metadata is optional based on the tools you are using

client = OpenAI(api_key=OAI_KEY)

messages: List = [{
    "role": "user",
    "content": "What is the stock price of Apple?"
    }]

response = client.chat.completions.create(
    model='gpt-4o',
    messages=messages,
    tools=th.get_tools(bundle="stock_bundle")
)
```

## Contributing

We welcome pull requests that add meaningful additions to these code samples, particularly for issues that can expand compability.

You can submit issues (for example for feature requests or improvements) by using the Issues tab.

## Publishing tools

Developers can also contribute to Toolhouse by publishing tools for the [Tool Store](https://app.toolhouse.ai/store). The Tool Store allows developers to submit their tools and monetize them every time they're executed. Developers and tools must go through an review and approval process, which includes adhering to the Toolhouse Privacy and Data Protection policy. If you're interested in becoming a publisher, [submit your application](https://tally.so/r/wzeO68).

## License

This SDK is licensed under the Apache-2.0 License. See the [LICENSE](LICENSE) file for more details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "toolhouse",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Toolhouse Technologies <hello@toolhouse.ai>",
    "keywords": "ai, llm, sdk, toolhouse",
    "author": null,
    "author_email": "Toolhouse Technologies <hello@toolhouse.ai>",
    "download_url": "https://files.pythonhosted.org/packages/d4/be/c3692101c5fb6f926f4bf6d9bbd643f1e85063148dbfc2b17edfd93bc798/toolhouse-1.3.1.tar.gz",
    "platform": null,
    "description": "![Banner](repository-assets/Banner.png)\n\n# Toolhouse Python SDK\n\nWelcome to the [Toolhouse Python SDK](https://docs.toolhouse.ai/toolhouse/quick-start-python) documentation. This guide will help you get started with integrating and using the SDK in your project.\n\nToolhouse allows you to unlock the best LLM knowledge and actions. It works across a wide ranges or LLMs and providers.\n\nWith Toolhouse, you can install tools from the [Tool Store](https://app.toolhouse.ai/store) and execute them in the cloud, without the need to handling their execution locally.\n\nFor more details, you can check out our [documentation](https://docs.toolhouse.ai).\n\n![Tool Use](repository-assets/1.png)\n\n## Table of Contents\n\n- [Toolhouse Python SDK](#toolhouse-python-sdk)\n  - [Table of Contents](#table-of-contents)\n  - [About the API](#about-the-api)\n  - [Installation](#installation)\n    - [Getting started](#getting-started)\n    - [Providers](#providers)\n  - [Sample usage](#sample-usage)\n  - [Use Local Tools](#use-local-tools)\n  - [Use Bundles](#use-bundles)\n  - [Contributing](#contributing)\n  - [Publishing tools](#publishing-tools)\n  - [License](#license)\n\n## About the API\n\nThe Toolhouse API provides access to various AI-powered tools and services, that you can install from the [Tool Store](https://app.toolhouse.ai/store).\n\n## Installation\n\nWith `pip`:\n\n```pip install toolhouse```\n\nWith `poetry`:\n\n```poetry add toolhouse```\n\n### Getting started\n\nIn order to use the SDK, you will need a Toolhouse API key. To get the API key:\n\n1. [Sign up for Toolhouse](https://app.toolhouse.ai/auth/sign-up) or [log in](https://app.toolhouse.ai/auth/login) if you are an existing Toolhouse user.\n1. Go to your user \u27a1\ufe0f API Keys ([direct link](https://app.toolhouse.ai/settings/api-keys))\n1. Give your API key a name and click Generate.\n\nCopy the API Key and save it where you save your secrets. We'll assume you have a .env file.\n\nWe suggest saving your API Key as `TOOLHOUSE_API_KEY` in your environment file. This allows Toolhouse to pick up its value directly in your code.\n\n```bash\nTOOLHOUSE_API_KEY=<Your API Key value>\n```\n\nAlternatively, you can set the API key when you initialize the SDK. You can do this in the constructor:\n\n```py\ntools = Toolhouse('YOUR_API_KEY')\n```\n\nYou can also use the `set_api_key` method:\n\n```py\ntools = Toolhouse()\ntools.set_api_key('YOUR_API_KEY')\n```\n\nOur [Quick start guide](https://docs.toolhouse.ai/toolhouse/quick-start) has all you need to get you set up quickly.\n\n### Providers\n\nToolhouse works with the widest possible range of LLMs across different providers. By default, the Toolhouse API will work with any LLM that is compatible with the OpenAI chat completions API.\n\nYou can switch providers when initializing the SDK through the constructor:\n\n```py\nfrom toolhouse import Toolhouse, Provider\ntools = Toolhouse(provider=provider.ANTHROPIC)\n```\n\nIf you are passing your API key:\n\n```py\nfrom toolhouse import Toolhouse, Provider\ntools = Toolhouse('YOUR_API_KEY', provider.ANTHROPIC)\n```\n\n## Sample usage\n\nIn this example, we'll use the OpenAI SDK as well as dotenv.\n\n```sh\npip install python-dotenv\n```\n\nCreate a `.env` and add your API keys there.\n\n```bash\nTOOLHOUSE_API_KEY=\nOPENAI_API_KEY=\n```\n\nHead over to Toolhouse and install the [Current time tool](https://app.toolhouse.ai/store/current_time).\n\n```py\nimport os\nfrom dotenv import load_dotenv\nfrom toolhouse import Toolhouse\nfrom openai import OpenAI\nfrom typing import List\n\nload_dotenv()\n\nTH_API_KEY = os.getenv(\"TOOLHOUSE_API_KEY\")\nOAI_KEY = os.getenv(\"OPENAI_API_KEY\")\n\nclient = OpenAI(api_key=OAI_KEY)\nth = Toolhouse(api_key=TH_API_KEY, provider=\"openai\")\n\n#Metadata to convert UTC time to your localtime\nth.set_metadata(\"timezone\", -7)\n\nmessages: List = [{\n    \"role\": \"user\",\n    \"content\": \"What's the current time?\"\n}]\n\nresponse = client.chat.completions.create(\n    model='gpt-4o',\n    messages=messages,\n    tools=th.get_tools(),\n    tool_choice=\"auto\"\n)\n\nmessages += th.run_tools(response)\n\nresponse = client.chat.completions.create(\n            model=\"gpt-4o-mini\",\n            messages=messages,\n            tools=th.get_tools(),\n            tool_choice=\"auto\"\n        )\nprint(response.choices[0].message.content)\n```\n\n## Use Local Tools\n\nTo utilize a local tool, you need to define the tool, its JSON schema, and register it with the Toolhouse SDK. Here's a step-by-step guide:\n\n1. Create the local tool function.\n2. Define the JSON schema for the local tool function.\n3. Register the local tool with the Toolhouse SDK.\n4. Add the local tool to the messages.\n5. Utilize the local tool within the Toolhouse SDK.\n\nHere is a sample code:\n\n```py\n\"\"\"OpenAI Sample\"\"\"\nimport os\nfrom typing import List\nfrom dotenv import load_dotenv\nfrom openai import OpenAI\nfrom toolhouse import Toolhouse\n\n#  Make sure to set up the .env file according to the .env.example file.\nload_dotenv()\n\nTH_API_KEY = os.getenv(\"TOOLHOUSE_API_KEY\")\nOAI_KEY = os.getenv(\"OPENAI_API_KEY\")\n\nlocal_tools = [\n    {'type': 'function',\n     'function':\n         {\n             'name': 'hello',\n             'description': 'The user receives a customized hello message from a city and returns it to the user.', \n             'parameters': {\n                 'type': 'object',\n                 'properties': {\n                     'city': {'type': 'string', 'description': 'The city where you are from'}\n                 }},\n             'required': ['city']\n         }}]\n\nth = Toolhouse(api_key=TH_API_KEY, provider=\"openai\")\nth.set_metadata(\"id\", \"fabio\")\nth.set_metadata(\"timezone\", 5)\n\n\n@th.register_local_tool(\"hello\")  # the name used to register the tool should be the same as the name in the json schema\ndef hello_tool(city: str):\n    \"\"\"Return a Hello message from a specific city.\"\"\"\n    return f\"Hello from {city}!!!\"\n\n\nclient = OpenAI(api_key=OAI_KEY)\n\nmessages: List = [{\n    \"role\": \"user\",\n    \"content\":\n        \"Can I get a hello from Rome?\"\n    }]\n\nresponse = client.chat.completions.create(\n    model='gpt-4o',\n    messages=messages,\n    tools=th.get_tools() + local_tools\n)\n\nmessages += th.run_tools(response)\n\nresponse = client.chat.completions.create(\n            model=\"gpt-4o\",\n            messages=messages,\n            tools=th.get_tools() + local_tools\n        )\n\nprint(response.choices[0].message.content)\n```\n\n## Use Bundles\n\nBundles help you define groups of tools you want to pass to the LLM based on specific contextual need.\n\nFor example, if you want to enhance your LLM's knowledge with live stock market data, you can create a Bundle with a stock price API call, a RAG for stock news, and summarization of SEC filings.\nIn order to create a bundle, you need to:\n\n1. Go to the [Tool Store - Bundles](https://app.toolhouse.ai/bundles) and create a new bundle. eg: \"stock_bundle\"\n2. Add tools to the bundle.\n3. Use the bundle in the Toolhouse SDK.\n\nHere is a sample code:\n\n```py\nimport os\nfrom typing import List\nfrom dotenv import load_dotenv\nfrom openai import OpenAI\nfrom toolhouse import Toolhouse\n\n#  Make sure to set up the .env file according to the .env.example file.\nload_dotenv()\n\nth = Toolhouse(api_key=TH_API_KEY, provider=\"openai\")\nth.set_metadata(\"id\", \"fabio\")  # metadata is optional based on the tools you are using\nth.set_metadata(\"timezone\", 5)  # metadata is optional based on the tools you are using\n\nclient = OpenAI(api_key=OAI_KEY)\n\nmessages: List = [{\n    \"role\": \"user\",\n    \"content\": \"What is the stock price of Apple?\"\n    }]\n\nresponse = client.chat.completions.create(\n    model='gpt-4o',\n    messages=messages,\n    tools=th.get_tools(bundle=\"stock_bundle\")\n)\n```\n\n## Contributing\n\nWe welcome pull requests that add meaningful additions to these code samples, particularly for issues that can expand compability.\n\nYou can submit issues (for example for feature requests or improvements) by using the Issues tab.\n\n## Publishing tools\n\nDevelopers can also contribute to Toolhouse by publishing tools for the [Tool Store](https://app.toolhouse.ai/store). The Tool Store allows developers to submit their tools and monetize them every time they're executed. Developers and tools must go through an review and approval process, which includes adhering to the Toolhouse Privacy and Data Protection policy. If you're interested in becoming a publisher, [submit your application](https://tally.so/r/wzeO68).\n\n## License\n\nThis SDK is licensed under the Apache-2.0 License. See the [LICENSE](LICENSE) file for more details.\n",
    "bugtrack_url": null,
    "license": " Apache License Version 2.0, January 2004 http://www.apache.org/licenses/  TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION  1. Definitions.  \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.  \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.  \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.  \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License.  \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.  \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.  \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).  \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.  \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\"  \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.  2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.  3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.  4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:  (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and  (b) You must cause any modified files to carry prominent notices stating that You changed the files; and  (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and  (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.  You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.  5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.  6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.  7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.  8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.  9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.  END OF TERMS AND CONDITIONS  APPENDIX: How to apply the Apache License to your work.  To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives.  Copyright 2024 Toolhouse Technologies, Inc.  Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.",
    "summary": "The official Python SDK for the Toolhouse API",
    "version": "1.3.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/toolhouseai/toolhouse-sdk-python/issues",
        "Documentation": "https://docs.toolhouse.ai",
        "Homepage": "https://toolhouse.ai",
        "Release Notes": "https://github.com/toolhouseai/toolhouse-sdk-python/releases",
        "Repository": "https://github.com/toolhouseai/toolhouse-sdk-python"
    },
    "split_keywords": [
        "ai",
        " llm",
        " sdk",
        " toolhouse"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "249a7fb55e515a6d36a75998908a48a9e6f184e0a11953a580eefc10dd28d2e4",
                "md5": "64dcc7a04bd3b27019d432d12757bc31",
                "sha256": "469ad48f4dbfb5f1653ba04c5ae7a10a1acf95ddb6deb8cad232bdfdce9d79c3"
            },
            "downloads": -1,
            "filename": "toolhouse-1.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "64dcc7a04bd3b27019d432d12757bc31",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 43181,
            "upload_time": "2024-12-23T22:50:42",
            "upload_time_iso_8601": "2024-12-23T22:50:42.314974Z",
            "url": "https://files.pythonhosted.org/packages/24/9a/7fb55e515a6d36a75998908a48a9e6f184e0a11953a580eefc10dd28d2e4/toolhouse-1.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d4bec3692101c5fb6f926f4bf6d9bbd643f1e85063148dbfc2b17edfd93bc798",
                "md5": "e93a69ef2deecaf5a28031f75b25c3b3",
                "sha256": "f9d3b582a1bd2810b9abc49246f8a97d6147c07f6b2f4895eab4f9ddfbc3de65"
            },
            "downloads": -1,
            "filename": "toolhouse-1.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "e93a69ef2deecaf5a28031f75b25c3b3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 299949,
            "upload_time": "2024-12-23T22:50:43",
            "upload_time_iso_8601": "2024-12-23T22:50:43.668062Z",
            "url": "https://files.pythonhosted.org/packages/d4/be/c3692101c5fb6f926f4bf6d9bbd643f1e85063148dbfc2b17edfd93bc798/toolhouse-1.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-23 22:50:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "toolhouseai",
    "github_project": "toolhouse-sdk-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "requests",
            "specs": []
        },
        {
            "name": "http-exceptions",
            "specs": []
        },
        {
            "name": "pytest",
            "specs": []
        },
        {
            "name": "responses",
            "specs": []
        }
    ],
    "lcname": "toolhouse"
}
        
Elapsed time: 1.27111s