{"id":27816,"library":"ghmap","title":"ghmap","description":"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.","status":"active","version":"2.0.4","language":"python","source_language":"en","source_url":"https://github.com/uhourri/ghmap","tags":["github","events","mapping","api","cli"],"install":[{"cmd":"pip install ghmap","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Required Python version","package":"python>=3.10","optional":false},{"reason":"HTTP requests to GitHub API","package":"requests","optional":false}],"imports":[{"wrong":"from ghmap import GHMap","symbol":"GHMap","correct":"import ghmap"}],"quickstart":{"code":"from ghmap import GHMap\nimport os\n\n# Initialize with token from environment\nghmap = GHMap(token=os.environ.get('GITHUB_TOKEN', ''))\n\n# Process events for a repository\nevents = ghmap.get_repo_events('owner/repo')\nsummary = ghmap.map_events(events)\nprint(summary)","lang":"python","description":"Quickstart showing how to initialize GHMap with a GitHub token and map events from a repository."},"warnings":[{"fix":"Provide a valid GITHUB_TOKEN via environment variable or constructor argument.","message":"In v2.0.0, the `get_repo_events` method now requires a token; previously it worked without authentication for public repos.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Replace `--output-format json` with `--format json`.","message":"The `--output-format` CLI argument was deprecated in v1.0.6 and removed in v2.0.0. Use `--format` instead.","severity":"deprecated","affected_versions":">=2.0.0"},{"fix":"Check return value with `if summary is not None:` or use `or` to provide a default.","message":"The `map_events` method returns `None` if no events are found, not an empty list.","severity":"gotcha","affected_versions":"All"},{"fix":"Use raw strings or forward slashes in config paths, or upgrade to >=2.0.1.","message":"On 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.","severity":"gotcha","affected_versions":">=2.0.0,<2.0.1"}],"env_vars":null,"search_vec":"'2.0.4':22 'activ':23 'analysi':7 'api':13,31 'cli':32 'data':14 'event':4,12,29 'generat':16 'ghmap':1 'github':3,11,28 'human':18 'human-read':17 'maintain':24 'map':5,30 'month':26 'process':10 'readabl':19 'releas':27 'summari':20 'tool':8 'version':21","created_at":"2026-05-09T05:52:14.491223+00:00","updated_at":"2026-05-09T05:52:14.491223+00:00","problems":null,"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":"ghmap","cli_version":"usage: ghmap [-h] --raw-events RAW_EVENTS --output-actions OUTPUT_ACTIONS","type":"library","homepage":null,"github":"https://github.com/uhourri/ghmap","docs":null,"changelog":null,"pypi":"https://pypi.org/project/ghmap/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["data","devops"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"passing","verified_at":"2026-07-03","last_verified":"2026-07-03","next_check":"2026-08-02","install_tag":null}}