github-user-repos
v1.0.2
Published
Get meta data for repositories associated with a user.
Downloads
5
Maintainers
Readme
User Repositories
Get meta data for repositories associated with a user.
Installation
$ npm install github-user-repos
Usage
var repos = require( 'github-user-repos' );
repos( opts, clbk )
Gets meta data for repositories associated with a user.
var opts = {
'username': 'kgryte'
};
repos( opts, clbk );
function clbk( error, results, info ) {
// Check for rate limit information...
if ( info ) {
console.error( 'Limit: %d', info.limit );
console.error( 'Remaining: %d', info.remaining );
console.error( 'Reset: %s', (new Date( info.reset*1000 )).toISOString() );
}
if ( error ) {
throw new Error( error.message );
}
console.log( JSON.stringify( results ) );
// returns <repo_data>
}
The function
accepts the following options
:
- token: Github access token.
- username: Github username.
- type: repository type. Can be one of
all
,owner
,member
,public
, orprivate
. Thepublic
andprivate
options are only applicable if the function is provided atoken
and nousername
. - sort: method used to sort meta data. Can be one of
full_name
,created
,pushed
, orupdated
. - direction: sort direction; either
asc
ordesc
. - visibility: repository visibility. Can be one of
all
,public
, orprivate
. Applicable if provided atoken
and nousername
. Ignored iftype
option is present. - affiliation: repository affiliation. A comma-separated list of values, which may include:
owner
,collaborator
,organization_member
. Applicable if provided atoken
and nousername
. Ignored iftype
option is present. - useragent: user agent
string
.
To authenticate with Github, set the token
option.
var opts = {
'token': 'tkjorjk34ek3nj4!'
};
repos( opts, clbk );
To specify a user agent, set the useragent
option.
var opts = {
'username': 'kgryte',
'useragent': 'hello-github!'
};
repos( opts, clbk );
To return repositories of a particular type, set the type
option.
var opts = {
'username': 'kgryte',
'type': 'owner'
};
repos( opts, clbk );
To return repositories of a particular visibility, set the visibility
option.
var opts = {
'token': 'tkjorjk34ek3nj4!',
'visibility': 'private'
};
repos( opts, clbk );
To return repositories of a particular affiliation, set the affiliation
option.
var opts = {
'token': 'tkjorjk34ek3nj4!',
'affiliation': 'collaborator,organization_member'
};
repos( opts, clbk );
repos.factory( options, clbk )
Creates a reusable function
.
var opts = {
'username': 'kgryte',
'token': 'tkjorjk34ek3nj4!'
};
var get = repos.factory( opts, clbk );
get();
get();
get();
// ...
The factory method accepts the same options
as repos()
.
Notes
- Either a
username
or atoken
or both must be provided. If provided atoken
, but not ausername
, thefunction
fetches repositories associated with the authenticated user. - If not provided a
token
, thefunction
can only return public repository meta data. - Rate limit information includes the following:
- limit: maximum number of requests a consumer is permitted to make per hour.
- remaining: number of remaining requests.
- reset: time at which the current rate limit window resets in UTC seconds.
Examples
var repos = require( 'github-user-repos' );
var opts = {
'username': 'kgryte',
'useragent': 'beep-boop-bop'
};
repos( opts, clbk );
function clbk( error, results, info ) {
if ( info ) {
console.error( info );
}
if ( error ) {
throw new Error( error.message );
}
console.log( results );
}
To run the example code from the top-level application directory,
$ DEBUG=* node ./examples/index.js
CLI
Installation
To use the module as a general utility, install the module globally
$ npm install -g github-user-repos
Usage
Usage: ghuserrepos [options]
Options:
-h, --help Print this message.
-V, --version Print the package version.
--token token Github access token.
--username username Github username.
-ua, --useragent ua User agent.
--visibility visibility Repository visibility: public, private, all.
--affiliation affiliation Repository affiliation.
--type type Repository type: forks, public, private, etc.
--sort sort Sort method: full_name, created, pushed, etc.
--direction dir Sort direction: asc, desc.
Notes
- In addition to the
token
option, the token may also be specified by aGITHUB_TOKEN
environment variable. The command-line option always takes precedence. - Request resources are written to
stdout
. - Rate limit information is written to
stderr
.
Examples
Setting the access token using the command-line option:
$ DEBUG=* ghuserrepos --token <token> --username kgryte
# => '[{...},{...},...]'
Setting the access token using an environment variable:
$ DEBUG=* GITHUB_TOKEN=<token> ghuserrepos --username kgryte
# => '[{...},{...},...]'
For local installations, modify the command to point to the local installation directory; e.g.,
$ DEBUG=* ./node_modules/.bin/ghuserrepos --token <token> --username kgryte
# => '[{...},{...},...]'
Or, if you have cloned this repository and run npm install
, modify the command to point to the executable; e.g.,
$ DEBUG=* node ./bin/cli --token <token> --username kgryte
# => '[{...},{...},...]'
Tests
Unit
This repository uses tape for unit tests. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
Browser Support
This repository uses Testling for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:
$ make test-browsers
To view the tests in a local web browser,
$ make view-browser-tests
License
Copyright
Copyright © 2016. Athan Reines.