status-python-sdk/README.md

Status App Monitoring

Monitoring tool for Status App communities

Setup

Environment Variables

POSTGRES_USERNAME
POSTGRES_PASSWORD
POSTGRES_DATABASE
POSTGRES_HOST
POSTGRES_PORT

Docker

1. Login to harbor.status.im. Your password is your Harbor CLI secret.

docker login harbor.status.im

2. Run docker-compose.yaml file

docker compose up

Python

1. Setup environment

conda create -n status-monitoring python=3.12

2. Install requirements

pip install -r requirements.txt

Note: If you are on Windows, you will have to install psycopg2 instead of psycopg2-binary.

Files

• create_account.py - create a Status App account for the given username and password. Example runs:
  • python create_account.py -u snt-maxxer -p StatusApp#123
  • python create_account.py --username snt-maxxer --password StatusApp#123
• download.py - download all messages and overall community info from the specified Status App channels in config.yaml.
• upload.py - upload data from download.py to Postgres