API Reference
This page provides comprehensive API documentation for the gradual package.
Available Modules
The following modules are automatically discovered and documented:
- Base -
gradual.base - Configs -
gradual.configs - Constants -
gradual.constants - Exceptions -
gradual.exceptions - Reporting -
gradual.reporting - Runners -
gradual.runners - Parser -
gradual.configs.parser - Phase -
gradual.configs.phase - Request -
gradual.configs.request - Scenario -
gradual.configs.scenario - Validate -
gradual.configs.validate - Orchestrator -
gradual.base.orchestrator - Request_Types -
gradual.constants.request_types - Adapters -
gradual.reporting.adapters - Logger -
gradual.reporting.logger - Stats -
gradual.reporting.stats - Base -
gradual.reporting.adapters.base - Logging -
gradual.reporting.adapters.logging - Iterators -
gradual.runners.iterators - Phase -
gradual.runners.phase - Request -
gradual.runners.request - Runner -
gradual.runners.runner - Scenario -
gradual.runners.scenario - Session -
gradual.runners.session - Http -
gradual.runners.request.Http - Socketio -
gradual.runners.request.SocketIO - Base -
gradual.runners.request.base
Automatic Discovery
This documentation is automatically generated using a Python script that: 1. Discovers all modules in the package 2. Generates individual documentation files for each module 3. Uses mkdocstrings to extract documentation from docstrings 4. Updates automatically when you run the script
To regenerate all API documentation, run: