An open API service indexing awesome lists of open source software.

https://github.com/ineszenkri/github-insights

github
https://github.com/ineszenkri/github-insights

flask githubapi insights pandas

Last synced: 5 months ago
JSON representation

github

Awesome Lists containing this project

README

          

# GitHub Insights

A powerful tool to analyze and visualize your GitHub activity and repository statistics. GitHub Insights helps developers and teams better understand their contributions and project dynamics by providing meaningful insights in an intuitive format.

---

## 🎯 Features

- **User Contribution Analysis**: Visualize your commits, pull requests, and issues.
- **Repository Metrics**: Gain insights into stars, forks, and contributors.
- **Activity Trends**: Track your activity trends over time.
- **Interactive Dashboards**: View data with rich, interactive visualizations.
- **Exportable Reports**: Save your insights as reports for future reference or team sharing.

---

## 🚀 Getting Started

Follow these steps to set up and run GitHub Insights on your local machine:

### Prerequisites

Ensure you have the following installed:
- [Python](https://www.python.org/) 3.7+
- [Git](https://git-scm.com/)
- Dependencies listed in `requirements.txt`

### Installation

1. Clone the repository:
```bash
git clone https://github.com/InesZenkri/Github-Insights.git
```
2. Navigate to the project directory:
```bash
cd Github-Insights
```

3. Generate a personal access token from GitHub with the necessary permissions for reading repository and user data.
Add the token to a .env file :
```bash
GITHUB_TOKEN=your_personal_access_token
```
4. Run the application using:
```bash
python main.py
```
- - -

## 🛠️ Technologies Used

- Backend: Python, Flask
- Data Processing: Pandas
- Visualizations: Matplotlib, Plotly
- API Integration: GitHub REST API

## I welcome contributions!