bridge.pipelines.bt2gh_for_pr_issues package#

Public Interface#

This section documents user-facing interface of the bridge.pipelines.bt2gh_for_pr_issues package (as defined in its __init__.py file).

Functions#

run(args)

Run the pipeline to generate repository file changes based on bio.tools metadata.

Classes#

BiotoolsToGitHubForPRPipelineArgs(**data)

Pipeline argument model for the bio.tools to GitHub for PR pipeline.

Pipeline package for generating repository changes (PR-ready for GitHub) from bio.tools metadata.

class bridge.pipelines.bt2gh_for_pr_issues.BiotoolsToGitHubForPRPipelineArgs(**data)[source]#

Bases: PipelineArgs

Pipeline argument model for the bio.tools to GitHub for PR pipeline.

Parameters:

repo_path (str) – Path to the cloned GitHub repository to make changes in.
metadata_model (BiotoolsToolModel) – The source bio.tools metadata model.
existing_repo_model (GitHubRepoModel)

existing_repo_model: GitHubRepoModel#

metadata_model: ToolModel#

repo_path: str#

async bridge.pipelines.bt2gh_for_pr_issues.run(args)[source]#

Run the pipeline to generate repository file changes based on bio.tools metadata.

Parameters:: args (BiotoolsToGitHubForPRPipelineArgs) – The pipeline arguments containing a path to the cloned GitHub repository and metadata model.
Returns:: A dictionary mapping file paths to their new content, and a dictionary mapping issue titles to their bodies.
Return type:: tuple[dict, dict]

Subpackages#

map_funcs

Individual mapping functions for bio.tools to GitHub.

Submodules#

`main`	Implements the bio.tools→GitHub PR pipeline: given a checkout path and a BiotoolsToolModel, produce file changes to propose in a pull request.
`map`	Mapping classes for bio.tools to GitHub.

Dependencies diagram#

Each architecture diagram below visualizes the internal dependency structure of the bridge.pipelines.bt2gh_for_pr_issues package. It shows how modules and subpackages within the package depend on each other, based on direct Python imports.

Packages are shown as purple rectangles
Modules are shown as pink rectangles
Arrows (A → B) indicate that A directly imports B

Each subpackage’s diagram focuses only on its own internal structure, it does not include imports to or from higher-level packages (those appear in the parent package’s diagram).

bridge.pipelines.bt2gh_for_pr_issues package

Contents