duncan3dc/github

There is no license information available for the latest version (0.1.0) of this package.

A library to interact with the GitHub API

0.1.0 2018-07-15 20:37 UTC

README

A PHP library to interact with the GitHub API

Full documentation is available at http://duncan3dc.github.io/github/
PHPDoc API documentation is also available at http://duncan3dc.github.io/github/api/

release build coverage

Installation

The recommended method of installing this library is via Composer.

Run the following command from your project root:

$ composer require duncan3dc/github

Getting Started

use duncan3dc\GitHub\Api;

require __DIR__ . "/vendor/autoload.php";

# Connect to a GitHub app using the private key
$api = new Api(1014, file_get_contents("/var/safe/github.pem"));

# List all the organizations this app is installed under
foreach ($app->getOrganizations() as $organization) {
    echo $organization->getName() . "\n";
}

# Get a specific organization/user
$organization = $app->getOrganization("duncan3dc");

Read more at http://duncan3dc.github.io/github/

Where to get help

Found a bug? Got a question? Just not sure how something works?
Please create an issue and I'll do my best to help out.
Alternatively you can catch me on Twitter