src.services.workflow_service

Module Contents

class src.services.workflow_service.WorkflowRunResult

Store metadata and outputs from a workflow run. Args: response (dict): Raw workflow response; summary_output (str): Generated summary; optional fields include artifact paths, branches, URL, metrics, and draft ID. Returns: WorkflowRunResult: Container with workflow results and related metadata.

response: dict

summary_output: str

artifact_dir: str | None = None

log_path: str | None = None

source_branch: str | None = None

published_branch: str | None = None

documentation_url: str | None = None

metrics_files_analyzed: int | None = None

metrics_docstrings_generated: int | None = None

metrics_skipped_files: int | None = None

draft_id: str | None = None

src.services.workflow_service.execute_generate_request(req: models.repo_request.RepoRequest, progress_callback=None) → WorkflowRunResult

Execute a repository documentation generation workflow.

Parameters:

req (RepoRequest) – Request containing repository access, branch, model, and generation
settings.
progress_callback (Callable | None) – Optional callback for workflow progress updates.

Returns:

Workflow response, artifact paths, source branch, and generation metrics.

Return type:

WorkflowRunResult

src.services.workflow_service.execute_docstring_pr_request(req: models.repo_request.DocstringPullRequestRequest, progress_callback=None) → WorkflowRunResult

Create a pull request containing generated Python docstring suggestions. :param req: Pull request configuration, repository access, and :type req: DocstringPullRequestRequest :param generation limits.: :param progress_callback: Optional callback for workflow progress updates. :type progress_callback: Callable | None

Returns:: Pull request response, summary metrics, and artifact/log paths.
Return type:: WorkflowRunResult

src.services.workflow_service.execute_publish_request(req: models.repo_request.PublishPagesRequest, progress_callback=None) → WorkflowRunResult

Publishes repository documentation to GitHub Pages and returns workflow metadata.

Args: req (PublishPagesRequest): Publish request configuration; progress_callback (Callable | None): Optional progress notifier. Returns: WorkflowRunResult: Publish result with response data, artifacts, logs, branches, and documentation URL.

src.services.workflow_service.execute_architecture_generation_request(req: models.repo_request.ArchitectureGenerationRequest, progress_callback=None) → WorkflowRunResult

Execute an architecture generation workflow and package its result. :param req: Request containing repository, provider, branch, and :type req: ArchitectureGenerationRequest :param output options; progress_callback: Callback for progress updates. :type output options; progress_callback: callable, optional

Returns:: Workflow response, summary, artifact paths, and draft metadata.
Return type:: WorkflowRunResult

src.services.workflow_service.execute_architecture_approval_request(req: models.repo_request.ArchitectureApprovalRequest, progress_callback=None) → WorkflowRunResult: Apply an approved architecture document and return workflow metadata. Args: req (ArchitectureApprovalRequest): Approval request details; progress_callback (Callable | None): Optional progress notifier. Returns: WorkflowRunResult: Result containing response, summary, artifacts, log path, branch, and draft ID.