Registry / data / github-heatmap

github-heatmap

JSON →
library2.3.0pypypiunverified

Generate SVG heatmaps and skyline visualizations for GitHub-like contribution graphs. Version 2.3.0 is the latest. Active development with frequent releases.

datadevops
github ↗package ↗
Install & Compatibility
Where this runs
tested against v2.3.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.000s · 28.5MB
glibc
py 3.10–3.95 runs
installs and imports cleanly · install 2.8s · import 0.000s · 29MB
27MB installed
● package 27MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

from github_heatmap import GitHubPoster

Initialize with a GitHub token, generate a heatmap SVG for a given user and year.

import os from github_heatmap import GitHubPoster poster = GitHubPoster(token=os.environ.get('GITHUB_TOKEN', '')) poster.run(username='example_user', year=2023) with open('output.svg', 'rb') as f: print(f.read()[:100])
gh-heatmap --version
Debug
Known footguns
gotchaThe GitHub token must have the 'repo' and 'user' scopes. Using a token without the correct scopes will result in a 403 or empty output.
breakingVersion 2.x changed the API: the main class is now 'GitHubPoster' instead of 'Poster'. The 'run' method now accepts 'year' as integer (not 'years' list).
deprecatedThe 'mode' parameter (e.g., 'mode=github') is deprecated. Version 2.3.0 auto-detects the platform.
Upgrade
Version history

Breaking-change detection hasn't run for this library yet.

Audit
Security & dependencies

CVE tracking and dependency tree are planned for a later release.

Agent activity
15 hits · last 30 days
gptbot
4
ahrefsbot
4
bytedance
3
claudebot
3
script
1
Resources
githubhttps://github.com/malinkang/GitHubPoster ↗
packagehttps://pypi.org/project/github-heatmap/ ↗