API Reference

Complete API documentation for pyetm, auto-generated from source code docstrings.

Overview

This reference documents all public classes, methods, and functions in the pyetm library. The documentation is organized by module:

Core Modules

• BaseClient - Base HTTP client with request/response handling
• Session - Session management for authenticated requests

Models

Domain models representing ETM entities.

• Scenario - Main scenario model
• Inputs - Input management
• Custom Curves - Custom curve uploads
• GQueries - Query results
• Scenario Packer - Batch scenario management
• Packables - Reusable data structures

Services

Business logic and API service operations.

• Scenario Runners - API operation runners
• Service Result - Service operation results

Config

Configuration management and settings.

• Settings - Application configuration and environment

Utils

Utility functions and helpers.

• Excel Utils - Excel file operations
• Safe Cast - Type conversion utilities

Types

Type definitions and type aliases.

Validators

Data validation utilities.

See Also

• User Guide - Tutorials and guides
• Getting Started - Installation and setup
• Contributing - Development guide