GitHub

This part of the documentation covers all the github APIs.

GitHub

class ghastoolkit.GitHub

The GitHub Class.

This API is used to configure the state for all Octokit apis. Its a standard interface across all projects.

api_graphql: str = 'https://api.github.com/graphql'

GraphQL API URL

api_rest: str = 'https://api.github.com'

REST API URL

static display() → str

Display the GitHub Settings.

enterprise: str | None = None

Enterprise Name

static getMetaInformation() → Dict

Get the GitHub Meta Information.

static getOrganization() → str

Get the Organization.

github_app: bool = False

GitHub App setting

static init(repository: str | None = None, owner: str | None = None, repo: str | None = None, reference: str | None = None, branch: str | None = None, token: str | None = None, instance: str | None = None, enterprise: str | None = None, retrieve_metadata: bool = True) → None

Initialise a GitHub class using a number of properties.

instance: str = 'https://github.com'

Instance

static isEnterpriseServer() → bool

Is the GitHub instance an Enterprise Server.

owner: str | None = None

Owner / Organisation

static parseInstance(instance: str) → Tuple[str, str]

Parse GitHub Instance.

repository: Repository = GeekMasher/ghastoolkit

Repository

server_version: Version | None = None

GitHub Enterprise Server Version

token: str | None = None

GitHub Access Token