# gictivity

> Activities of a github user.

Latest version **1.0.1** (published 2016-07-11) · MIT license · 0 weekly downloads

## Install

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

## 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.0.1 |
| Published | 2016-07-11 |
| First published | 2016-06-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Rishi Giri |
| Maintainers | rishi |
| Keywords | github, git, find, total, pinned, day, days, year, weeks, month, count, contributions, repository |

## Links

- npm: https://www.npmjs.com/package/gictivity
- Repository: https://github.com/CodeDotJS/gictivity
- Homepage: https://github.com/CodeDotJS/gictivity#readme
- Issues: https://github.com/CodeDotJS/gictivity/issues
- npm.io page: https://npm.io/package/gictivity

## Dependencies (3)

- [got](https://npm.io/package/got.md) *
- [cheerio](https://npm.io/package/cheerio.md) *
- [pinkie-promise](https://npm.io/package/pinkie-promise.md) *

## Recent versions

- 1.0.1 (latest) — 2016-07-11
- 1.0.0 — 2016-06-22

## README

# gictivity

> Activities of a github user.

[![Build Status](https://travis-ci.org/CodeDotJS/gictivity.svg?branch=master)](https://travis-ci.org/CodeDotJS/gictivity)

## Install

```
$ npm install --save gictivity
```

## Usage

- `Pinned Repos`

```js
const gictivity = require('gictivity');

gictivity.pin('CodeDotJS').then(repo => {
	console.log(repo);
	/*
	{
		'repo1': instavim,
		'repo2': facebook-mass-comments,
		'repo3': feross/nagger,
		'repo4': pagespeed-score-cli,
		'repo5': sindresorhus/fast-cli
	}
	*/
});
```

__```TOTAL PUBLIC CONTRIBUTIONS```__

- `Last Year :`

```js
const gictivity = require('gictivity');

gictivity.year('CodeDotJS').then(count => {
	console.log(count);
	// => 1,793 contributions in the last year
});
```

__```CONTRIBUTION PERIOD```__

`Also available for` __`3 days`__, __`week`__ and __`month`__

- `For 1 day :`

```js
const gictivity = require('gictivity');

gictivity.day('CodeDotJS').then(contributions => {
	console.log(contributions);
	// => { commits: '9 commits', pulls: null, issues: null }
})
```

__```NOTE :```__ `returns` __```null```__ `if values are not set or found in user's github profile`

## API

### __```gictivity.pin('username')```__

- `returns all the pinned repositories's names.`

### __```gictivity.day('username')```__

- `returns total contribution made within a day.`

### __```gictivity.days('username')```__

- `returns total contributions made within 3 days.`

### __```gictivity.week('username')```__

- `returns total contribution made within a week.`

### __```gictivity.month('username')```__

- `returns total contribution made within a month.`

### __```gictivity.year('username')```__

- `returns total contribution made by a github user in a year.`

### __```username```__

### __```TYPE :```__ __```string```__

## Related

- [stafo](https://github.com/CodeDotJS/stafo) : Get the total number of stars and forks on a particular github repository.

## License

MIT © [Rishi Giri](http://rishigiri.com)

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