Skip to content

Latest commit

 

History

History
executable file
·
23 lines (17 loc) · 1.1 KB

README.md

File metadata and controls

executable file
·
23 lines (17 loc) · 1.1 KB

RateLimitReport

This script was extended from Sam Jackson's ServerReport [https://github.com/sjacks26/ServerReport]

This script is used to monitor a central limits collection generated by STACK.

Email notifications

RateLimitReport also sends a daily email update about the rate limits it monitors.

Installation and setup

To run RateLimitReport:

  1. Clone the code to your server using git clone https://github.com/bitslabsyr/RateLimitReport.git. You should run this command from a directory that your user has write permissions in; otherwise, you can run RateLimitReport as sudo.
  2. Rename config_template.py to config.py.
  3. Modify the parameters in config.py to match your preferences.
    • Specify the hour you want to receive email reports.
    • Specify the email accounts for recipients and for the account used to send emails.
    • Specify server, username and password for MongoDB.
    • Specify DB and collection names of the central limits collection.
  4. Run RateLimitReport with python3 RateLimitReport.py &.

Requirements

RateLimitReport was developed and tested with Python3.