GitHub API v3 client
- dev-master / 2.0.x-dev
In 2.0 lib no longer uses guzzle 3.7, instead it has an HTTPlug abstraction layer.
For old version please check:
A simple Object Oriented wrapper for GitHub API, written with PHP5.
Uses GitHub API v3. The object API is very similar to the RESTful API.
- Follows PSR-4 conventions and coding standard: autoload friendly
- Light and fast thanks to lazy loading of API classes
- Extensively tested and documented
- PHP >= 5.5
- Guzzle library,
- (optional) PHPUnit to run tests.
The new version of
php-github-api using Composer.
The first step to use
php-github-api is to download composer:
$ curl -s http://getcomposer.org/installer | php
Then run the following command to require the library:
$ php composer.phar require knplabs/github-api php-http/guzzle6-adapter
<?php // This file is generated by Composer require_once 'vendor/autoload.php'; $client = new \Github\Client(); $repositories = $client->api('user')->repositories('ornicar');
$client object, you can access to all GitHub.
<?php // This file is generated by Composer require_once 'vendor/autoload.php'; use Cache\Adapter\Redis\RedisCachePool; $client = new \Redis(); $client->connect('127.0.0.1', 6379); // Create a PSR6 cache pool $pool = new RedisCachePool($client); $client = new \Github\Client(); $client->addCache($pool); // Do some request // Stop using cache $client->removeCache();
Using cache, the client will get cached responses if resources haven't changed since last time,
without reaching the
X-Rate-Limit imposed by github.
doc directory for more detailed documentation.
php-github-api is licensed under the MIT License - see the LICENSE file for details
- Thanks to Thibault Duplessis aka. ornicar for his first version of this library.
- Thanks to Joseph Bielawski aka. stloyd for his contributions and support.
- Thanks to noloh for his contribution on the Object API.
- Thanks to bshaffer for his contribution on the Repo API.
- Thanks to Rolf van de Krol for his countless contributions.
- Thanks to Nicolas Pastorino for his contribution on the Pull Request API.
- Thanks to Edoardo Rivello for his contribution on the Gists API.
Thanks to GitHub for the high quality API and documentation.