# github3

> Node.js GitHub API (v3) Wrapper

Latest version **1.2.0** (published 2013-08-13) · 0 weekly downloads

## Install

```sh
npm install github3
pnpm add github3
yarn add github3
bun add github3
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2013-08-13 |
| First published | 2011-11-30 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 24 |
| Author | Edward Hotchkiss |
| Maintainers | edwardhotchkiss |
| Keywords | github, api, wrapper, git, 3 |

## Links

- npm: https://www.npmjs.com/package/github3
- Repository: https://github.com/edwardhotchkiss/github3
- Homepage: http://github.com/edwardhotchkiss/github3
- Issues: https://github.com/edwardhotchkiss/github3/issues
- npm.io page: https://npm.io/package/github3

## Dependencies (1)

- [request](https://npm.io/package/request.md) 2.12.0

## Alternatives

- [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads
- [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads
- [@openveo/api](https://npm.io/package/@openveo/api.md) — 61 weekly downloads
- [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads
- [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads

## Recent versions

- 1.2.0 (latest) — 2013-08-13
- 1.1.0 — 2013-07-02
- 1.0.0 — 2013-01-28
- 0.4.5 — 2012-07-18
- 0.4.4 — 2012-06-26
- 0.4.3 — 2012-06-09
- 0.4.2 — 2012-03-23
- 0.4.1 — 2012-03-11
- 0.4.0 — 2012-03-03
- 0.3.1 — 2012-03-03
- 0.3.0 — 2012-02-13
- 0.2.0 — 2012-01-29
- 0.1.0 — 2012-01-15
- 0.0.5 — 2012-01-14
- 0.0.3 — 2011-11-30

## README

# github 3 [![Build Status](https://secure.travis-ci.org/edwardhotchkiss/github3.png)](http://travis-ci.org/edwardhotchkiss/github3)

> Node.JS GitHub API (v3) Wrapper

### Installation

```bash
$ npm install github3
```

### Example Code

```javascript

var github3 = require('github3');

// get user information
github3.getUser('edwardhotchkiss', function(error, user) {
  console.log(user);
});

// get users repos
github3.getUserRepos('edwardhotchkiss', function(error, repos) {
  console.log(repos);
});

// get users watched repos
github3.getUsersWatched('edwardhotchkiss', function(error, watched) {
  console.log(watched);
});

// get an organizations github users
github3.getOrgMembers('github', function(error, members) {
  console.log(members);
});

```

### Roadmap to 1.0.0

	* Integrate oAuth Completely
	* Document fully all methods
	* Add Examples
	* Build a non-trivial app with `github3`
	* Release app on Nodejitsu
	* Release Github3 v1.0.0

### Running Tests

	* Tests are being reworked. Considering using process.env['github_username'] etc...?

### License (MIT)

Copyright (c) 2011, Edward Hotchkiss.

**

Author: [Edward Hotchkiss][0]

Contributors: [Mark Lussier][1], [@dolphin278][2], [Matias Woloski][3], [Tejesh Mehta][4], [wemotom][5] & [Matt Loar][6]
 
[0]: http://github.com/edwardhotchkiss/
[1]: https://github.com/intabulas/
[2]: https://github.com/dolphin278/
[3]: https://github.com/woloski/
[4]: https://github.com/tjmehta/
[5]: https://github.com/wemotom/
[6]: https://github.com/mloar/

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