# Installation

<img width="618" alt="Main" src="https://github.com/user-attachments/assets/dbbf5a4f-7b0b-4f43-9b37-ef77dc761ff1" />

This guide explains how to install the `tbh_secure_agents` package.

## Prerequisites

*   **Python:** Ensure you have Python installed (version 3.8 or higher is recommended). You can download it from [python.org](https://www.python.org/).
*   **pip:** The Python package installer (`pip`) is usually included with Python installations. Ensure it's up-to-date:
    ```bash
    python -m pip install --upgrade pip
    ```

## Installation from PyPI (Recommended)

The package is published to the Python Package Index (PyPI) and can be installed directly using pip:

```bash
pip install tbh-secure-agents
```

Note that the package name uses hyphens (`tbh-secure-agents`) rather than underscores when installing with pip.

This is a closed-source package with proprietary security implementations. The installation provides you with the necessary interfaces to build secure multi-agent systems without exposing the internal security mechanisms.

## Source Code Access

This package is distributed as a closed-source solution to protect the proprietary security mechanisms and intellectual property. The source code is not publicly available for direct installation or modification.

If you're interested in contributing to the project or need access to the source code for specific use cases, please contact the maintainers at saish.shinde.jb@gmail.com for more information about partnership opportunities.

## Verifying Installation

After installation, you can verify it by trying to import the package in a Python interpreter:

```python
import tbh_secure_agents
print(tbh_secure_agents.__version__)
```

If this runs without errors and prints the version number, the installation was successful.

## API Key Configuration

`tbh_secure_agents` uses Google Gemini as its default LLM, which requires an API key.

*   **Recommended Method:** Set the `GOOGLE_API_KEY` environment variable before running your application. The library will automatically detect and use it.
    *   **Linux/macOS:** `export GOOGLE_API_KEY='YOUR_API_KEY'`
    *   **Windows CMD:** `set GOOGLE_API_KEY=YOUR_API_KEY`
    *   **Windows PowerShell:** `$env:GOOGLE_API_KEY='YOUR_API_KEY'`
*   **Alternative (Testing Only):** You can pass the key directly via the `api_key` parameter during `Agent` initialization, but **this is insecure and not recommended for production code.**
