GITHUB-ACTIVITY

❯ A Python CLI tool to fetch and display GitHub user activity

Table of Contents

• Overview
• Features
• Project Structure
  • Project Index
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Testing
• Project Roadmap
• Contributing
• License
• 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

└── 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:

❯ git clone https://github.com/P-Nelly/github-activity

2. Navigate to the project directory:

❯ 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

• 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: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the github-activity project.
• 💡 Submit Pull Requests: 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.

   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.

   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.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   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. For more details, refer to the LICENSE file.

---

Project

This project was made for roadmap.sh

https://roadmap.sh/projects/github-user-activity

---