node package manager

getcontributors

Fetch all the contributors of all the specified github users repositories

Get Contributors

Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Gratipay donate button Flattr donate button PayPayl donate button BitCoin donate button Wishlist browse button

Fetch all the contributors of all the specified github users repositories

Install

NPM

  • Use: require('getcontributors')
  • Install: npm install --save getcontributors

Usage

// Create our getcontributors instance 
var getter = require('getcontributors').create({
    githubClientId: null,      // optional, will try process.env.GITHUB_CLIENT_ID 
    githubClientSecret: null,  // optional, will try process.env.GITHUB_CLIENT_SECRET 
    log: console.log           // optional, arguments: level, message...  
});
 
// Fetch all the contributors on these github repositories 
getter.fetchContributorsFromRepos(['bevry/getcontributors'], function(err, contributors){
    console.log(err, contributors);
 
    // Fetch all the contributors on these github users/organisations 
    getter.fetchContributorsFromUsers(['bevry'], function(err, contributors){
        console.log(err, contributors);
 
        // Get the combined listing 
        console.log(getter.getContributors());
    });
});

Contributors are returned as an array of contributor objects, here is an example contributor object:

{
    name: "Benjamin Lupton",
    email: "b@lupton.cc",
    url: "https://github.com/balupton",
    username: "balupton",
    text: "Benjamin Lupton <b@lupton.cc> (https://github.com/balupton)",
    repos: {
        "bevry/docpad": "https://github.com/bevry/docpad",
        "bevry/getcontributors": "https://github.com/bevry/getcontributors"
        // ... 
    }
}

History

Discover the change history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

  • Benjamin Lupton b@lupton.cc (https://github.com/balupton)

Sponsors

No sponsors yet! Will you be the first?

Gratipay donate button Flattr donate button PayPayl donate button BitCoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Become a contributor!

License

Licensed under the incredibly permissive MIT license

Copyright © 2013+ Bevry Pty Ltd us@bevry.me (http://bevry.me)