bondable 0.1.4

Bond AI is and SDK and UI for working with agents built using the OpenAI Assistants API

Bond AI

Bond AI leverages OpenAI's Assistant APi to help develop Generative AI agents and chatbots with access to your own tools, APIs and data sources. Bond AI also has a web UI with a built-in chat interface and is extensible to other interfaces with access to these agents.

Features

• Simple definition of agents with tools and data
• Automatic discovery of agents
• Built-in threads, tool access and data integration from the Assistants API
• Google authentication support
• Thread sharing between users
• Modular design with agents, threads, and pages

Getting Started

Prerequisites

• Python 3.13
• Poetry

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/bond-ai.git
   cd bond-ai
   

2. Install dependencies using Poetry:

   poetry config virtualenvs.in-project true
   
   poetry install
   
   poetry build
   
   poetry shell
   
   source $(poetry env info --path)/bin/activate
   

3. Set up environment variables:

   Create a .env file in the project root directory and add the following variables:

   OPENAI_API_KEY=your_openai_api_key
   OPENAI_PROJECT=you_openai_project_id
   OPENAI_DEPLOYMENT=openai_model #(e.g. "gpt-4o-mini")
   
   # or
   # AZURE_OPENAI_API_KEY=your_azure_openai_api_key
   # AZURE_OPENAI_ENDPOINT=your_azure_openai_endpoint
   # AZURE_OPENAI_API_VERSION=api_version (e.g. 2024-08-01-preview)
   
   AUTH_ENABLED=True
   GOOGLE_AUTH_CREDS_PATH=path_to_your_google_auth_creds.json
   GOOGLE_AUTH_REDIRECT_URI=your_redirect_uri_for_this_app
   
   METADATA_DB_URL=database_url_for_metadata #(e.g. sqlite:///.metadata.db)
   

Running the Application

To start the application, run the following command:

python -m bond_ai.app.start --server.port=8080 --server.address=0.0.0.0

Running Tests

To run the tests, use the following command:

poetry run pytest

This will execute all the tests in the tests directory and provide a summary of the results.

The primary source code is located in the bond_ai directory, and the test code is in the tests directory. This project uses Poetry for dependency management and setup.

Contributing

We welcome contributions to the Bond AI project! To contribute, please follow these steps:

1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine:

git clone https://github.com/yourusername/bond-ai.git
cd bond-ai

3. Create a new branch for your feature or bugfix:

git checkout -b your-feature-branch

4. Make your changes and commit them with a descriptive message:

git add .
git commit -m "Description of your changes"

5. Push your changes to your forked repository:

git push origin your-feature-branch

6. Open a pull request on the original repository and describe your changes in detail.

Thank you for contributing!