github-heatmap 0.1.0

A CLI tool used to scrape a Github profile and mirror the SVG contribution heatmap as Unicode.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

# github-heatmap

A CLI tool built with Rust to scrape a Github profile and mirror the SVG heatmap as Unicode.

This is intended to be a fun little project to play around with scraping with Rust. I know that it's not the most efficient way to get these results, especially given that Github's GraphQL API is quite extensive.

## Basic Usage

`github-heatmap <slug> <args>`

## Arguments

| Argument | Alias | Description                                                                                                 | Type                 | Default |
| -------- | ----- | ----------------------------------------------------------------------------------------------------------- | -------------------- | ------- |
| Slug     |       | Github profile slug, e.g. torvalds                                                                          | String               |         |
| --color  | -c    | Heatmap color scheme. Nodes will be shaded depending on heat level.                                         | red \| green \| blue | green   |
| --year   | -y    | Specific year to fetch contributions. If not provided, contributions will be fetched for the last 365 days. | String               |         |

### Examples

#### Default arguments

`github-heatmap torvalds`

![default example](examples/default.jpg)

#### Alternative Color

`github-heatmap torvalds -c blue`

![alternative colors example](examples/colors.jpg)

#### Filter by year

`github-heatmap torvalds -y 2022`

![filter by years example](examples/years.jpg)

## TODO

- [x] Error handling
- [x] Argument validation/value parsers
- [x] Testing
- [ ] Documentation
- [ ] Publish to crates.io