argopy.utils.Github

argopy.utils.Github#

class Github(repo: str = 'argopy', owner: str = 'euroargodev')[source]#

Github repository helper class

This class uses the Github API, to get PRs and release information.

It is primarily meant to be used by GreenCoding.

Examples

Listing 29 Github API#
from argopy.utils import Github

Github().releases
Github().lastrelease_date
Github().lastrelease_tag
Github().get_PRtitle(385)
Github().ls_PRs()
Github().ls_PRs('2025-01-01')
Github().ls_PRmerged('2025-01-01')
Github().ls_PRmerged('2024-01-01', '2025-01-01')
Github().ls_PRmerged_since_last_release
Github().ls_PRmerged_in_release('v1.0.0')
__init__(repo: str = 'argopy', owner: str = 'euroargodev')[source]#

Methods

__init__([repo, owner])

get_PRtitle(pr_num)

Get the title of a given PR number

ls_PRbaseline([start_date, end_date])

List all PRs in the baseline

ls_PRmerged([start_date, end_date])

List merged PRs

ls_PRmerged_in_release(release)

List PRs included in a given release

ls_PRs([start_date, end_date, date])

List all PRs, possibly between 2 dates

Attributes

lastrelease_date

Last release publication date

lastrelease_tag

Last release tag name

ls_PRmerged_since_last_release

List PRs merged since the last release

owner

Github owner parameter, default to 'euroargodev'

releases

List of published releases

repo

Github repo parameter, default to 'argopy'
Contents