Toggle navigation

.rst .pdf

repository open issue

Platypush documentation

github

class platypush.message.event.github.Actor(id: str, login: str, display_login: str, url: str, gravatar_id: str, avatar_url: str)

Bases: object

__init__(id: str, login: str, display_login: str, url: str, gravatar_id: str, avatar_url: str) → None

class platypush.message.event.github.GithubCommitCommentEvent(payload: dict, *args, **kwargs)

Bases: GithubEvent

A commit comment is created.

__init__(payload: dict, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.GithubCreateEvent(payload: dict, *args, **kwargs)

Bases: GithubEvent

A git branch or tag is created.

__init__(payload: dict, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.GithubDeleteEvent(payload: dict, *args, **kwargs)

Bases: GithubEvent

A git branch or tag is deleted.

__init__(payload: dict, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.GithubEvent(event_type: str, created_at: datetime, actor: Optional[Dict[str, str]] = None, repo: Optional[Dict[str, str]] = None, *args, **kwargs)

Bases: Event

Generic Github event

__init__(event_type: str, created_at: datetime, actor: Optional[Dict[str, str]] = None, repo: Optional[Dict[str, str]] = None, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.GithubForkEvent(payload: dict, *args, **kwargs)

Bases: GithubEvent

A user forks a watched repository.

__init__(payload: dict, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.GithubIssueCommentEvent(payload: dict, *args, **kwargs)

Bases: GithubEvent

A comment is added or updated on an issue.

__init__(payload: dict, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.GithubIssueEvent(payload: dict, *args, **kwargs)

Bases: GithubEvent

A new activity is registered on an issue.

__init__(payload: dict, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.GithubMemberEvent(payload: dict, *args, **kwargs)

Bases: GithubEvent

New activity related to repository collaborators.

__init__(payload: dict, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.GithubPublicEvent(payload: dict, *args, **kwargs)

Bases: GithubEvent

A private repository is made public.

__init__(payload: dict, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.GithubPullRequestEvent(payload: dict, *args, **kwargs)

Bases: GithubEvent

New activity related to a pull request.

__init__(payload: dict, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.GithubPullRequestReviewCommentEvent(payload: dict, *args, **kwargs)

Bases: GithubEvent

New activity related to comments of a pull request.

__init__(payload: dict, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.GithubPushEvent(payload: dict, *args, **kwargs)

Bases: GithubEvent

Github push event.

__init__(payload: dict, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.GithubReleaseEvent(payload: dict, *args, **kwargs)

Bases: GithubEvent

New activity related to the release of a repository.

__init__(payload: dict, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.GithubSponsorshipEvent(payload: dict, *args, **kwargs)

Bases: GithubEvent

New activity related to the sponsorship of a repository.

__init__(payload: dict, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.GithubWatchEvent(payload: dict, *args, **kwargs)

Bases: GithubEvent

Event triggered when someone stars or starts watching a repository.

__init__(payload: dict, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.GithubWikiEvent(payload: dict, *args, **kwargs)

Bases: GithubEvent

A wiki page is created or updated on a watched repository.

__init__(payload: dict, *args, **kwargs)

Params:

target – Target node [String] origin – Origin node (default: current node) [String] id – Event ID (default: auto-generated) kwargs – Additional arguments for the event [kwDict] logging_level – Logging level that should be applied to these

events (default: INFO).

class platypush.message.event.github.Repo(id: str, name: str, url: str)

Bases: object

__init__(id: str, name: str, url: str) → None

previous

geo

next

google