ghmap

library2.0.4pypypi✓ verified 86d ago

A GitHub event mapping and analysis tool that processes GitHub Events API data to generate human-readable summaries. Version 2.0.4, actively maintained with monthly releases.

data devops

pip install ghmap

github ↗package ↗

INSTALL

IMPORT

SIG · GHMAP

ghmap

datapythonv2.0.4

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

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

GHMap

✓ import ghmap

✗ from ghmap import GHMap

Quickstart showing how to initialize GHMap with a GitHub token and map events from a repository.

from ghmap import GHMap import os # Initialize with token from environment ghmap = GHMap(token=os.environ.get('GITHUB_TOKEN', '')) # Process events for a repository events = ghmap.get_repo_events('owner/repo') summary = ghmap.map_events(events) print(summary)

ghmap --version

Debug

Known issues

breakingIn v2.0.0, the `get_repo_events` method now requires a token; previously it worked without authentication for public repos.

fix

Provide a valid GITHUB_TOKEN via environment variable or constructor argument.

affects: >=2.0.0

deprecatedThe `--output-format` CLI argument was deprecated in v1.0.6 and removed in v2.0.0. Use `--format` instead.

fix

Replace `--output-format json` with `--format json`.

affects: >=2.0.0

gotchaThe `map_events` method returns `None` if no events are found, not an empty list.

fix

Check return value with `if summary is not None:` or use `or` to provide a default.

affects: All

gotchaOn Windows, paths containing backslashes cause parsing errors in the config files. Fixed in v2.0.1 but if you use custom config paths, use forward slashes or raw strings.

fix

Use raw strings or forward slashes in config paths, or upgrade to >=2.0.1.

affects: >=2.0.0,<2.0.1

Upgrade

Version history

2.0.4latest on PyPI · released Mar 23, 2026

Audit

Dependencies

python>=3.10requiredRequired Python version

requestsrequiredHTTP requests to GitHub API

Agent activity

9 hits · last 30 days

node

Resources

githubhttps://github.com/uhourri/ghmap ↗

packagehttps://pypi.org/project/ghmap/ ↗