Skip to content

Commit 815cca1

Browse files
committed
Add CLAUDE.md with project structure and commands
1 parent 87b20ab commit 815cca1

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# OpenTelemetry Python Contrib
2+
3+
Monorepo with 50+ OpenTelemetry instrumentation packages for Python.
4+
5+
## Structure
6+
7+
- `instrumentation/` - instrumentation packages (Flask, Django, FastAPI, gRPC, databases, etc.)
8+
- `instrumentation-genai/` - GenAI instrumentations (Anthropic, Vertex AI, LangChain, etc.)
9+
- `util/` - shared utilities (`util-http`, `util-genai`)
10+
- `exporter/` - custom exporters
11+
- `propagator/` - context propagators
12+
13+
Each package lives under `src/opentelemetry/instrumentation/{name}/` with its own `pyproject.toml` and `tests/`.
14+
15+
## Commands
16+
17+
```sh
18+
# Install all packages and dev tools
19+
uv sync --frozen --all-packages
20+
21+
# Lint (runs ruff via pre-commit)
22+
uv run pre-commit run ruff --all-files
23+
24+
# Test a specific package (append -0, -1, etc. for version variants)
25+
uv run tox -e py312-test-instrumentation-flask-0
26+
27+
# Type check
28+
uv run tox -e typecheck
29+
```
30+
31+
## Guidelines
32+
33+
- Each package has its own `pyproject.toml` with version, dependencies, and entry points.
34+
- The monorepo uses `uv` workspaces.
35+
- `tox.ini` defines the test matrix - check it for available test environments.
36+
- Do not add `type: ignore` comments. If a type error arises, solve it properly or write a follow-up plan to address it in another PR.

0 commit comments

Comments
 (0)