Have ideas to improve npm?Join in the discussion! »

    gictivity

    1.0.1 • Public • Published

    gictivity

    Activities of a github user.

    Build Status

    Install

    $ npm install --save gictivity
    

    Usage

    • Pinned Repos
    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 :
    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 :
    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 : Get the total number of stars and forks on a particular github repository.

    License

    MIT © Rishi Giri

    Install

    npm i gictivity

    DownloadsWeekly Downloads

    1

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • avatar