https://github.com/marcusziade/contributions
visualize your all time github stats
https://github.com/marcusziade/contributions
Last synced: 2 months ago
JSON representation
visualize your all time github stats
- Host: GitHub
- URL: https://github.com/marcusziade/contributions
- Owner: marcusziade
- Created: 2024-05-18T22:15:55.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-05-19T00:06:50.000Z (12 months ago)
- Last Synced: 2025-02-28T13:14:40.490Z (2 months ago)
- Language: Go
- Homepage:
- Size: 13.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub Contributions Visualization
## How to Generate Your Own Visualizations
### Prerequisites
1. **GitHub Personal Access Token:**
- You need a GitHub Personal Access Token with `repo` and `user` permissions.
- Set it as an environment variable `GITHUB_TOKEN`.
2. **Python Environment:**
- Ensure you have Python installed.
- You will create a virtual environment and install necessary libraries.
3. **Go Environment:**
- Ensure you have Go installed to run the Go script.
### Step-by-Step Instructions
1. **Clone the Repository:**
```sh
git clone https://github.com/marcusziade/github-contributions-visualization.git
cd github-contributions-visualization
```
2. **Set Up Python Virtual Environment:**
```sh
python3 -m venv env
source env/bin/activate # On Windows use `env\Scripts\activate`
```
3. **Install Python Dependencies:**
```sh
pip install pandas matplotlib
```
4. **Run the Go program:**
```sh
go run main.go
```
### Result
After running the above steps, you will have the following files generated in your repository:
- `contributions.csv`: CSV file containing your GitHub contributions data.
- `contributions_overview.png`: Image containing the visualizations of your GitHub contributions.
Include the generated image in your GitHub repository README or any documentation to showcase your contributions visually.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
```