Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/IonicaBizau/node-gh-polyglot
:seat: Get language stats about GitHub users and repositories.
https://github.com/IonicaBizau/node-gh-polyglot
hacktoberfest
Last synced: 3 months ago
JSON representation
:seat: Get language stats about GitHub users and repositories.
- Host: GitHub
- URL: https://github.com/IonicaBizau/node-gh-polyglot
- Owner: IonicaBizau
- License: mit
- Created: 2015-05-24T17:36:47.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-11-03T03:11:59.000Z (about 4 years ago)
- Last Synced: 2024-07-21T23:46:35.551Z (4 months ago)
- Topics: hacktoberfest
- Language: JavaScript
- Size: 65.4 KB
- Stars: 82
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](#)
# gh-polyglot
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/gh-polyglot) [](https://www.npmjs.com/package/gh-polyglot) [](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
> Get language stats about GitHub users and repositories.
## :cloud: Installation
```sh
# Using npm
npm install --save gh-polyglot
# Using yarn
yarn add gh-polyglot
```
Using this library on the client side is possible as well, but it's dependent on [`gh.js`](https://github.com/IonicaBizau/gh.js).
```html
```
## :clipboard: Example
```js
// Dependencies
var GhPolyglot = require("gh-polyglot");
// Stats about git-stats
var me = new GhPolyglot("IonicaBizau/git-stats");
// Repository stats
me.repoStats(function (err, stats) {
console.log(err || stats);
});
// User stats
me.userStats(function (err, stats) {
console.log(err || stats);
});
```
## :question: Get Help
There are few ways to get help:
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
## :memo: Documentation
### `GhPolyglot(input, token, host)`
Creates a new instance of `GhPolyglot`.
#### Params
- **String** `input`: The repository full name (e.g. `"IonicaBizau/gh-polyglot"`) or the username (e.g. `"IonicaBizau"`).
- **String** `token`: An optional GitHub token used for making authenticated requests.
- **String** `host`: An optional alternative Github FQDN (e.g. `"https://github.myenterprise.com/api/v3/"`)
#### Return
- **GhPolyglot** The `GhPolyglot` instance.
### `getAllRepos(callback)`
Gets all user's repositories.
#### Params
- **Function** `callback`: The callback function.
#### Return
- **Request** The request object.
### `repoStats(callback)`
Gets repository stats.
#### Params
- **Function** `callback`: The callback function.
#### Return
- **Request** The request object.
### `userStats(callback)`
Gets user stats.
#### Params
- **Function** `callback`: The callback function.
#### Return
- **Request** The request object.
### `check(callback)`
Wraps the callback in another function to manipulate the data.
#### Params
- **Function** `callback`: The callback function.
#### Return
- **Function** The wrapping function which gets the `err` and `data` arguments and changes the data converting it into an array.
## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
## :sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
- Starring and sharing the projects you like :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
Thanks! :heart:
## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
- `github-stats`
## :scroll: License
[MIT][license] © [Ionică Bizău][website]
[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW