# github-trend

> node.js library for GitHub trending repositories

Latest version **1.2.0** (published 2018-01-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-trend
pnpm add github-trend
yarn add github-trend
bun add github-trend
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2018-01-10 |
| First published | 2015-09-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 21 |
| Author | rhysd |
| Maintainers | rhysd |

## Links

- npm: https://www.npmjs.com/package/github-trend
- Repository: https://github.com/rhysd/node-github-trend
- Homepage: https://github.com/rhysd/node-github-trend#readme
- Issues: https://github.com/rhysd/node-github-trend/issues
- npm.io page: https://npm.io/package/github-trend

## Dependencies (3)

- [cheerio](https://npm.io/package/cheerio.md) ^0.22.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.10.0
- [request](https://npm.io/package/request.md) ^2.83.0

## Recent versions

- 1.2.0 (latest) — 2018-01-10
- 1.1.0 — 2018-01-09
- 1.0.1 — 2018-01-09
- 1.0.0 — 2018-01-09
- 0.3.0 — 2018-01-08
- 0.2.2 — 2018-01-05
- 0.2.1 — 2018-01-03
- 0.2.0 — 2018-01-02
- 0.1.3 — 2017-12-31
- 0.1.2 — 2017-11-09
- 0.1.1 — 2017-09-12
- 0.1.0 — 2017-01-18
- 0.0.6 — 2015-09-28
- 0.0.5 — 2015-09-14
- 0.0.4 — 2015-09-10
- … 3 more at https://npm.io/package/github-trend/versions

## README

Scraping GitHub Trending Repositories
=====================================
[![npm version](https://badge.fury.io/js/github-trend.svg)](http://badge.fury.io/js/github-trend)
[![Build Status](https://travis-ci.org/rhysd/node-github-trend.svg?branch=travis)](https://travis-ci.org/rhysd/node-github-trend)

[github-trend](https://www.npmjs.com/package/github-trend) is a library for scraping GitHub trending repositories.

## Only scraping

```javascript
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

```javascript
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

```javascript
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](https://raw.githubusercontent.com/github/linguist/master/lib/linguist/languages.yml).
The result is cached and reused.

## Scraping language colors

```javascript
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.

```javascript
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](LICENSE.txt).

---
_Source: https://npm.io/package/github-trend · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._