Generate daily updated visualizations of user and repository statistics from the GitHub API using GitHub Actions

Overview

GitHub Stats Visualization

Generate daily updated visualizations of user and repository statistics from the GitHub GraphQL and REST APIs using GitHub Actions and Secrets for any combination of private and public repositories - dark mode supported.

GitStats Overview - LightGitStats Overview - DarkGitStats Languages - LightGitStats Languages - Dark

This is a modification of jstrieb/github-stats with many additional statistics, options and dark mode support

By default, statistical data for GitHub repositories an authenticated user either owns, has collaborative access to, or has otherwise contributed to are fetched from the GitHub API for visualization.

Forked repositories are excluded by default. However, there are many options provided for including or excluding any repository and more using: Statistics Options.

Regardless of which repositories are included, the generated All-time GitHub contributions given statistic will always represent all GitHub contributions by the user.

It seems that view and clone statistical data for repositories that an authenticated user neither owns nor has collaborative access to are not included in the generated statistics being visualized.

It also seems that statistics for contributions to GitHub repositories that an authenticated user neither owns nor has collaborative access to possibly only includes repositories that exist on GitHub before the contributions do. Contribution statistics for repositories uploaded to GitHub after the contributions are made, so long that the configured commit email is associated with the user's GitHub account, can be included in the statistic visualizations by manually including the repository using the MORE_REPOS secret option in Statistics Options.

Instructions

Click to view step-by-step instructions for generating your own GitHub statistics visualizations

Copy Repository

  1. Click either link to start generating your own GitHub statistic visualizations:
    1. Generate your own copy of this repository without the commit history
      • Note: the first GitHub Actions workflow initiated at creation of the copied repository is expected to fail
    2. Fork a copy of this repository with the commit history configured to sync changes
      • Note: this copies all branches including the action_branch with statistics, but this can be overwritten

Generate a New Personal Access Token

  1. Generate a personal access token by following these steps:
    1. If you are logged in, click this link to: generate a new token
    2. Name the token
    3. Select your preferred 'Expiration' date
    4. Select repo for 'Full control of private repositories'
    5. Select read:user to 'Read ALL user profile data'
    6. Click the 'Generate token' button
    7. Copy the generated token - there is only one opportunity provided for this

Create ACCESS_TOKEN Secret

  1. Create a repository secret for the personal access token by following these steps:
    1. If this is your copy of the repository, click this link to: create a new secret
      • Otherwise, go to repository Settings, click the Secrets option, then click New repository secret
    2. Name the new secret: ACCESS_TOKEN
    3. Enter the generated personal access token as the 'Value'

Run GitHub Actions Workflow

  1. Manually generate GitHub statistics visualizations:
    1. This can be done using any of the following two GitHub Actions workflows:
      1. For the first time, or to reset stored statistics (although this is done with every push to master):

        This is required if the actions_branch branch is not created, as it is created when run

      2. Otherwise, for updating generated statistics visualizations (although this is automatically done daily):

        This requires the actions_branch branch to first be created with generated statistics visualizations

    2. With the GitHub Actions page open, click the 'Run workflow' dropdown menu button
    3. Select Branch: master from the 'Use workflow from' dropdown list
    4. Click the 'Run workflow' button

View Generated Statistics

  1. Following the successful completion of a workflow, generated statistics visualizations can be viewed:
    1. In the generated_images directory in the actions_branch branch with the following image links:
      1. Language statistics using @media prefers-color-scheme for dark and light mode - not tested
      2. Language statistics in light mode only
      3. Language statistics in dark mode only
      4. Overview statistics using @media prefers-color-scheme for dark and light mode - not tested
      5. Overview statistics in light mode only
      6. Overview statistics in dark mode only

