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

You might also like...
Django registration and authentication with GraphQL.
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

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

Lightning fast and portable programming language!

Photon Documentation in English Lightning fast and portable programming language! What is Photon? Photon is a programming language aimed at filling th

GraphQL security auditing script with a focus on performing batch GraphQL queries and mutations

BatchQL BatchQL is a GraphQL security auditing script with a focus on performing batch GraphQL queries and mutations. This script is not complex, and

🔪 Facebook Messenger to email bridge based on reverse engineered auth and GraphQL APIs.

Unzuckify This repository has a small Python application which allows me to receive an email notification when somebody sends me a Facebook message. W

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

MGE-GraphQL is a Python library for building GraphQL mutations fast and easily

MGE-GraphQL Introduction MGE-GraphQL is a Python library for building GraphQL mutations fast and easily. Data Validations: A similar data validation w

Generate visualizations of GitHub user and repository statistics using GitHub Actions.

GitHub Stats Visualization Generate visualizations of GitHub user and repository statistics using GitHub Actions. This project is currently a work-in-

Generate visualizations of GitHub user and repository statistics using GitHubActions

GitHub Stats Visualization Generate visualizations of GitHub user and repository

Automate HoYoLAB Genshin Daily Check-In Using Github Actions

Genshin Daily Check-In 🤖 Automate HoYoLAB Daily Check-In Using Github Actions KOR, ENG Instructions Fork the repository Go to Settings - Secrets Cli

🎓Automatically Update CV Papers Daily using Github Actions (Update at 12:00 UTC Every Day)

🎓Automatically Update CV Papers Daily using Github Actions (Update at 12:00 UTC Every Day)

Automated GitHub profile content using the USGS API, Plotly and GitHub Actions.
Automated GitHub profile content using the USGS API, Plotly and GitHub Actions.

Top 20 Largest Earthquakes in the Past 24 Hours Location Mag Date and Time (UTC) 92 km SW of Sechura, Peru 5.2 11-05-2021 23:19:50 113 km NNE of Lobuj

A daily updated JSON dataset of all the Open House London venues, events, and metadata

Open House London listings data All of it. Automatically scraped hourly with updates committed to git, autogenerated per-day CSV's, and autogenerated

GitHub Actions Version Updater Updates All GitHub Action Versions in a Repository and Creates a Pull Request with the Changes.
GitHub Actions Version Updater Updates All GitHub Action Versions in a Repository and Creates a Pull Request with the Changes.

GitHub Actions Version Updater GitHub Actions Version Updater is GitHub Action that is used to update other GitHub Actions in a Repository and create

A bot i made for a dead com server lol it gets updated daily etc

6ix-Bot-Source A bot i made for a dead com server lol it gets updated daily etc For The UserAgent CMD https://developers.whatismybrowser.com/ thats a

Automation that uses Github Actions, Google Drive API, YouTube Data API and youtube-dl together to feed BackJam app with new music

Automation that uses Github Actions, Google Drive API, YouTube Data API and youtube-dl together to feed BackJam app with new music

 Deploy an inference API on AWS (EC2) using FastAPI Docker and Github Actions
Deploy an inference API on AWS (EC2) using FastAPI Docker and Github Actions

Deploy an inference API on AWS (EC2) using FastAPI Docker and Github Actions To learn more about this project: medium blog post The goal of this proje

BuddyPress is an open source WordPress plugin to build a community site. In releases of BuddyPress from 5.0.0 before 7.2.1 it's possible for a non-privileged, regular user to obtain administrator rights by exploiting an issue in the REST API members endpoint. The vulnerability has been fixed in BuddyPress 7.2.1. Existing installations of the plugin should be updated to this version to mitigate the issue.
A github actions + python code to extract URLs to code repositories to put into standard form, starting with github

A github actions + python code to extract URLs to code repositories to put into standard form, starting with github ---- NOTE: JUS

Comments
  • Use pip cache from setup-python action

    Use pip cache from setup-python action

    A step in the workflows can be replaced with the cache already built into the setup-python action, see https://github.com/actions/setup-python#caching-packages-dependencies

    opened by boidolr 0
  • Add repositories manually

    Add repositories manually

    Include an option to manually add repositories if contributions to these are not being represented in the statistics, such as when a repository is imported, for example.

    opened by R055A 0
  • Fix last view/clone date update

    Fix last view/clone date update

    Currently, it updates the last date that there was a view/clone rather than the last date views/clones are updated, or rather the day before the last date they are updated as views/clones for all dates prior to the date they are updated are stored to DB/ENV while the views/clones for the day they are updated are then added to the values stored to DB for displaying in the generated images. Without this fix, a last view/clone date could potentially be earlier than a first view/clone date.

    bug 
    opened by R055A 0
This is a minimal project using graphene with django and user authentication to expose a graphql endpoint.

Welcome This is a minimal project using graphene with django and user authentication to expose a graphql endpoint. Definitely checkout how I have mana

yosef salmalian 1 Nov 18, 2021
Pygitstats - a package that allows you to use the GitHub GraphQL API with ease in your Python programs

Pygitstats - a package that allows you to use the GitHub GraphQL API with ease in your Python programs

Dillon Barnes 4 Mar 29, 2022
This is a graphql api build using ariadne python that serves a graphql-endpoint at port 3002 to perform language translation and identification using deep learning in python pytorch.

Language Translation and Identification this machine/deep learning api that will be served as a graphql-api using ariadne, to perform the following ta

crispengari 2 Dec 30, 2021
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 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
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
A python graphql api, which serves ECB currency rates from last 90 days.

Exchange Rate Api using GraphQL Get Code git pull https://github.com/alaturqua/exchangerate-graphql.git Create .env file with following content and s

Isa 1 Nov 4, 2021
Blazing fast GraphQL endpoints finder using subdomain enumeration, scripts analysis and bruteforce.

Graphinder Graphinder is a tool that extracts all GraphQL endpoints from a given domain. Run with docker docker run -it -v $(pwd):/usr/bin/graphinder

Escape 76 Dec 28, 2022
Ariadne is a Python library for implementing GraphQL servers using schema-first approach.

Ariadne Ariadne is a Python library for implementing GraphQL servers. Schema-first: Ariadne enables Python developers to use schema-first approach to

Mirumee Labs 1.9k Jan 1, 2023
GraphQL is a query language and execution engine tied to any backend service.

GraphQL The GraphQL specification is edited in the markdown files found in /spec the latest release of which is published at https://graphql.github.io

GraphQL 14k Jan 1, 2023