1
0
mirror of https://github.com/nikolaydubina/calendarheatmap.git synced 2025-01-19 04:48:10 +02:00
calendarheatmap/README.md
2020-07-11 17:29:14 +08:00

2.1 KiB

Go Report Card GoDev codecov Awesome

Self-contained, plain Go implementation of calendar heatmap inspired by Github contribution activity.

Basic basic

Colorscales col1 col2

Without month separator nosep

Without labels nolab

Without labels, without separator nosep_nolab

Example module, next save output in formats supported by image module (PNG, JPEG, GIF).

countByDayOfYear := map[int]int{
    1: 10,
    22: 15,
    150: 22,
    366: 55,
    ...
}

img := charts.NewHeatmap(charts.HeatmapConfig{
    Year:               2020,
    CountByDay:         countByDay,
    ColorScale:         colorscales.PuBu9,
    DrawMonthSeparator: true,
    DrawLabels:         true,
    ...
})

Example script, will output as PNG.

$ go build; ./calendarheatmap -h

Usage of ./calendarheatmap:
  -colorscale string
        refer to colorscales for examples (default "PuBu9")
  -input string
        file should contain lines in format: 2020-05-16 20:43 PPPP (default "input.txt")
  -labels
        labels for weekday and months (default true)
  -monthsep
        render month separator (default true)
  -output string
        output filename, will export as PNG (default "chart.png")
  -output-format string
        output format (png, jpeg, gif) (default "png"))

TODO:

  • SVG support
  • select start and end date
  • CSV, JSON in script input