npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

github-trend

v1.2.0

Published

node.js library for GitHub trending repositories

Downloads

9

Readme

Scraping GitHub Trending Repositories

npm version Build Status

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.