github-trend

Scraping GitHub Trending Repositories

github-trend is a library for scraping GitHub trending repositories.

Only scraping

const Trending = require('github-trend');
const scraper = new Trending.Scraper();
 
// Empty string means 'all languages'
scraper.scrapeTrendingReposFullInfo('').then(repos => {
    for (const repo of repos) {
        console.log(repo.owner);
        console.log(repo.name);
        console.log(repo.description);
        console.log(repo.language);
        console.log(repo.allStars);
        console.log(repo.todaysStars);
        console.log(repo.forks);
    }
}).catch(err => {
    console.error(err.message);
});
 
// For other languages
scraper.scrapeTrendingReposFullInfo('rust');
scraper.scrapeTrendingReposFullInfo('vim');
scraper.scrapeTrendingReposFullInfo('go');

Scraper only scrapes GitHub trending page. This returns an array of repository information. This method is relatively faster because of sending request only once per language.

Scraping and getting full repository information

const Trending = require('github-trend');
const client = new Trending.Client();
 
'lient.fetchTrending('').then(repos => {
    for (const repo of repos) {
        // Result of https://api.github.com/repos/:user/:name
        console.log(repo);
    }
}).catch(err => {
    console.error(err.message);
});
 
// Fetch all API call asynchronously
client.fetchTrendings(['', 'vim', 'go']).then(repos => {
    for (const lang in repos) {
        for (const repo of repos[lang]) {
            // Result of https://api.github.com/repos/:user/:name
            console.log(repo);
        }
    }
}).catch(err => {
    console.error(err.message);
});

Client contains scraper and scrapes GitHub trending page, then gets all repositories' full information using GitHub /repos/:user/:name API. This takes more time than only scraping, but all requests are sent asynchronously and in parallel.

Scraping language information

const Trending = require('github-trend');
const scraper = new Trending.Scraper();
 
scraper.scrapeLanguageYAML().then(langs => {
    for (const name in langs) {
        console.log(name);
        console.log(langs[name]);
    }
}).catch(err => {
    console.error(err.message);
});

This returns all languages information detected in GitHub by scraping here. The result is cached and reused.

Scraping language colors

const Trending = require('github-trend');
const scraper = new Trending.Scraper();
 
scraper.scrapeLanguageColors().then(colors => {
    for (const name in colors) {
        console.log('name: ' + name);
        console.log('color: ' + colors[name]);
    }
}).catch(err => {
    console.error(err.message);
});
 
// If you want only language names:
scraper.scrapeLanguageNames().then(names => {
    for (const name of names) {
        console.log(name);
    }
}).catch(err => {
    console.error(err.message);
});

Collect trending repositories by scraping and GitHub API

By scraping GitHub Trending Repositories page, the information is restricted to the information rendered in the page. This library also supports to getting information of trending repositories using GitHub Repositories API.

Although an API token (at the first parameter of new Client) is not mandatory, it is recommended for avoiding API rate limit.

const {Client} = require('github-trend');
const client = new Client({token: 'API access token here'});
 
client.fetchTrending('all').then(repos => {
    for (const repo of repos) {
        console.log('Name:', repo.full_name);
        console.log('ID:', repo.id);
        console.log('Topics:', repo.topics.join(' '));
        console.log('License:', repo.license.name);
    }
}).catch(console.error);

License

Distributed under the MIT license.