githubcap.enums module

Representation of enums that are present at GitHub API v3.

class githubcap.enums.AuthorAssociation

Bases: githubcap.enums.GitHubCapEnum

Author association for a resource (e.g. an issue).

COLLABORATOR = 'COLLABORATOR'

CONTRIBUTOR = 'CONTRIBUTOR'

FIRST_TIME_CONTRIBUTOR = 'FIRST_TIME_CONTRIBUTOR'

MEMBER = 'MEMBER'

NONE = 'NONE'

OWNER = 'OWNER'

classmethod get_default()

Get default enum value.

class githubcap.enums.Filtering

Bases: githubcap.enums.GitHubCapEnum

Issue filtering.

ALL = 'all'

ASSIGNED = 'assigned'

CREATED = 'created'

MENTIONED = 'mentioned'

SUBSCRIBED = 'subscribed'

classmethod get_default()

Get default enum value.

class githubcap.enums.GitHubCapEnum

Bases: enum.Enum

A base class for defined enums.

classmethod all_names() → typing.List[str]

Get a list of all enum names.

classmethod all_values() → typing.List[str]

Get a list of all enum values.

classmethod from_str(name: str)

Get enum based on its string representation.

classmethod from_value(value: str)

Get enum based on its value.

classmethod get_default()

Get default enum value.

class githubcap.enums.Sorting

Bases: githubcap.enums.GitHubCapEnum

Sorting criteria for issues.

COMMENTS = 'comments'

CREATED = 'created'

UPDATED = 'updated'

classmethod get_default()

Get default enum value.

class githubcap.enums.SortingDirection

Bases: githubcap.enums.GitHubCapEnum

Sorting direction criteria.

ASC = 'asc'

DESC = 'desc'

classmethod get_default()

Get default enum value.

class githubcap.enums.State

Bases: githubcap.enums.GitHubCapEnum

Resource state representation (e.g. for issues).

ALL = 'all'

CLOSED = 'closed'

OPEN = 'open'

classmethod get_default()

Get default enum value.

class githubcap.enums.UserType

Bases: githubcap.enums.GitHubCapEnum

Type of a GitHub user.

ORGANIZATION = 'Organization'

USER = 'User'

classmethod get_default()

Get default enum value.