https://github.com/akerl/githubchart

Contribution plotting from GitHub's feed
https://github.com/akerl/githubchart

Last synced: 1 day ago
JSON representation

Contribution plotting from GitHub's feed

• Host: GitHub
• URL: https://github.com/akerl/githubchart
• Owner: akerl
• License: mit
• Created: 2013-09-19T14:55:36.000Z (about 11 years ago)
• Default Branch: main
• Last Pushed: 2023-07-18T15:48:57.000Z (over 1 year ago)
• Last Synced: 2024-10-02T19:29:49.392Z (about 1 month ago)
• Language: Ruby
• Homepage:
• Size: 12.7 MB
• Stars: 149
• Watchers: 5
• Forks: 13
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
GithubChart

============

[![Gem Version](https://img.shields.io/gem/v/githubchart.svg)](https://rubygems.org/gems/githubchart)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/akerl/githubchart/build.yml?branch=main)](https://github.com/akerl/githubchart/actions)

[![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)

Generates an SVG of your Github contributions:

![Example image](http://akerl.github.io/githubchart/chart.svg)

![Other user example](http://akerl.github.io/githubchart/other_user.svg)

## Usage

Run `githubchart path/to/svg` to generate an SVG. To override the default username (pulled from your local shell or .gitconfig), use `githubchart -u username path/to/svg`

GithubChart also allows you to provide input from a file instead of pulling data from Github. You can pass JSON to GithubChart by using `githubchart -i /path/to/file /path/to/svg`, or use '-' to use STDIN. See spec/examples/input.json for example data.

If you don't provide a file path, the resulting SVG will be printed to stdout.

To modify the color scheme used, you can provide `-c SCHEME`. For example, `githubchart -c halloween` uses GitHub's halloween colors. Use `-s` to list the available schemes.

### Hosted SVG

A hosted service for loading these SVGs was made by [2016rshah](https://github.com/2016rshah): http://ghchart.rshah.org/ ([source code](https://github.com/2016rshah/githubchart-api))

## Installation

    gem install githubchart

## License

githubchart is released under the MIT License. See the bundled LICENSE file for details.