PHPackages                             milo/github-api-nette - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. milo/github-api-nette

ActiveLibrary[Framework](/categories/framework)

milo/github-api-nette
=====================

Nette Framework extension for Github API easy access

v2.2.x-dev(11y ago)137MITPHPPHP >=5.4.0

Since Mar 4Pushed 8y ago1 watchersCompare

[ Source](https://github.com/milo/github-api-nette)[ Packagist](https://packagist.org/packages/milo/github-api-nette)[ RSS](/packages/milo-github-api-nette/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (2)Versions (3)Used By (0)

Introduction
============

[](#introduction)

This is the [Nette Framework](https://nette.org) extension for [milo/github-api](https://github.com/milo/github-api) library. It brings you:

- prepared presenter for sign-in and sign-out actions
- Tracy panel
- `Milo\Github\Api` service in container
- and few more things...

Installation
============

[](#installation)

The master branch is compatible with Nette 2.4. For Nette 2.0-2.3 use branches v2.1 and v2.2 (but they are not maintained anymore).

If you hit the problem open an [issue](https://github.com/milo/github-api-nette/issues) please.

For installation use [Composer](https://getcomposer.org/):

```
composer require milo/github-api-nette @dev

```

Register the extension in `config.neon`:

```
extensions:
	github: Milo\Github\NetteExtension\Extension(%debugMode%)

```

Since you register the extension you get a new service in DI container:

- `github.api` is instance of `Milo\Github\Api`

And when you set `clientId` and `clientSecret` (mentioned later) in config file, you get next two:

- `github.login` is instance of `Milo\Github\OAuth\Login`
- `github.user` is instance of `Milo\Github\NetteExtension\User`

Configuration
=============

[](#configuration)

Extension works without any configuration. But your Github API requests will be rate limited and non-authenticated.

Configure the extension in `config.neon`. If you have one static token, you can set it manualy:

```
github:
	auth:
		token: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

```

If you want to obtain the token dynamically by authentication procedure, set the `clientId` and `clientSecret`:

```
github:
	auth:
		clientId: 'xxxxxxxxxxxx'
		clientSecret: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

```

You can use both simultaneously. The token obtained by authentication will be used when obtained.

Whole configuration:

```
services:
	ownClient: Milo\Github\Http\StreamClient

github:
	cached: FALSE       # (default TRUE) read below...
	client: @ownClient  # (default NULL) set own HTTP client
	auth:
		token: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
		clientId: 'xxxxxxxxxxxx'
		clientSecret: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
		scopes: ['user', 'repo']  # (default [])

```

Caching
=======

[](#caching)

The `cached` configuration option controls caching mechanism.

- `FALSE` - no caching will be used

With following, `Http\CachedClient` will be used:

- `TRUE` - updates will be checked every request
- `(int)` - updates will not be checked for int seconds
- `INF` - updates will never be checked (permanent cache)

**WARNING** - Values `(int)` and `INF` are for development purpose only and should never be used in production. It's because the cache may be outdated and Github may hold newer data.

Authentication
==============

[](#authentication)

To help with OAuth token obtaining, there is a prepared abstract `Milo\Github\NetteExtension\Presenter` for you. Use it in your application as:

```
namespace App\Presenters;

class GithubPresenter extends Milo\Github\NetteExtension\Presenter
{
	# Called after successfull authentication on Github web page
	public function actionSignInRedirect()
	{
		$this->flashMessage('Signed IN');
		$this->redirect('Homepage:');
	}

	# Called on logging out
	public function actionSignOutRedirect()
	{
		$this->flashMessage('Signed OUT');
		$this->redirect('Homepage:');
	}
}
```

Create links or redirect to following presenter actions in a usual way:

- `Github:signIn` for logging in
- `Github:signOut` for logging out

**NOTE**: The prepared presenter requires clientId and clientSecret to be configured.

Even you are or you are not authenticated, you have a `github.user` [Milo\\Github\\NetteExtension\\User](https://github.com/milo/github-api-nette/blob/master/src/NetteExtension/User.php) service in DI container. You can check `$user->isLoggedIn()` and get some basic user info like, login, name, avatar URL...

Tracy panel
===========

[](#tracy-panel)

[![Tracy panel screenshot](https://github.com/milo/github-api-nette/raw/master/screenshot.png)](https://github.com/milo/github-api-nette/raw/master/screenshot.png)

License
=======

[](#license)

The MIT License (MIT)

Copyright (c) 2014 Miloslav Hůla

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

4093d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/a4c732343c0eba814891adfe91dea1754265ea7a5cbed1232d872cac406ff21e?d=identicon)[milonemilo](/maintainers/milonemilo)

---

Top Contributors

[![milo](https://avatars.githubusercontent.com/u/439140?v=4)](https://github.com/milo "milo (15 commits)")

### Embed Badge

![Health badge](/badges/milo-github-api-nette/health.svg)

```
[![Health](https://phpackages.com/badges/milo-github-api-nette/health.svg)](https://phpackages.com/packages/milo-github-api-nette)
```

###  Alternatives

[nette/bootstrap

🅱 Nette Bootstrap: the simple way to configure and bootstrap your Nette application.

68535.8M592](/packages/nette-bootstrap)[nette/nette

👪 Nette Framework - innovative framework for fast and easy development of secured web applications in PHP (metapackage)

1.6k2.8M335](/packages/nette-nette)[contributte/webpack

Webpack integration for Nette Framework.

471.0M1](/packages/contributte-webpack)[nette/web-project

Nette: Standard Web Project

10991.8k](/packages/nette-web-project)[kdyby/autowired

Syntax sugar for working with services in Nette Framework

30885.7k9](/packages/kdyby-autowired)[brandembassy/slim-nette-extension

19190.2k](/packages/brandembassy-slim-nette-extension)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)