API reference

Curated index of the public EzCompiler API, organized by layer.

📦 Modules

Component	Description	Page
Interfaces	EzCompiler facade and CLIInterface entry points	Interfaces
Services	Compiler, config, pipeline, template, upload logic	Services
Adapters	Compiler and uploader factories and implementations	Adapters
Shared	CompilerConfig, CompilationResult, exceptions	Shared
Types	FilePath, CompilerName, UploadTarget, etc.	Types
Utils	File, config, template, zip utilities and validators	Utils

🔍 Full reference

For the complete auto-generated API dump from docstrings, open API auto-reference.

Import paths

# Top-level public API
from ezcompiler import EzCompiler, CompilerConfig

# By layer
from ezcompiler.interfaces import EzCompiler
from ezcompiler.shared import CompilerConfig
from ezcompiler.services import CompilerService
from ezcompiler.adapters import CompilerFactory, UploaderFactory

Visibility conventions

Concrete adapter classes (compilers, uploaders) are internal and accessed through their respective factories. Only EzCompiler, CompilerConfig, and the public type aliases in types are part of the stable public API.