Skip to content

tim0-12432/github-summary

Repository files navigation

GitHub summary generator

Installation

clone the repository or download the source code! Afterwards be sure to have the dependencies installed by calling pip install -r requirements.txt in the source folder. Of course you need to have python installed!

Use

basic execution: python generator.py <username>

parameters:

  • -i, --intervall: Sets intervall. YEAR or MONTH, default is year
  • -e, --endtime: Sets endpoint. TODAY or specific datetime int e.g. 64853273685726, default is today

The generator will put a .tex file in the output folder. This could be converted to a pdf by using e.g MiKTex, Overleaf, latexbase, etc.

Example: Build example

Known issues

Further information

Used api: https://api.github.com

About

Generates a latex summary of your contributions.

Topics

Resources

Stars

Watchers

Forks

Languages