| Name | github-user-activity-ehdlg JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | CLI application that fetches an ddisplays the recent activity of a specified GitHub user |
| upload_time | 2024-09-18 17:00:47 |
| maintainer | None |
| docs_url | None |
| author | Enrique Hidalgo |
| requires_python | >=3.9 |
| license | None |
| keywords |
github
cli
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# GitHub User Activity CLI
This is a simple Python-based CLI application that fetches and displays the recent activity
of a specified GitHub user. This project is part of
[roadmap.sh's GitHub User Activity Project](https://roadmap.sh/projects/github-user-activity),
and the goal of this program is to practice making HTTP requests and using Python modules like
`requests` , while also getting familiar with `match` cases for handling different types of events.
## Features
- Fetches recent activity of a GitHub user using the GitHub Events API.
- Displays events such as push commits, opened issues, starred repositories, and more.
- Validates that a GitHub username is provided and that the user exists.
- Option to specify a limit on the number of recent events to display.
- Error handling, including missing username, user not found and API error scenarios.
## Installation
1. **Clone the repository:**
```bash
git clone git@github.com:ehdlg/github-user-activity.git
```
2. **Navigate to the project directory**:
```bash
cd github-user-activity
```
3. **Install the dependencies:**
Make sure you have pip installed and then run:
```bash
pip install -r requirements.txt
```
## Usage
To run the application, use the following command:
```bash
python main.py <username> [filter]
```
Where:
- < username >: The GitHub username for which you want to fetch recent activity.
- [filter] (optional): A filter to specify the number of events to display. If not provided, the last 30 events will be shown.
### Examples
- Display recent activity of a user without a limit:
```bash
python main.py example_user
```
- Display the first 10 recent events of a user:
```bash
python main.py example_user 10
```
Raw data
{
"_id": null,
"home_page": null,
"name": "github-user-activity-ehdlg",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "github, cli",
"author": "Enrique Hidalgo",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/79/1d/e5e4823310fa03f93b7117f3020c58c4ba75415b361202d60441ea1f3968/github_user_activity_ehdlg-1.0.0.tar.gz",
"platform": null,
"description": "# GitHub User Activity CLI\n\nThis is a simple Python-based CLI application that fetches and displays the recent activity\nof a specified GitHub user. This project is part of\n[roadmap.sh's GitHub User Activity Project](https://roadmap.sh/projects/github-user-activity),\nand the goal of this program is to practice making HTTP requests and using Python modules like\n`requests` , while also getting familiar with `match` cases for handling different types of events.\n\n## Features\n\n- Fetches recent activity of a GitHub user using the GitHub Events API.\n- Displays events such as push commits, opened issues, starred repositories, and more.\n- Validates that a GitHub username is provided and that the user exists.\n- Option to specify a limit on the number of recent events to display.\n- Error handling, including missing username, user not found and API error scenarios.\n\n## Installation\n\n1. **Clone the repository:**\n\n ```bash\n git clone git@github.com:ehdlg/github-user-activity.git\n ```\n\n2. **Navigate to the project directory**:\n\n ```bash\n cd github-user-activity\n ```\n\n3. **Install the dependencies:**\n Make sure you have pip installed and then run:\n ```bash\n pip install -r requirements.txt\n ```\n\n## Usage\n\nTo run the application, use the following command:\n\n```bash\npython main.py <username> [filter]\n```\n\nWhere:\n\n- < username >: The GitHub username for which you want to fetch recent activity.\n- [filter] (optional): A filter to specify the number of events to display. If not provided, the last 30 events will be shown.\n\n### Examples\n\n- Display recent activity of a user without a limit:\n\n ```bash\n python main.py example_user\n ```\n\n- Display the first 10 recent events of a user:\n\n ```bash\n python main.py example_user 10\n ```\n",
"bugtrack_url": null,
"license": null,
"summary": "CLI application that fetches an ddisplays the recent activity of a specified GitHub user",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/ehdlg/github-user-activity"
},
"split_keywords": [
"github",
" cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "62a5b40b4feb52c67956fdadb17ace11cdb8fc478eb64f2307b532b6cf894c5f",
"md5": "b8d2b63e693808a71c3cbaf257e6a457",
"sha256": "8570fabb408f2bf19802e6c2e9b3af7909206c03d8132183bfae3641246726b0"
},
"downloads": -1,
"filename": "github_user_activity_ehdlg-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b8d2b63e693808a71c3cbaf257e6a457",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 3932,
"upload_time": "2024-09-18T17:00:45",
"upload_time_iso_8601": "2024-09-18T17:00:45.915944Z",
"url": "https://files.pythonhosted.org/packages/62/a5/b40b4feb52c67956fdadb17ace11cdb8fc478eb64f2307b532b6cf894c5f/github_user_activity_ehdlg-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "791de5e4823310fa03f93b7117f3020c58c4ba75415b361202d60441ea1f3968",
"md5": "4ef4e6fcd24978fdc3bec9f81e3da382",
"sha256": "ba5c2b4583cf3832a1492cf17efbff598cbf0d0bc1d09627c95091f41f406ed2"
},
"downloads": -1,
"filename": "github_user_activity_ehdlg-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4ef4e6fcd24978fdc3bec9f81e3da382",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 3098,
"upload_time": "2024-09-18T17:00:47",
"upload_time_iso_8601": "2024-09-18T17:00:47.638847Z",
"url": "https://files.pythonhosted.org/packages/79/1d/e5e4823310fa03f93b7117f3020c58c4ba75415b361202d60441ea1f3968/github_user_activity_ehdlg-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-18 17:00:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ehdlg",
"github_project": "github-user-activity",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "github-user-activity-ehdlg"
}