Display Generated Statistics

  1. To display the generated statistics, constant URLs can be used for images that are updated daily:
    1. For a GitHub profile README.md, attach #gh-light-mode-only and #gh-dark-mode-only to light and dark raw image links, respectively, such as:
      1. For generated language statistics visualizations (replacing with your GitHub username):
      ![](https://raw.githubusercontent.com/
              /GitStats/actions_branch/generated_images/languagesLightMode.svg
              #gh-light-mode-only)![](https://raw.githubusercontent.com/
              
               /GitStats/actions_branch/generated_images/languagesDarkMode.svg
               #gh-dark-mode-only)
              
             
      1. For generated overview statistic visualizations (replacing with your GitHub username):
      ![](https://raw.githubusercontent.com/
              /GitStats/actions_branch/generated_images/overviewLightMode.svg
              #gh-light-mode-only)![](https://raw.githubusercontent.com/
              
               /GitStats/actions_branch/generated_images/overviewDarkMode.svg
               #gh-dark-mode-only)
              
             
    2. For websites, use the raw image URLs for any suitable image from the above View Generated Statistics links.

      Note: I have not used the images on any website other than the following GitHub pages:

      https://r055a.github.io/profile/statistics/

      https://r055a.github.io/university-projects/statistics/

Statistics Options

Click to view Repository Secrets for customizing GitHub statistic visualizations
  • Secret Name: EXCLUDED
    • for excluding listed repositories from being included in the generated statistic visualizations
    • enter Value in the following format (separated by commas):
      • [owner/repo],[owner/repo],...,[owner/repo]
    • example:
      • jstrieb/github-stats,rahul-jha98/github-stats-transparent,idiotWu/stats
  • Secret Name: ONLY_INCLUDED
    • for ONLY including listed repositories in the generated statistic visualizations
    • enter Value in the following format (separated by commas):
      • [owner/repo],[owner/repo],...,[owner/repo]
    • example:
      • R055A/GitStats,R055A/R055A
  • Secret Name EXCLUDED_LANGS
    • for excluding listed languages from being included in the generated statistic visualizations
    • enter Value in the following format (separated by commas):
      • [language],[language],...,[language]
    • example:
      • HTML,Jupyter Notebook,Makefile,Dockerfile
  • Secret Name INCLUDE_FORKED_REPOS
    • for including forked repositories in the generated statistic visualizations
      • false by default
    • enter Value in the following format:
    • examples:
      • true
  • Secret Name EXCLUDE_CONTRIB_REPOS
    • for excluding repositories (pull request) contributed to in the generated statistic visualizations
      • false by default
    • enter Value in the following format:
    • examples:
      • true
  • Secret Name EXCLUDE_ARCHIVE_REPOS
    • for excluding archived repositories in the generated statistic visualizations
      • false by default
    • enter Value in the following format:
    • examples:
      • true
  • Secret Name EXCLUDE_PRIVATE_REPOS
    • for excluding private repositories in the generated statistic visualizations
      • false by default
    • enter Value in the following format:
    • examples:
      • true
  • Secret Name EXCLUDE_PUBLIC_REPOS
    • for excluding public repositories in the generated statistic visualizations
      • false by default
    • enter Value in the following format:
    • examples:
      • true
  • Secret Name MORE_REPOS
    • for including repositories that are otherwise not included in the generated statistic visualizations
      • such as imported repositories with contributions
    • enter Value in the following format (separated by commas):
      • [owner/repo],[owner/repo],...,[owner/repo]
    • example:
      • R055A/GitStats,R055A/R055A
  • Secret Name MORE_COLLABS
    • for adding a constant value to the generated repository collaborators statistic
      • such as for collaborators that are otherwise not represented
    • enter Value in the following format:
    • example:
      • 4
  • Secret Name STORE_REPO_CLONES
    • for storing generated repository clone statistic visualization data beyond the 14 day-limit GitHub API allows
      • true by default
    • enter Value in the following format:
    • examples:
      • false
  • Secret Name STORE_REPO_VIEWS
    • for storing generated repository view statistic visualization data beyond the 14 day-limit GitHub API allows
      • true by default
    • enter Value in the following format:
    • examples:
      • false
  • Secret Name REPO_VIEWS
    • for adding a constant value to the generated repository view statistics
      • such as for when the stored data is reset or when importing stat data from elsewhere
      • requires being removed within 14 days after the first workflow is run (with LAST_VIEWED)
      • requires corresponding LAST_VIEWED and FIRST_VIEWED Secrets
    • enter Value in the following format:
    • example:
      • 5000
  • Secret Name LAST_VIEWED
    • for updating the date the generated repository view statistics data is added to storage from
      • such as for when the stored data is reset or when importing stat data from elsewhere
      • requires being removed within 14 days after the first workflow is run (with REPO_VIEWS)
      • may require corresponding REPO_VIEWS and FIRST_VIEWED Secrets
    • enter Value in the following format:
      • YYYY-MM-DD
    • example:
      • 2020-10-01
  • Secret Name FIRST_VIEWED
    • for updating the 'as of' date the generated repository view statistics data is stored from
      • such as for when the stored data is reset or when importing stat data from elsewhere
      • may require corresponding REPO_VIEWS and LAST_VIEWED Secrets
    • enter Value in the following format:
      • YYYY-MM-DD
    • example:
      • 2021-03-31
  • Secret Name REPO_CLONES
    • for adding a constant value to the generated repository clone statistics
      • such as for when the stored data is reset or when importing stat data from elsewhere
      • requires being removed within 14 days after the first workflow is run (with LAST_CLONED)
      • requires corresponding LAST_CLONED and FIRST_CLONED Secrets
    • enter Value in the following format:
    • example:
      • 2500
  • Secret Name LAST_CLONED
    • for updating the date the generated repository clone statistics data is added to storage from
      • such as for when the stored data is reset or when importing stat data from elsewhere
      • requires being removed within 14 days after the first workflow is run (with REPO_CLONES)
      • may require corresponding REPO_CLONES and FIRST_CLONED Secrets
    • enter Value in the following format:
      • YYYY-MM-DD
    • example:
      • 2020-10-01
  • Secret Name FIRST_CLONED
    • for updating the 'as of' date the generated repository clone statistics data is stored from
      • such as for when the stored data is reset or when importing stat data from elsewhere
      • may require corresponding REPO_CLONES and LAST_CLONED Secrets
    • enter Value in the following format:
      • YYYY-MM-DD
    • example:
      • 2021-04-01

Support the Project

There are a few things you can do to support the project:

  • Star the repository (and follow me and/or jstrieb on GitHub for more)
  • Share and upvote on sites
  • Report any bugs, glitches, or errors that you find
  • Spare a donation to a worthy cause

Related Projects

Burp Suite extension to log GraphQL operations as a comment

Burp GraphQL Logger A very simple, straightforward extension that logs GraphQL operations as a comment in the Proxy view. To enable the highlight, unc

22 Jul 02, 2022
Graphene MongoEngine integration

Graphene-Mongo A Mongoengine integration for Graphene. Installation For installing graphene-mongo, just run this command in your shell pip install gra

GraphQL Python 261 Dec 31, 2022
A Django GraphQL Starter that uses graphene and graphene_django to interface GraphQL.

Django GraphQL Starter GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data... According to the doc

0101 Solutions 1 Jan 10, 2022
Integrate GraphQL into your Django project.

Graphene-Django A Django integration for Graphene. 💬 Join the community on Slack Documentation Visit the documentation to get started! Quickstart For

GraphQL Python 4k Dec 31, 2022
Generate daily updated visualizations of user and repository statistics from the GitHub API using GitHub Actions

Generate daily updated visualizations of user and repository statistics from the GitHub API using GitHub Actions for any combination of private and public repositories - dark mode supported

Adam Ross 15 Dec 31, 2022
Translate APIs described by OpenAPI Specifications (OAS) into GraphQL

OpenAPI-to-GraphQL Translate APIs described by OpenAPI Specifications (OAS) or Swagger into GraphQL. Getting started OpenAPI-to-GraphQL can be used in

International Business Machines 1.4k Dec 29, 2022
Tyk Open Source API Gateway written in Go, supporting REST, GraphQL, TCP and gRPC protocols

Tyk API Gateway Tyk is an open source Enterprise API Gateway, supporting REST, GraphQL, TCP and gRPC protocols. Tyk Gateway is provided ‘Batteries-inc

Tyk Technologies 8k Jan 09, 2023
Django Project with Rest and Graphql API's

Django-Rest-and-Graphql # 1. Django Project Setup With virtual environment: mkdir {project_name}. To install virtual Environment sudo apt-get install

Shubham Agrawal 5 Nov 22, 2022
Django registration and authentication with GraphQL.

Django GraphQL Auth Django registration and authentication with GraphQL. Demo About Abstract all the basic logic of handling user accounts out of your

pedrobern 301 Dec 09, 2022
graphw00f is Server Engine Fingerprinting utility for software security professionals looking to learn more about what technology is behind a given GraphQL endpoint.

graphw00f - GraphQL Server Fingerprinting graphw00f (inspired by wafw00f) is the GraphQL fingerprinting tool for GQL endpoints. Table of Contents How

Dolev Farhi 282 Jan 04, 2023
Django GraphQL User Management

Django GraphQL User Management An app that explores User management with GraphQL using Graphene in Django. Topics covered: Login. Log Out. Authenticat

0101 Solutions 4 Feb 22, 2022
Django GraphQL To Do List Application

Django GraphQL Simple ToDo HOW TO RUN just run the following instructions: python -m venv venv pip install -r requirements.txt source venv/bin/activat

pedram shahsafi 1 Nov 13, 2021
A plug and play GraphQL API for Wagtail, powered by Strawberry 🍓

Strawberry Wagtail 🐦 A plug and play GraphQL API for Wagtail, powered by Strawberry 🍓 ⚠️ Strawberry wagtail is currently experimental, please report

Patrick Arminio 27 Nov 27, 2022
The Foundation for All Legate Libraries

Legate The Legate project endeavors to democratize computing by making it possible for all programmers to leverage the power of large clusters of CPUs

Legate 144 Dec 26, 2022
Modular, cohesive, transparent and fast web server template

kingdom-python-server 🐍 Modular, transparent, batteries (half) included, lightning fast web server. Features a functional, isolated business layer wi

T10 20 Feb 08, 2022
This is a simple Python that will parse instanceStats GraphQL Query into a CSV

GraphQL Python Labs - by Gabs the CSE Table of Contents About The Project Getting Started Prerequisites Installation and Usage Roadmap Contributing Li

Gabriel (Gabs) Cerioni 1 Oct 27, 2021
Enable idempotent operations in POST and PATCH endpoints

Idempotency Header ASGI Middleware A middleware for making POST and PATCH endpoints idempotent. The purpose of the middleware is to guarantee that exe

Sondre Lillebø Gundersen 12 Dec 28, 2022
Getting the ip of a fivem server with a cfx.re link

Dark Utilities - FIVEM-IP-RESOLVER Our Website https://omega-project.cz/ ! Install the app on the server Inplex-sys 12 Oct 25, 2022

Generate a FullStack Playground using GraphQL and FastAPI 🚀

FastQL - FastAPI GraphQL Playground Generate a FullStack playground using FastAPI and GraphQL and Ariadne 🚀 . This Repository is based on this Articl

OBytes 109 Dec 23, 2022
Fastapi strawberry graphql

fastapi-strawberry-graphql Quick and dirty 🍓 python python --version Python 3.10 pip pip install sqlalchemy pip install sqlmodel pip install fastapi

Rodrigo Ney 7 Oct 19, 2022