GitHubContext

Information about the GitHub repo / user.

avatar_url class-attribute instance-attribute

avatar_url: str | None = None

The url of the GitHub avatar.

bio class-attribute instance-attribute

bio: str | None = None

The user biography.

blog class-attribute instance-attribute

blog: str | None = None

The user blog URL.

company class-attribute instance-attribute

company: str | None = None

The company associated with the user.

default_branch class-attribute instance-attribute

default_branch: str = ''

The default branch of the repository.

email class-attribute instance-attribute

email: str | None = None

The user email address.

followers class-attribute instance-attribute

followers: int | None = None

The follower count of the user.

gravatar_id class-attribute instance-attribute

gravatar_id: str | None = None

The gravatar id associated with the user.

hireable class-attribute instance-attribute

hireable: bool | None = None

Whether the user is hireable.

location class-attribute instance-attribute

location: str | None = None

The user location, as set on GitHub.

name class-attribute instance-attribute

name: str | None = None

The GitHub username.

repo_name class-attribute instance-attribute

repo_name: str = ''

The repository name.

twitter_username class-attribute instance-attribute

twitter_username: str | None = None

The twitter username.

workflows class-attribute instance-attribute

workflows: list[Workflow] = field(default_factory=list)

A list of configured workflows.

__init__

__init__(
    default_branch: str = "",
    repo_name: str = "",
    workflows: list[Workflow] = list(),
    avatar_url: str | None = None,
    bio: str | None = None,
    blog: str | None = None,
    company: str | None = None,
    email: str | None = None,
    followers: int | None = None,
    gravatar_id: str | None = None,
    hireable: bool | None = None,
    location: str | None = None,
    name: str | None = None,
    twitter_username: str | None = None,
) -> None

__repr__

__repr__()

from_url classmethod

from_url(url: str) -> GitHubContext

Create GitHubContext from a GitHubRepository instance.

Parameters:

Name	Type	Description	Default
url	str	URL to the repository.	required

Page info

Resources

Resources(css=[],
          markdown_extensions={'attr_list': {},
                               'md_in_html': {},
                               'pymdownx.emoji': {'emoji_generator': <function to_svg at 0x7fd7a6931800>,
                                                  'emoji_index': <function twemoji at 0x7fd7a69316c0>},
                               'pymdownx.magiclink': {'repo': 'mknodes',
                                                      'repo_url_shorthand': True,
                                                      'user': 'phil65'}},
          plugins=[Plugin('mkdocstrings')],
          js=[],
          assets=[],
          packages=[])

Metadata

created:
  source_filename: /home/runner/work/mknodes/mknodes/mknodes/manual/templating_section.py
  source_function: _
  source_line_no: 42
template: SUMMARY.html
title: GitHubContext