Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
#MAINTAINERS Following is the current list of maintainers on this project
# Maintainers

The maintainers are listed in alphabetical order.
This file lists the maintainers of the Botanu SDK Python project.

[@deborahjacob-botanu] https://github.com/deborahjacob-botanu (Deborah Jacob)
## Current Maintainers

The maintainers are listed in alphabetical order by GitHub handle.

| Name | GitHub | Role |
|------|--------|------|
| Deborah Jacob | [@deborahjacob-botanu](https://github.com/deborahjacob-botanu) | Lead Maintainer |

## Becoming a Maintainer

Maintainers are contributors who have demonstrated:

- Sustained contributions to the project
- Deep understanding of the codebase
- Commitment to the project's goals and community

If you're interested in becoming a maintainer, start by making regular contributions and engaging with the community.

## Maintainer Responsibilities

- Review and merge pull requests
- Triage issues
- Participate in project planning
- Uphold the Code of Conduct
- Help onboard new contributors
31 changes: 29 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,35 @@

## Supported Versions

Please upgrade to latest stable version of Botanu which will have know security issues addressed.
| Version | Supported |
| ------- | ------------------ |
| 0.1.x | :white_check_mark: |

Please upgrade to the latest stable version of Botanu which will have known security issues addressed.

## Reporting a Vulnerability

Please report security vulnerabilities privately to the Botanu [maintainer team] (https://github.com/monocle2ai/monocle/blob/main/MAINTAINER.md). Please do not post security vulnerabilities to the public issue tracker.
The Botanu team takes security vulnerabilities seriously. We appreciate your efforts to responsibly disclose your findings.

### How to Report

To report a security vulnerability, please use one of the following methods:

1. **GitHub Security Advisories** (Preferred): Use the [Security tab](https://github.com/botanu-ai/botanu-sdk-python/security/advisories/new) to privately report a vulnerability.

2. **Email**: Contact the [maintainer team](https://github.com/botanu-ai/botanu-sdk-python/blob/main/MAINTAINERS.md)

Please do **not** post security vulnerabilities to the public issue tracker.

### What to Include

- Type of vulnerability
- Full paths of affected source files
- Step-by-step instructions to reproduce the issue
- Impact of the issue and potential attack scenarios

### Response Timeline

- **Initial Response**: Within 48 hours
- **Status Update**: Within 7 days
- **Resolution Target**: Within 90 days (depending on complexity)
55 changes: 55 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Botanu SDK Documentation

Botanu SDK is an OpenTelemetry-native library for run-level cost attribution in AI workflows.

## Quick Start

### Installation

```bash
pip install botanu
```

For full SDK capabilities with OTLP export:

```bash
pip install botanu[sdk]
```

### Basic Usage

```python
from botanu import botanu_use_case
from botanu.tracking.llm import track_llm_call

@botanu_use_case("Customer Support")
def handle_ticket(ticket_id: str):
with track_llm_call(provider="openai", model="gpt-4") as tracker:
response = openai.chat.completions.create(...)
tracker.set_tokens(
input_tokens=response.usage.prompt_tokens,
output_tokens=response.usage.completion_tokens,
)
return response

# Every span within handle_ticket is tagged with botanu.run_id
result = handle_ticket("TICKET-123")
```

## Features

- **Run-level Attribution**: Track costs per business transaction, not just per request
- **OpenTelemetry Native**: Built on OTel standards for maximum interoperability
- **Minimal Overhead**: Lightweight SDK with heavy processing in the collector
- **Multi-provider Support**: Works with OpenAI, Anthropic, Bedrock, Vertex AI, and more

## Documentation

- [Configuration](configuration.md)
- [LLM Tracking](llm-tracking.md)
- [Data Tracking](data-tracking.md)
- [API Reference](api-reference.md)

## License

Apache License 2.0
Loading