Metadata-Version: 2.4
Name: traceroot
Version: 0.0.1
Summary: A clean, principled wrapper around OpenTelemetry, AWS CloudWatch, and AWS X-Ray for enhanced debugging experience
Home-page: https://github.com/traceroot-ai/traceroot-sdk
Author: TraceRoot Team
Author-email: 
Project-URL: Bug Reports, https://github.com/traceroot-ai/traceroot-sdk/issues
Project-URL: Source, https://github.com/traceroot-ai/traceroot-sdk
Project-URL: Documentation, https://docs.traceroot.ai
Keywords: opentelemetry aws cloudwatch xray tracing logging debugging
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Logging
Classifier: Topic :: System :: Monitoring
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: opentelemetry-api==1.34.1
Requires-Dist: opentelemetry-sdk==1.34.1
Requires-Dist: opentelemetry-exporter-otlp==1.34.1
Requires-Dist: opentelemetry-exporter-otlp-proto-common==1.34.1
Requires-Dist: opentelemetry-exporter-otlp-proto-grpc==1.34.1
Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.34.1
Requires-Dist: opentelemetry-instrumentation==0.55b1
Requires-Dist: opentelemetry-instrumentation-asgi==0.55b1
Requires-Dist: opentelemetry-instrumentation-fastapi==0.55b1
Requires-Dist: opentelemetry-proto==1.34.1
Requires-Dist: opentelemetry-sdk-extension-aws==2.1.0
Requires-Dist: opentelemetry-propagator-aws-xray==1.0.2
Requires-Dist: opentelemetry-semantic-conventions==0.55b1
Requires-Dist: opentelemetry-util-http==0.55b1
Requires-Dist: watchtower==3.4.0
Requires-Dist: pandas==2.3.0
Requires-Dist: PyYAML==6.0.2
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Provides-Extra: fastapi
Requires-Dist: fastapi==0.115.12; extra == "fastapi"
Requires-Dist: uvicorn==0.34.3; extra == "fastapi"
Requires-Dist: pre-commit==4.2.0; extra == "fastapi"
Requires-Dist: pytest==8.4.0; extra == "fastapi"
Requires-Dist: httpx==0.27.0; extra == "fastapi"
Requires-Dist: numpy; extra == "fastapi"
Requires-Dist: opentelemetry-instrumentation-fastapi==0.55b1; extra == "fastapi"
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Traceroot SDK

Traceroot SDK is a clean, principled wrapper around OpenTelemetry, AWS CloudWatch, and AWS X-Ray for enhanced debugging experience. It provides smart logging and tracing for AWS-based applications with minimal setup.

## Quick Start

### Installation

```bash
python3 -m venv venv
source venv/bin/activate
pip install -e ".[dev,fastapi]"
```

### Prerequisite
For the Traceroot SDK to work with your application, we need to set up the
following environment variable
```
export AWS_ACCESS_KEY_ID='your_access_key'
export AWS_SECRET_ACCESS_KEY='your_secret_key'
export AWS_REGION='your_region'
```
and run `traceroot.init(...)` in the beginning, where we need to set up
the following environment variable
```
- name
- aws_region
- otlp_endpoint
```

Notice that the `name` is the name of the user who is using the Traceroot SDK.

Please reachout to founders@traceroot.ai if you do not have these credentials
yet.

### Running examples
```bash
python tests/test_e2e_complex.py
```
