Guides¶
The Guides section is the task-oriented navigation spine of this site. Three sub-sections, one per audience emphasis:
| Sub-section | Audience | What it covers |
|---|---|---|
| Python SDK | Python developers | Idiomatic Python patterns for the SDK — type hints, dataclasses, context managers. |
| Command-line | CLI users, shell-scripters | Drive the SDK from a terminal; pipe output to other Unix tools. |
| Data Analysis | Data analysts | Pandas, Jupyter, DuckDB, and Markdown report patterns. |
Path¶
- Python SDK — the most common entry point.
Covers
ComtradeClient, the five service facades, and idiomatic error handling. - Command-line — for terminal-first users and
shell-scripted pipelines. Five outer commands
(
metadata,trade,analytics,storage,etl), 22 sub-subcommands, and five output formats. - Data Analysis — for analysts who want to explore UN Comtrade data interactively. Covers pandas, Jupyter, DuckDB, and Markdown report generation.
Related API¶
un_comtrade.ComtradeClient— the single public entry point used by every guide.
Related Guides¶
Next steps¶
- Python SDK → Trade — the most common entry point.
- Command-line → Metadata — try the CLI without writing any Python.