https://github.com/matevz/repgen

Monthly engineering report generator
https://github.com/matevz/repgen

Last synced: 13 days ago
JSON representation

Monthly engineering report generator

• Host: GitHub
• URL: https://github.com/matevz/repgen
• Owner: matevz
• Created: 2024-06-05T11:57:26.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-08-16T16:06:50.000Z (4 months ago)
• Last Synced: 2024-10-28T17:18:54.542Z (2 months ago)
• Language: Python
• Size: 58.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Monthly report generator

Fetches PRs merged given month and generates the report based on the

[`template.html`](./template.html).

Usage:

```shell

python3 main.py 

```

for example `python3 main.py 2024-05`.

The report will be printed on standard output as HTML and ready for

copy&pasting it to Google docs or other text processing app.

Features:

- PR report:

  - Fetches PRs and orders them based on the importance.

  - The importance is computed based on the diff lines of code not considering

    go.sum, .svg, yarn.lock, Cargo.lock and similar files.

  - Fetches both releases and tags published that month.

- Network report:

  - Fetches daily transaction volume from CSV file.

  - Computes daily average and max/min and compares those with the previous month.

If you encounter `403` rate limiting error on github, create Personal Access

token and export it as the `API_KEY` env variable before executing the report

generator.