<div align="center">
[![Documentation][docs-image]][docs-url]
[![PyPI Version][pypi-image]][pypi-url]
[![TraceRoot.AI Website][company-website-image]][company-website-url]
[![X][company-x-image]][company-x-url]
</div>
# TraceRoot SDK
TraceRoot SDK is a clean and principled package built upon OpenTelemetry with enhanced debugging and tracing experience. It provides smart and cloud-stored logging and tracing with minimal setup and code changes.
## Quick Start
You can follow the [docs](https://docs.traceroot.ai/) here to get more details and have a deeper understanding of the TraceRoot SDK.
### Installation
```bash
python3.11 -m venv venv
source venv/bin/activate
pip install traceroot
# or install the latest version from the source code
pip install -e .
```
### Prerequisite
For the TraceRoot SDK to work with your application, we need to set up some environment variables with some credentials.
Please visit [TraceRoot.AI](https://traceroot.ai) to get the credentials.
You also need to input following information to `traceroot.init(...)` at the beginning of your entry file for your Python program to have a full experience:
```python
traceroot.init(
name="traceroot-ai",
service_name="sdk-example-service",
github_owner="traceroot-ai",
github_repo_name="traceroot-sdk",
github_commit_hash="main"
)
```
Or you can just put them in a yaml file called `.traceroot-config.yaml` in the root of your project:
```yaml
name: "traceroot-ai"
service_name: "sdk-example-service"
github_owner: "traceroot-ai"
github_repo_name: "traceroot-sdk"
github_commit_hash: "main"
```
* Notice that the `name` is the name of the user who is using the TraceRoot SDK.
* `service_name` is the name of the service or program you are going to keep track of.
Please reach out to founders@traceroot.ai or visit [TraceRoot.AI](https://traceroot.ai) if you do not have these credentials or have any questions.
[docs-image]: https://img.shields.io/badge/Documentation-0dbf43
[docs-url]: https://docs.traceroot.ai
[pypi-image]: https://badge.fury.io/py/traceroot.svg
[pypi-url]: https://pypi.python.org/pypi/traceroot
[company-website-image]: https://img.shields.io/badge/TraceRoot.AI-0dbf43
[company-website-url]: https://traceroot.ai
[company-x-url]: https://x.com/TracerootAI
[company-x-image]: https://img.shields.io/twitter/follow/TracerootAI?style=social
## Examples
For an end-to-end example that uses the TraceRoot SDK for a multi-agent system, please refer to the [Multi-agent System with TraceRoot SDK](https://docs.traceroot.ai/essentials/journey).
The source code of the multi-agent system example is available in [`traceroot-examples/examples/multi_agent`](https://github.com/traceroot-ai/traceroot-examples/tree/main/examples/multi_agent).
Raw data
{
"_id": null,
"home_page": null,
"name": "traceroot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "artificial-intelligence, agent-systems, opentelemetry, tracing, logging, debugging",
"author": "TraceRoot Team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/bb/e6/5a7ff00e4844ded949cc3a9afcbc78d5f16bd463182c1c057df612e868d3/traceroot-0.0.3.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n[![Documentation][docs-image]][docs-url]\n[![PyPI Version][pypi-image]][pypi-url]\n[![TraceRoot.AI Website][company-website-image]][company-website-url]\n[![X][company-x-image]][company-x-url]\n\n\n</div>\n\n# TraceRoot SDK\n\nTraceRoot SDK is a clean and principled package built upon OpenTelemetry with enhanced debugging and tracing experience. It provides smart and cloud-stored logging and tracing with minimal setup and code changes.\n\n## Quick Start\n\nYou can follow the [docs](https://docs.traceroot.ai/) here to get more details and have a deeper understanding of the TraceRoot SDK.\n\n### Installation\n\n```bash\npython3.11 -m venv venv\nsource venv/bin/activate\npip install traceroot\n# or install the latest version from the source code\npip install -e .\n```\n\n### Prerequisite\nFor the TraceRoot SDK to work with your application, we need to set up some environment variables with some credentials.\n\nPlease visit [TraceRoot.AI](https://traceroot.ai) to get the credentials.\n\nYou also need to input following information to `traceroot.init(...)` at the beginning of your entry file for your Python program to have a full experience:\n\n```python\ntraceroot.init(\n name=\"traceroot-ai\",\n service_name=\"sdk-example-service\",\n github_owner=\"traceroot-ai\",\n github_repo_name=\"traceroot-sdk\",\n github_commit_hash=\"main\"\n)\n```\n\n\nOr you can just put them in a yaml file called `.traceroot-config.yaml` in the root of your project:\n\n```yaml\nname: \"traceroot-ai\"\nservice_name: \"sdk-example-service\"\ngithub_owner: \"traceroot-ai\"\ngithub_repo_name: \"traceroot-sdk\"\ngithub_commit_hash: \"main\"\n``` \n\n* Notice that the `name` is the name of the user who is using the TraceRoot SDK.\n* `service_name` is the name of the service or program you are going to keep track of.\n\nPlease reach out to founders@traceroot.ai or visit [TraceRoot.AI](https://traceroot.ai) if you do not have these credentials or have any questions.\n\n[docs-image]: https://img.shields.io/badge/Documentation-0dbf43\n[docs-url]: https://docs.traceroot.ai\n[pypi-image]: https://badge.fury.io/py/traceroot.svg\n[pypi-url]: https://pypi.python.org/pypi/traceroot\n[company-website-image]: https://img.shields.io/badge/TraceRoot.AI-0dbf43\n[company-website-url]: https://traceroot.ai\n[company-x-url]: https://x.com/TracerootAI\n[company-x-image]: https://img.shields.io/twitter/follow/TracerootAI?style=social\n\n## Examples\n\nFor an end-to-end example that uses the TraceRoot SDK for a multi-agent system, please refer to the [Multi-agent System with TraceRoot SDK](https://docs.traceroot.ai/essentials/journey).\n\nThe source code of the multi-agent system example is available in [`traceroot-examples/examples/multi_agent`](https://github.com/traceroot-ai/traceroot-examples/tree/main/examples/multi_agent).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A clean, principled wrapper around OpenTelemetry, AWS CloudWatch, and AWS X-Ray for enhanced debugging experience",
"version": "0.0.3",
"project_urls": {
"Bug Reports": "https://github.com/traceroot-ai/traceroot-sdk/issues",
"Documentation": "https://docs.traceroot.ai",
"Homepage": "https://traceroot.ai/",
"Repository": "https://github.com/traceroot-ai/traceroot-sdk"
},
"split_keywords": [
"artificial-intelligence",
" agent-systems",
" opentelemetry",
" tracing",
" logging",
" debugging"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "52aab7e327bd9e672284f4a9ca0920c55ae156fc58768017931f048ec43f6b90",
"md5": "22691be08b99f35086716eaeb63ffed0",
"sha256": "e5f2b5aee19c79b681ff6e6ce1747679c8c69f8bb0e664939b2ffb0245a5d23f"
},
"downloads": -1,
"filename": "traceroot-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "22691be08b99f35086716eaeb63ffed0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12815,
"upload_time": "2025-07-11T22:17:20",
"upload_time_iso_8601": "2025-07-11T22:17:20.198498Z",
"url": "https://files.pythonhosted.org/packages/52/aa/b7e327bd9e672284f4a9ca0920c55ae156fc58768017931f048ec43f6b90/traceroot-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "bbe65a7ff00e4844ded949cc3a9afcbc78d5f16bd463182c1c057df612e868d3",
"md5": "108d10b8f37f1b851fafd49c937cf74b",
"sha256": "5ce193776fa675fa0d971d85e7255ef67cafce5dd811da1168dfda0271fd849a"
},
"downloads": -1,
"filename": "traceroot-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "108d10b8f37f1b851fafd49c937cf74b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 15366,
"upload_time": "2025-07-11T22:17:21",
"upload_time_iso_8601": "2025-07-11T22:17:21.362246Z",
"url": "https://files.pythonhosted.org/packages/bb/e6/5a7ff00e4844ded949cc3a9afcbc78d5f16bd463182c1c057df612e868d3/traceroot-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-11 22:17:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "traceroot-ai",
"github_project": "traceroot-sdk",
"github_not_found": true,
"lcname": "traceroot"
}
JSON
