pawelkn/gpw-reports

GPW Reports is a keyword scanner of GPW (Warsaw Stock Exchange) ESPI/EBI Company reports

GPW Reports

GPW Reports is a keyword scanner of GPW (Warsaw Stock Exchange) ESPI/EBI Company reports. Periodically scraps the https://www.gpw.pl/espi-ebi-reports site, searching for keywords in reports. When matching report is found, sends a notification email.

Configuration

Mail host configuration. To deliver a notification mails an external SMTP service is used.

To configure SMTP, you will have to create a configuration file smtp-config.json and enter your sender account settings.

Example (smtp-config.json):

{
    "sender": "sender@gmail.com",
    "host": "smtp.gmail.com",
    "port": 465,
    "login": "username",
    "password": "password"
}

Mailing list. The mailing list is kept in mailing-list.json file. It contains mail addresses and attached keywords. Keywords are case insensitive. If an empty keywords list is set, all reports are mailed.

Example (mailing-list.json):

[
    {
        "name": "Recipient Name 1",
        "mail": "recipient_1@gmail.com",
        "keywords": [
            "KGHM",
            "CD Projekt",
            "transakcj"
        ]
    },
    {
        "name": "Recipient Name 2",
        "mail": "recipient_2@gmail.com",
        "keywords": []
    }
]

Location of configuration and state files can be configured using environment variables.

Example:

export GPW_REPORTS_SMTP_CONFIG_FILE=smtp-config.json
export GPW_REPORTS_MAILING_LIST_FILE=mailing-list.json
export GPW_REPORTS_STATE_FILE=data/state.json

Run

Note: Before run create valid configuration files: smtp-config.json and mailing-list.json

Install dependencies

pip3 install -r requirements.txt

Application start

python3 -m gpw_reports

Docker

Note: Before run create valid configuration files: smtp-config.json and mailing-list.json

To avoid python version conflict and/or dependencies installation run application in docker container

docker-compose up --build

Unit tests

Run tests locally

python3 -m unittest discover tests

or using docker

docker build -t gpw-reports .
docker run --rm gpw-reports python -m unittest discover tests