https://github.com/tim0-12432/github-summary

Generates a latex summary of your contributions.
https://github.com/tim0-12432/github-summary

github summary-statistics

Last synced: about 1 month ago
JSON representation

Generates a latex summary of your contributions.

• Host: GitHub
• URL: https://github.com/tim0-12432/github-summary
• Owner: tim0-12432
• Created: 2021-06-08T16:10:34.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-07-21T17:16:00.000Z (almost 5 years ago)
• Last Synced: 2025-10-19T15:59:30.244Z (8 months ago)
• Topics: github, summary-statistics
• Language: Python
• Homepage:
• Size: 43 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# GitHub summary generator

## Installation

[clone](git@github.com:tim0-12432/github-summary.git) the repository or [download](https://github.com/tim0-12432/github-summary/archive/refs/heads/master.zip) 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 `

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](https://miktex.org/), [Overleaf](https://de.overleaf.com/), [latexbase](https://latexbase.com/), etc.

Example: [![Build example](https://github.com/tim0-12432/github-summary/actions/workflows/build-pdf.yml/badge.svg?event=workflow_dispatch)](https://github.com/tim0-12432/github-summary/actions/workflows/build-pdf.yml)

## Known issues

## Further information

Used api: [https://api.github.com](https://api.github.com)