github-calendar-parser

[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations]    

> Parses the GitHub contributions calendar SVG code into JSON.

:cloud: Installation

``sh


Using npm

npm install --save github-calendar-parser

Using yarn

yarn add github-calendar-parser
`

:clipboard: Example

`js
const parse = require("github-calendar-parser");

var svg =



2 contributions on January 9, 2022
15 contributions on January 10, 2022
No contributions on January 11, 2022
45 contributions on January 12, 2022
2 contributions on January 13, 2022
No contributions on January 14, 2022
1 contribution on January 15, 2022


6 contributions on January 16, 2022
No contributions on January 17, 2022
2 contributions on January 18, 2022
No contributions on January 19, 2022
4 contributions on January 20, 2022
1 contribution on January 21, 2022
No contributions on January 22, 2022



;

console.log(parse(svg))

// {
// last_year: 78,
// longest_streak: 2,
// longest_streak_range: [ 2022-01-09T00:00:00.000Z, 2022-01-10T00:00:00.000Z ],
// current_streak: 0,
// current_streak_range: [ 2022-01-20T00:00:00.000Z, 2022-01-21T00:00:00.000Z ],
// longest_break: 1,
// longest_break_range: [ 2022-01-11T00:00:00.000Z, 2022-01-11T00:00:00.000Z ],
// current_break: 1,
// current_break_range: [ 2022-01-22T00:00:00.000Z, 2022-01-22T00:00:00.000Z ],
// weeks: [
// [
// [Object], [Object],
// [Object], [Object],
// [Object], [Object],
// [Object]
// ]
// ],
// days: [
// {
// fill: '#eee',
// date: 2022-01-09T00:00:00.000Z,
// count: 2,
// level: '0'
// },
// {
// fill: '#eee',
// date: 2022-01-10T00:00:00.000Z,
// count: 15,
// level: '0'
// },
// ...
// {
// fill: '#d6e685',
// date: 2022-01-21T00:00:00.000Z,
// count: 1,
// level: '1'
// },
// {
// fill: '#eee',
// date: 2022-01-22T00:00:00.000Z,
// count: 0,
// level: '0'
// }
// ],
// last_contributed: 2022-01-21T00:00:00.000Z
// }
`




:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation




$3

Parses the SVG input (as string).

#### Params

- String input: The SVG code of the contributions calendar.

#### Return
- Object An object containing:
- last_year (Number): The total contributions in the last year.
- longest_streak (Number): The longest streak.
- longest_streak_range (Array): An array of two date objects representing the date range.
- current_streak (Number): The current streak.
- current_streak_range (Array): An array of two date objects representing the date range.
- days (Array): An array of day objects:
- fill (String): The hex color.
- date (Date): The day date.
- count (Number): The number of commits.
- level (Number): A number between 0 and 4 (inclusive) representing the contribution level (more commits, higher value).
- weeks (Array): The day objects grouped by weeks (arrays).
- last_contributed (Date): The last contribution date.




:yum: How to contribute

Have an idea? Found a bug? See [how to contribute][contributing].

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:


- Starring and sharing the projects you like :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

![](https://i.imgur.com/z6OQI95.png)


Thanks! :heart:




:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

- @xwl7001/react-github-calendar
- github-calendar
- react-github-calendar-x`

:scroll: License

[MIT][license] © [Ionică Bizău][website]

[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW