2017 © Pedro Peláez
 

library github-repo-events

A standalone client for parsing the Github Repo Events API

image

jimbojsb/github-repo-events

A standalone client for parsing the Github Repo Events API

  • Friday, February 17, 2017
  • by jimbojsb
  • Repository
  • 1 Watchers
  • 1 Stars
  • 10 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 4 Versions
  • 0 % Grown

The README.md

Github Repo Events

This library will allow you to poll the Github events API rather than using a web hook., (*1)

Usage

Basic usage on a public repo, (*2)

$eventsStream = new GithubRepoEvents\RepsitoryEventStream("user/repo");
foreach ($eventsStream as $event) {
    // do stuff with events
}

Add an API key for increased quota or access to private repos, (*3)

$eventsStream = new GithubRepoEvents\RepsitoryEventStream("user/repo", "githubApiKey");
foreach ($eventsStream as $event) {
    // do stuff with events
}

Use ETags to avoid quota hits, (*4)

// costs from quota
$eventsStream = new GithubRepoEvents\RepsitoryEventStream("user/repo", "githubApiKey");
foreach ($eventsStream as $event) {
    // do stuff with events
}

$etag = $eventStream->getEtag();

// does not cost from quota, assuming the stream has no new events
$eventsStream = new GithubRepoEvents\RepsitoryEventStream("user/repo", "githubApiKey");
$eventStream->setEtag($etag);
foreach ($eventsStream as $event) {
    // do stuff with events
}

The Versions

17/02 2017

dev-master

9999999-dev

A standalone client for parsing the Github Repo Events API

  Sources   Download

MIT

The Requires

 

by Josh Butts

17/02 2017

v0.1.2

0.1.2.0

A standalone client for parsing the Github Repo Events API

  Sources   Download

MIT

The Requires

 

by Josh Butts

17/02 2017

v0.1.1

0.1.1.0

A standalone client for parsing the Github Repo Events API

  Sources   Download

MIT

The Requires

 

by Josh Butts

17/02 2017

v0.1

0.1.0.0

A standalone client for parsing the Github Repo Events API

  Sources   Download

MIT

The Requires

 

by Josh Butts