github 9.0.1 github: ^9.0.1 copied to clipboard
A high-level GitHub API Client Library that uses Github's v3 API
Getting Started #
First, add the following to your pubspec.yaml:
dependencies:
github: ^6.0.0
Then import the library
import 'package:github/github.dart';
and then use it:
Example #
import 'package:github/github.dart';
Future<void> main() async {
/* Create a GitHub Client, with anonymous authentication by default */
var github = GitHub();
/*
or Create a GitHub Client and have it try to find your token or credentials automatically
In Flutter and in server environments this will search environment variables in this order
GITHUB_ADMIN_TOKEN
GITHUB_DART_TOKEN
GITHUB_API_TOKEN
GITHUB_TOKEN
HOMEBREW_GITHUB_API_TOKEN
MACHINE_GITHUB_API_TOKEN
and then GITHUB_USERNAME and GITHUB_PASSWORD
In a browser it will search keys in the same order first through the query string parameters
and then in window sessionStorage
*/
var github = GitHub(auth: findAuthenticationFromEnvironment());
/* or Create a GitHub Client using an auth token */
var github = GitHub(auth: Authentication.withToken('YourTokenHere'));
/* or Create a GitHub Client using a username and password */
var github = GitHub(auth: Authentication.basic('username', 'password'));
Repository repo = await github.repositories.getRepository(RepositorySlug('user_or_org', 'repo_name'));
/* Do Something with repo */
}