Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/p-nelly/github-activity
A Python CLI tool that displays GitHub user activity in real-time. Simply enter a username to see their recent commits, issues, and stars in a clean console format. Perfect for quickly checking GitHub activity without opening a browser.
https://github.com/p-nelly/github-activity
cli github-api python
Last synced: about 9 hours ago
JSON representation
A Python CLI tool that displays GitHub user activity in real-time. Simply enter a username to see their recent commits, issues, and stars in a clean console format. Perfect for quickly checking GitHub activity without opening a browser.
- Host: GitHub
- URL: https://github.com/p-nelly/github-activity
- Owner: P-Nelly
- License: mit
- Created: 2024-12-18T20:25:08.000Z (23 days ago)
- Default Branch: master
- Last Pushed: 2024-12-18T20:40:20.000Z (23 days ago)
- Last Synced: 2024-12-18T21:28:42.049Z (23 days ago)
- Topics: cli, github-api, python
- Language: Python
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
GITHUB-ACTIVITY
❯ A Python CLI tool to fetch and display GitHub user activity
## Table of Contents
- [ Overview](#overview)
- [ Features](#features)
- [ Project Structure](#project-structure)
- [ Project Index](#project-index)
- [ Getting Started](#getting-started)
- [ Prerequisites](#prerequisites)
- [ Installation](#installation)
- [ Usage](#usage)
- [ Testing](#testing)
- [ Project Roadmap](#project-roadmap)
- [ Contributing](#contributing)
- [ License](#license)
- [ Acknowledgments](#acknowledgments)
---
## Overview
GitHub Activity is a command-line interface tool that fetches and displays recent GitHub activities for any specified user. It shows various events including pushes, issue interactions, and repository stars in a clean, readable format.
---
## Features
- 🔍 Fetch recent GitHub activity for any user
- 📊 Display multiple event types:
- Push events with commit counts
- Issue interactions (opening/closing)
- Repository starring
- Other GitHub events
- 🛠️ Simple CLI interface
- 🔄 Real-time data from GitHub API
---
## Project Structure
```sh
└── github-activity/
├── LICENSE
├── README.md
├── CONTRIBUTING.md
└── main.py
```
### Project Index
GITHUB-ACTIVITY/
__root__
main.py
❯ Main script containing the GitHub activity fetching and display logic
---
## Getting Started
### Prerequisites
Before getting started with github-activity, ensure your runtime environment meets the following requirements:
- **Programming Language:** Python
### Installation
Install github-activity using one of the following methods:
**Build from source:**
1. Clone the github-activity repository:
```sh
❯ git clone https://github.com/P-Nelly/github-activity
```
2. Navigate to the project directory:
```sh
❯ cd github-activity
```
3. Install the project dependencies:
echo 'INSERT-INSTALL-COMMAND-HERE'
### Usage
Run github-activity using the following command:
echo 'INSERT-RUN-COMMAND-HERE'
### Testing
Run the test suite using the following command:
echo 'INSERT-TEST-COMMAND-HERE'
---
## Project Roadmap
- [X] **`Task 1`**: Implement basic GitHub activity fetching
- [ ] **`Task 2`**: Add authentication for increased API rate limits
- [ ] **`Task 3`**: Implement filtering options for specific event types
---
## Contributing
- **💬 [Join the Discussions](https://github.com/P-Nelly/github-activity/discussions)**: Share your insights, provide feedback, or ask questions.
- **🐛 [Report Issues](https://github.com/P-Nelly/github-activity/issues)**: Submit bugs found or log feature requests for the `github-activity` project.
- **💡 [Submit Pull Requests](https://github.com/P-Nelly/github-activity/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
Contributing Guidelines
1. **Fork the Repository**: Start by forking the project repository to your github account.
2. **Clone Locally**: Clone the forked repository to your local machine using a git client.
```sh
git clone https://github.com/P-Nelly/github-activity
```
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
```sh
git checkout -b new-feature-x
```
4. **Make Your Changes**: Develop and test your changes locally.
5. **Commit Your Changes**: Commit with a clear message describing your updates.
```sh
git commit -m 'Implemented new feature x.'
```
6. **Push to github**: Push the changes to your forked repository.
```sh
git push origin new-feature-x
```
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
Contributor Graph
---
## License
This project is protected under the [MIT License](https://choosealicense.com/licenses/mit/). For more details, refer to the [LICENSE](LICENSE) file.
---
## Project
This project was made for roadmap.sh
https://roadmap.sh/projects/github-user-activity
---