|
1 | | -# Kairo Python SDK |
| 1 | +# Microsoft Agent 365 Python SDK |
2 | 2 |
|
3 | | -A Python SDK for Kairo, providing telemetry and monitoring capabilities. |
| 3 | +The Microsoft Agent365 SDK provides comprehensive observability, tooling, and runtime capabilities for AI agents and tools built with Python. |
4 | 4 |
|
5 | | -## Installation |
| 5 | +## 📚 Library Documentation |
6 | 6 |
|
7 | | -```bash |
8 | | -pip install microsoft-kairo |
9 | | -``` |
| 7 | +Each library includes comprehensive documentation: |
10 | 8 |
|
11 | | -## Usage |
12 | | - |
13 | | -### Basic Configuration |
14 | | - |
15 | | -```python |
16 | | -import microsoft_kairo |
17 | | - |
18 | | -# Configure Kairo with console output (default) |
19 | | -microsoft_kairo.configure_kairo( |
20 | | - service_name="my-service", |
21 | | - service_namespace="my-namespace", |
22 | | - agent_id="agent-123" |
23 | | -) |
24 | | -``` |
25 | | - |
26 | | -### Advanced Configuration |
27 | | - |
28 | | -```python |
29 | | -import microsoft_kairo |
30 | | - |
31 | | -# Configure with Azure Monitor |
32 | | -microsoft_kairo.configure_kairo( |
33 | | - service_name="my-service", |
34 | | - service_namespace="my-namespace", |
35 | | - agent_id="agent-123", |
36 | | - exporter_type="azure_monitor", |
37 | | - exporter_endpoint="InstrumentationKey=your-instrumentation-key" |
38 | | -) |
39 | | - |
40 | | -# Configure with OTLP exporter |
41 | | -microsoft_kairo.configure_kairo( |
42 | | - service_name="my-service", |
43 | | - service_namespace="my-namespace", |
44 | | - agent_id="agent-123", |
45 | | - exporter_type="otlp", |
46 | | - exporter_endpoint="http://localhost:4317" |
47 | | -) |
48 | | -``` |
49 | | - |
50 | | -### Available Exports |
51 | | - |
52 | | -- `configure_kairo()`: Main configuration function |
53 | | -- `KairoSpanProcessor`: Custom span processor class |
54 | | -- `KAIRO_AGENT_ID_KEY`: Constant for agent ID attribute key |
55 | | - |
56 | | -## Optional Dependencies |
57 | | - |
58 | | -- `otlp`: OpenTelemetry OTLP exporter |
59 | | -- `jaeger`: Jaeger exporter |
60 | | -- `azure`: Azure Monitor exporter |
61 | | -- `all`: All optional dependencies |
62 | | - |
63 | | -Install with optional dependencies: |
64 | | - |
65 | | -```bash |
66 | | -pip install microsoft-kairo[azure] |
67 | | -``` |
68 | | - |
69 | | -## Building and publishing the package |
70 | | - |
71 | | -Build the package with: |
72 | | - |
73 | | -``` |
74 | | -uv build --wheel |
75 | | -``` |
76 | | - |
77 | | -which will generate a date-based wheel package in the `dist/` folder. Ex.: `dist\microsoft_kairo-2025.10.7+preview.15276-py3-none-any.whl`. |
78 | | - |
79 | | -Then publish it with: |
80 | | - |
81 | | -``` |
82 | | -uv run twine upload --config-file .\.pypirc -r Agent365 dist/* |
83 | | -``` |
| 9 | +| Library | Purpose | Documentation | |
| 10 | +|---------|---------|---------------| |
| 11 | +| **Observability Core** | Core telemetry and tracing | [`/libraries/microsoft-agents-a365-observability-core/README.md`](./libraries/microsoft-agents-a365-observability-core/README.md) | |
| 12 | +| **Runtime** | Environment management and utilities | [`/libraries/microsoft-agents-a365-runtime/README.md`](./libraries/microsoft-agents-a365-runtime/README.md) | |
| 13 | +| **Tooling** | MCP server configuration and utilities | [`/libraries/microsoft-agents-a365-tooling/README.md`](./libraries/microsoft-agents-a365-tooling/README.md) | |
| 14 | +| **OpenAI Extensions** | OpenAI integration and observability | [`/libraries/microsoft-agents-a365-observability-extensions-openai/README.md`](./libraries/microsoft-agents-a365-observability-extensions-openai/README.md) | |
| 15 | +| **LangChain Extensions** | LangChain integration and observability | [`/libraries/microsoft-agents-a365-observability-extensions-langchain/README.md`](./libraries/microsoft-agents-a365-observability-extensions-langchain/README.md) | |
| 16 | +| **Semantic Kernel Extensions** | Semantic Kernel integration | [`/libraries/microsoft-agents-a365-observability-extensions-semantickernel/README.md`](./libraries/microsoft-agents-a365-observability-extensions-semantickernel/README.md) | |
84 | 17 |
|
85 | 18 | ## 📋 **Telemetry** |
86 | 19 |
|
|
0 commit comments