https://github.com/pine/github-contribution-stats

:octocat: GitHub contribution stat utilities.
https://github.com/pine/github-contribution-stats

Last synced: 6 months ago
JSON representation

:octocat: GitHub contribution stat utilities.

• Host: GitHub
• URL: https://github.com/pine/github-contribution-stats
• Owner: pine
• License: mit
• Created: 2019-05-30T13:55:30.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2021-04-28T05:51:41.000Z (almost 5 years ago)
• Last Synced: 2025-07-06T13:47:18.203Z (10 months ago)
• Language: Java
• Homepage: https://bintray.com/pinemz/maven/github-contribution-stats
• Size: 809 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# github-contribution-stats

[![Build Status](https://travis-ci.com/pine/github-contribution-stats.svg?branch=master)](https://travis-ci.com/pine/github-contribution-stats)

[![codecov](https://codecov.io/gh/pine/github-contribution-stats/branch/master/graph/badge.svg)](https://codecov.io/gh/pine/github-contribution-stats)

[![Download](https://api.bintray.com/packages/pinemz/maven/github-contribution-stats/images/download.svg)](https://bintray.com/pinemz/maven/github-contribution-stats)

:octocat: GitHub contribution stat utilities.

![](pr/readme.jpg)


© PaylessImages/123RF.COM







## Requirements

- Java 8 or later

## Getting started

The library is published to [jcenter](https://bintray.com/pinemz/maven/github-contribution-stats). Please replace `$latest_version` with [![Download](https://api.bintray.com/packages/pinemz/maven/github-contribution-stats/images/download.svg)](https://bintray.com/pinemz/maven/github-contribution-stats).

```gradle

repositories {

    jcenter()

}

depepdencies {

    implementation "moe.pine:github-contribution-stats:$latest_version"

}

```

## Usage

```java

import moe.pine.github.contribution.stats.ContributionStats;

import moe.pine.github.contribution.stats.ContributionStatsClient;

class Main {

    public static void main(String ...args) {

        final ContributionStatsClient client = ContributionStatsClient.create();

        final ContributionStats stats = client.collect("username");

        System.out.println(stats);

        // => ContributionStats{

        //      contributions=[

        //        Contribution{ date=2018-10-14, count=3 },

        //        Contribution{ date=2018-10-15, count=3 }

        //        Contribution{ date=2018-10-16, count=1 },

        //        ...

        //      ],

        //      currentStreak=Streak{ days=27, start=2019-09-23, end=2019-10-19, unmeasurable=false }, 

        //      longestStreak=Streak{ days=40, start=2019-07-26, end=2019-09-03, unmeasurable=false },

        //      summary=Summary{

        //        start=2018-10-14,

        //        end=2019-10-19,

        //        total=2888,

        //        busiestDay=Contribution{ date=2019-07-07, count=108 }

        //      }

        //    })

    }

}

```

## Development

### Test

```bash

$ ./gradlew clean test

```

### Upload Bintray

```bash

$ export BINTRAY_USER=username

$ export BINTRAY_KEY=apiKey

$ ./gradlew clean assemble bintrayUpload

```

## Thanks

This library is Java port of [moqada/github-contribution-stats](https://github.com/moqada/github-contribution-stats).

## License

MIT © [Pine Mizune](https://profile.pine.moe)