bridge.core package#
Public Interface#
This section documents user-facing interface of the bridge.core package (as defined in its __init__.py file).
Classes#
alias of |
|
|
Represent a GitHub repository with its latest release. |
|
Represent a publication. |
|
Represent an SPDX license. |
Core domain models shared across the bridge. Re-exports validated Pydantic models for repositories and metadata.
- class bridge.core.GitHubRepoModel(**data)[source]#
Bases:
BaseModelRepresent a GitHub repository with its latest release.
- Parameters:
repo (FullRepository) – The full repository data.
latest_release (GitHubLatestReleaseModel | None) – The latest release data, or None if no releases exist.
github_pages (GitHubPages | None) – The GitHub Pages data, or None if not available.
readme (str | None) – The README content of the repository, or None if not available.
languages (Language | None)
-
github_pages:
GitHubPages|None#
-
readme:
str|None#
-
repo:
FullRepository#
- class bridge.core.Publication(**data)[source]#
Bases:
BaseModelRepresent a publication.
- Parameters:
doi (str | None) – The Digital Object Identifier (DOI) of the publication.
title (str | None) – The title of the publication.
authors (list[str] | None) – The list of authors of the publication.
year (int | None) – The publication year.
journal (str | None) – The journal in which the publication appeared.
volume (str | None) – The volume of the journal.
issue (str | None) – The issue of the journal.
page_start (int | None) – The starting page number of the publication.
page_end (int | None) – The ending page number of the publication.
pub_type (str | None) – The type of publication (e.g., “article”).
-
doi:
str|None#
-
issue:
str|None#
-
journal:
str|None#
-
page_end:
int|None#
-
page_start:
int|None#
-
pub_type:
str|None#
-
title:
str|None#
-
volume:
str|None#
-
year:
int|None#
- class bridge.core.SPDXLicense(**data)[source]#
Bases:
BaseModelRepresent an SPDX license.
- Parameters:
licenseId (str) – SPDX license identifier (e.g.
"MIT","GPL-3.0-only").name (str) – Full name of the license.
licenseText (str) – Canonical license text.
licenseTextHtml (str) – HTML-formatted license text.
isDeprecatedLicenseId (bool | None) – Whether the license ID is deprecated.
standardLicenseTemplate (str | None) – Standard license template text, if available.
isOsiApproved (bool | None) – Whether the license is OSI-approved.
isFsfLibre (bool | None) – Whether the license is FSF libre.
seeAlso (list[HttpUrl] | None) – List of URLs with additional information about the license.
crossRef (list[SPDXCrossRef] | None) – List of cross-references for the license.
-
crossRef:
list[SPDXCrossRef] |None#
-
isDeprecatedLicenseId:
bool|None#
-
isFsfLibre:
bool|None#
-
isOsiApproved:
bool|None#
-
licenseId:
str#
-
licenseText:
str#
-
licenseTextHtml:
str#
-
name:
str#
-
seeAlso:
list[HttpUrl] |None#
-
standardLicenseTemplate:
str|None#
Submodules#
Auto-generated Pydantic models for the bio.tools schema. |
|
GitHub repository Pydantic models. |
|
Auto-generated Pydantic models for the GitHub languages schema. |
|
Auto-generated Pydantic models for the GitHub latest release schema. |
|
Auto-generated Pydantic models for the GitHub Pages schema. |
|
Auto-generated Pydantic models for the GitHub repository schema. |
|
Module defining the SPDX license data model. |
|
Module defining the Publication data model. |
Dependencies diagram#
Each architecture diagram below visualizes the internal dependency structure of the bridge.core 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).