Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rahul-jha98/github-stats-transparent
Automatically generate summary GitHub statistics images for your profile using Actions, no server required
https://github.com/rahul-jha98/github-stats-transparent
github github-api github-stats profile statistics
Last synced: about 1 month ago
JSON representation
Automatically generate summary GitHub statistics images for your profile using Actions, no server required
- Host: GitHub
- URL: https://github.com/rahul-jha98/github-stats-transparent
- Owner: rahul-jha98
- License: gpl-3.0
- Created: 2021-01-14T01:52:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-06T01:26:48.000Z (about 1 month ago)
- Last Synced: 2024-08-06T23:46:08.776Z (about 1 month ago)
- Topics: github, github-api, github-stats, profile, statistics
- Language: Python
- Homepage:
- Size: 571 KB
- Stars: 339
- Watchers: 4
- Forks: 639
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - rahul-jha98/github-stats-transparent - Automatically generate summary GitHub statistics images for your profile using Actions, no server required (Python)
README
# GitHub Stats Visualizations : Transparent
> Generate visualizations of GitHub user and repository statistics using GitHub
Actions.
> NOTE: This repository is my extension of the repo [jstrieb/github-stats](https://github.com/jstrieb/github-stats). This repo was meant to serve as a detached fork of his project. If you like this repository make sure you also star his repository to show appreciation for his work.
## ⚠️ Disclaimer
The project uses access token that has read access to private repositories and if there is any
exception while reading data from any repository it throws Exception which is printed in the workflow logs.
This exception will be viewable in the Actions tab of the repository fork, and
anyone may be able to see the name of one or more private repositories.
## ⚙️ Installation
1. Create a personal access token (not the default GitHub Actions token) using
the instructions
[here](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
Personal access token must have permissions: `read:user` and `repo`. Copy
the access token when it is generated – if you lose it, you will have to
regenerate the token.
2. Click [here](https://github.com/rahul-jha98/github-stats-transparent/fork) to create a
fork of this repository
3. If this is the README of your fork, click [this
link](../../settings/secrets/actions) to go to the "Secrets" page.
Otherwise, go to the "Settings" tab of the newly-created repository and go
to the "Secrets" page (bottom left).
4. Create a new secret with the name `ACCESS_TOKEN` and paste the copied
personal access token as the value.
5. If you want to ignore certain repos, add them (separated by commas) to a new
secret—created as before—called `EXCLUDED`.
6. If you want to ignore certain languages, add them (separated by commas) to a new secret called
`EXCLUDED_LANGS`.
7. By default the languages, stars, forks and repository views do not consider stats from
public repositories that you have forked and contributed to. But if you want to count stats from
forked repositories also you can do so by creating a new secret called `COUNT_STATS_FROM_FORKS`.
For the value you can put any random value because the action only checks if the secret is set or not.
8. Go to the [Actions Page](../../actions?query=workflow%3A"Generate+Stats+Images") and press "Run
Workflow" on the right side of the screen to generate images for the first
time. The images will be periodically generated every hour, but they can be
manually regenerated by manually running the workflow.
9. Check out the images that have been created in the [`generated`](../output/generated)
folder in `output` branch.
10. Link back to this repository so that others can generate their own
statistics images.
11. Star this repo if you like it!
## 🤔 Why Transparent ??
With the introduction of dark mode in Github it has become difficult to set an image background that looks consistent with the background in both dark and light mode.
To solve this the most obvious solution was to make the background transparent. All that was left was to choose colors for text that makes it legible in light as well as dark background.
After wasting a day playing with different color values finally settled on one. Hope you like it.
## Related Projects
- Extension of a detached fork of [jstrieb/github-stats](https://github.com/jstrieb/github-stats)
- Inspired by a desire to improve upon
[anuraghazra/github-readme-stats](https://github.com/anuraghazra/github-readme-stats)
- Makes use of [GitHub Octicons](https://primer.style/octicons/) to precisely
match the GitHub UI