https://github.com/pagopa-archive/io-report

collect and send to slack some data about the IO usage
https://github.com/pagopa-archive/io-report

Last synced: about 12 hours ago
JSON representation

collect and send to slack some data about the IO usage

• Host: GitHub
• URL: https://github.com/pagopa-archive/io-report
• Owner: pagopa-archive
• Archived: true
• Created: 2021-12-06T09:08:12.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-02-28T11:22:55.000Z (almost 2 years ago)
• Last Synced: 2025-02-05T02:20:09.641Z (about 12 hours ago)
• Language: Python
• Size: 397 KB
• Stars: 0
• Watchers: 7
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD

Awesome Lists containing this project

README

        
# description

This tool collects some data about the IO usage and sends them to a Slack channel [every Monday at about 9.00am](.github/workflows/python-app.yml)



# setup

### mixpanel

To collect data from Mixpanel, it requires a [service token](https://eu.mixpanel.com/report/2460815/settings/#project/2460815/serviceaccounts)


It must be included as **env variable**

example:


`MIXPANEL_SERVICE_TOKEN`:`mp_service_token`

### slack

To send the reports to Slack, it requires the Slack web hook


It must be included as **env variable**

example:


`SLACK_WEB_HOOK`:`https://hooks.slack.com/services/xyz/zyx/123`

### how to add a report

- create you own report class by extending the base [Report](src/models/report.py)

```python

class FancyReport(Report):

	def load_report(self) -> Union[str, None]:

		return "42 - Answer to the Ultimate Question of Life, the Universe, and Everything"

life_section = SectionReports("✨ *Life Mystery*",

                                    [FancyReport("most important answer")])

```

then add the `life_section` to the [sections list](src/main.py)



### requirements

It needs a Python interpreter version >= 3.5

Install requirements

`pip install -r requirements.txt`

# run

`python main.py`