Metadata-Version: 2.4
Name: checktrace
Version: 0.0.1
Summary: Placeholder for checktrace SDK. Install from pip.muid.io for full version.
Project-URL: Homepage, https://muid.io
Project-URL: Repository, https://github.com/muid-io/checktrace
Project-URL: Documentation, https://pip.muid.io
Author-email: "MUID.io" <dev@muid.io>
License-Expression: MIT
Keywords: distributed,observability,placeholder,tracing
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# checktrace

**This is a placeholder package on PyPI.**

The full checktrace SDK (Python SDK for distributed tracing via TraceHub) is available from our private package index.

## Installation

```bash
pip install checktrace --extra-index-url https://pip.muid.io/simple/
```

With FastAPI middleware support:

```bash
pip install "checktrace[middleware]" --extra-index-url https://pip.muid.io/simple/
```

## Features (in full version)

- Config-driven tracing initialization
- ContextVar-based correlation ID propagation (async-safe)
- Auto-redaction of sensitive data
- Non-blocking trace sending (background thread)
- FastAPI middleware for automatic request tracing
- `@checkpoint` decorator for function tracing
- CLI for querying traces (`checktrace list/get/stream`)

## Quick Start (after installing from pip.muid.io)

```python
from checktrace import CheckTraceConfig, init_tracing, checkpoint

config = CheckTraceConfig(
    tracehub_url="http://tracehub:8099",
    project_name="myapp",
    default_source_id="MA",
)
init_tracing(config)

@checkpoint("MA", "process_request")
async def process_request(data: dict):
    return {"status": "ok"}
```

## Links

- **Full package:** https://pip.muid.io/simple/checktrace/
- **Documentation:** https://github.com/muid-io/checktrace
- **MUID.io:** https://muid.io

## License

MIT
