An open API service indexing awesome lists of open source software.

https://github.com/matevz/repgen

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

Last synced: 3 months ago
JSON representation

Monthly engineering report generator

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.
- Discord report:
- Fetches all messages in the given channel ID

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.

Discord bot requires `DISCORD_TOKEN` env variable to be set to your bot token.
The bot must have "message history" permission and being invited to the server.