Skip to main content

A Python CLI tool that displays recent GitHub user activity

Project description

GitHub Activity CLI

A Python CLI tool that displays recent GitHub user activity. This GitHub activity CLI fetches public events from the GitHub API and summarizes commits, issues, stars, and pull requests per repository.

This project is inspired by the roadmap.sh backend project: https://roadmap.sh/projects/github-user-activity


Features

  • Fetch recent public GitHub activity for any user
  • Group activities by repository
  • Display readable summaries such as:
    • Commits pushed
    • Issues opened
    • Comments on issues
    • Pull requests
    • Stars
  • Installable as a global CLI command

Installation

Clone the repository

git clone https://github.com/andrew-NM/Task-Tracker-CLI.git
cd Task-Tracker-CLI

Install locally (editable mode)

pip install -e .

Usage

github-activity <username>

Example

github-activity kamranahmedse

output

- Pushed 1 commit to andrew-NM/github-user-activity-cli
- Pushed 13 commits to andrew-NM/Task-Tracker-CLI

Project Structure

github_activity/
├── github_activity/
│   ├── __init__.py
│   └── cli.py
├── pyproject.toml
└── README.md

Dependencies

  • Python 3.8+
  • requests All dependencies are automatically installed via pip.

Notes

  • The tool uses GitHub’s public events API.

  • Only supported event types are counted:

    • PushEvent

    • IssuesEvent

    • IssueCommentEvent

    • PullRequestEvent

    • WatchEvent

  • Other event types are safely ignored.

  • GitHub API rate limits may apply for unauthenticated request.


License

This project is licensed under the MIT License. See the LICENSE file for details.


Contact

Andrew Naeem - @andrew-nm

Project Link: https://github.com/andrew-NM/github-activity-cli

Email Address: andrewnaeem7@gmail.com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

github_user_activity_cli_v2-0.1.0.tar.gz (3.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

github_user_activity_cli_v2-0.1.0-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file github_user_activity_cli_v2-0.1.0.tar.gz.

File metadata

File hashes

Hashes for github_user_activity_cli_v2-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3b56b61d39b184ac68356e060c73865304ae31525f638cc5c20c6a0bfdf2652a
MD5 440bea9aaf563448723144388027fd05
BLAKE2b-256 d509620ae0c467fd1dabe0b86d0a43a9ba3d61bc9d4343cacc7e7cc3f4f1e788

See more details on using hashes here.

File details

Details for the file github_user_activity_cli_v2-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for github_user_activity_cli_v2-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a351f886f769da05453278153d7ba3100cc362b7e16a7bc583f24bcddc9fb1ba
MD5 fd468364bff59818764ec3cc3030dd97
BLAKE2b-256 ffdac664fb11e7f4a04e43fcf229ef4d449b92dbb97d9e478d3296d6b6f3b951

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page