knplabs/github-api

GitHub API v3 client

v3.16.0 2024-11-07 19:35 UTC

Requires

• php: ^7.2.5 || ^8.0
• ext-json: *
• php-http/cache-plugin: ^1.7.1|^2.0
• php-http/client-common: ^2.3
• php-http/discovery: ^1.12
• php-http/httplug: ^2.2
• php-http/multipart-stream-builder: ^1.1.2
• psr/cache: ^1.0|^2.0|^3.0
• psr/http-client-implementation: ^1.0
• psr/http-factory-implementation: ^1.0
• psr/http-message: ^1.0|^2.0
• symfony/deprecation-contracts: ^2.2|^3.0
• symfony/polyfill-php80: ^1.17

Requires (Dev)

• guzzlehttp/guzzle: ^7.2
• guzzlehttp/psr7: ^2.7
• http-interop/http-factory-guzzle: ^1.0
• php-http/mock-client: ^1.4.1
• phpstan/extension-installer: ^1.0.5
• phpstan/phpstan: ^0.12.57
• phpstan/phpstan-deprecation-rules: ^0.12.5
• phpunit/phpunit: ^8.5 || ^9.4
• symfony/cache: ^5.1.8
• symfony/phpunit-bridge: ^5.2

MIT

• KnpLabs Team
• Thibault Duplessis

• api
• github
• gist
• gh

README

A simple Object Oriented wrapper for GitHub API, written with PHP.

Uses GitHub API v3 & supports GitHub API v4. The object API (v3) is very similar to the RESTful API.

Features

• Light and fast thanks to lazy loading of API classes
• Extensively tested and documented

Requirements

• PHP >= 7.2
• A PSR-17 implementation
• A PSR-18 implementation

Quick install

Via Composer.

This command will get you up and running quickly with a Guzzle HTTP client.

composer require knplabs/github-api:^3.0 guzzlehttp/guzzle:^7.0.1 http-interop/http-factory-guzzle:^1.0

Advanced install

We are decoupled from any HTTP messaging client with help by HTTPlug.

Using a different http client

composer require knplabs/github-api:^3.0 symfony/http-client nyholm/psr7

To set up the Github client with this HTTP client

use Github\Client;
use Symfony\Component\HttpClient\HttplugClient;

$client = Client::createWithHttpClient(new HttplugClient());

Read more about using different clients in our docs.

Framework integrations

Laravel

To integrate this library in laravel Graham Campbell created graham-campbell/github. See the installation instructions to get started in laravel.

Basic usage of php-github-api client

<?php

// This file is generated by Composer
require_once __DIR__ . '/vendor/autoload.php';

$client = new \Github\Client();
$repositories = $client->api('user')->repositories('ornicar');

From $client object, you have access to all available GitHub api endpoints.

Cache usage

This example uses the PSR6 cache pool redis-adapter. See http://www.php-cache.com/ for alternatives.

<?php

// This file is generated by Composer
require_once __DIR__ . '/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.

Documentation

See the doc directory for more detailed documentation.

License

php-github-api is licensed under the MIT License - see the LICENSE file for details

Maintainers

Please read this post first.

This library is maintained by the following people (alphabetically sorted) :

• @acrobat
• @Nyholm

Contributors

• 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 Miguel Piedrafita for his contribution to the v4 & Apps API.
• Thanks to Emre DEGER for his contribution to the Actions API.

Thanks to GitHub for the high quality API and documentation.