From f4cb5d21d9b95b13c455e97feb1020d7fb2069a7 Mon Sep 17 00:00:00 2001 From: Nick Ninov Date: Wed, 13 May 2026 08:58:10 +0300 Subject: [PATCH] docs: Add development guidelines - Related to https://github.com/status-im/data-docs/pull/195 --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3fa5d1f..efbcd9c 100644 --- a/README.md +++ b/README.md @@ -98,10 +98,14 @@ conda create -n status-monitoring python=3.12 **Note**: Code has been tested with **Python 3.12**. -2. Install requirements +2. Install `monitor.py` and `bot` requirements ```bash -pip install -r requirements.txt +# To run Status bot +pip install -r ./bot/requirements.txt + +# To run monitor.py +pip install -r ./requirements.txt ``` **Note**: If you are on Windows, you will have to install `psycopg2` instead of `psycopg2-binary`. @@ -117,3 +121,19 @@ If you have already created a Status account and want to use it with it's curren ## Files - `monitor.py` - Status community message monitoring. It will download and upload messages in parallel. + +# Guidelines + +Things to keep in mind when building projects: + +1. **Wrong recovery phrase** can create a new account by accident. To recover the account you must correctly write the phrase. + +2. **Dynamic** `chats`, `communities` and `contacts` properties. If you log in to the account without a backup the properties will be empty **but will be populated automatically** if a message in a chat or community appears. + +3. **Display name is not the same as username**. In Status App a display name is the **curent username** of active account. This means that if you have the same profile logged in with Python, Status Desktop and Status Mobile you can have 3 different usernames **based on your current device**. If an account is logged in from more than one device, the display name will change based on the currently used one (when messaging). This feature can be handy to distinguish if a bot or an actual user is logged in to the account. **Profile pictures work in a similar way to display names** + +4. Community join requests do not work properly due to `status-go` issues. For latest updates, please monitor [`status-im/status-bot` issue #9](https://github.com/status-im/status-bot/issues/9). The fastest way to get in to a community is to manually log in with the Bot account and send a via Status App. Once the account is accepted, the bot can log in and start running. The community and chat information will appear in (2) as the messages come in. + +5. To monitor for new messages, the account **must always be logged in**. Log out of the account only if you do not want to receive messages. + +6. **Token gated chats have an impact on the entire community**. You must provide an [Infura Token](https://www.infura.io/) and [Coingecko API key](https://www.coingecko.com/) during `login`. If wallet credentials are left out, then the community will not appear in (2) properties instead of the token gated chats only.