https://github.com/thebrianbug/dev-flow-dashboard
Tool to visualize dev flow on a repo
https://github.com/thebrianbug/dev-flow-dashboard
Last synced: 11 months ago
JSON representation
Tool to visualize dev flow on a repo
- Host: GitHub
- URL: https://github.com/thebrianbug/dev-flow-dashboard
- Owner: thebrianbug
- License: mit
- Created: 2022-06-30T19:46:24.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-16T17:10:18.000Z (over 3 years ago)
- Last Synced: 2025-05-19T07:08:31.227Z (about 1 year ago)
- Language: Jupyter Notebook
- Size: 4.84 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Developer Flow Dashboard
This project generates reports on flow metric from a given GitHub repo using the Github API.
## Prerequisits
- Install [Python 3](https://www.python.org/downloads/) if needed
- Install [VSCode](https://code.visualstudio.com/) if needed
- (Optional but recommended) install [Conda](https://www.anaconda.com/products/distribution)
## Getting Started
1. Clone repo `git clone https://github.com/bmcilw1/dev-flow-dashboard.git`
2. Install Requirements
- (Optional) Use [Conda](https://www.anaconda.com/products/distribution) or [Virtualenv](https://virtualenv.pypa.io/en/latest/installation.html) to separate dependencies from your main Python environment
```bash
pip install -r requirements.txt
```
3. Clear output of all cells, restart runner, and run all code cells in [Data Collection](./Github_Data_Collection.ipynb) in VSCode
4. Clear output of all cells, restart runner, and run all code cells in [Flow Dashboard](./Flow_Dashboard.ipynb) in VSCode
5. Save changes to notebook runs and output files generated
6. Push data from the updated run to a branch
7. Evaluate data
## Maintainers
Author: [Brian McIlwain](mailto:technicallyemployed@gmail.com)