genialis / csmonitor

Monitoring of Genialis platform to cater to the needs of Customer Success Team

This tool is designed to monitor the Genialis platform. To get things started you will need:

• python (>= 3.6)
• kpi
• resdk
• pandas
• ggplot
• jupyter notebook
• jupyter themes (installed automatically through start_notebook.sh)
• credentials for kpi's settings/local.py

(optional)

• virtualenvwrapper

One possible workflow

Prepare virtual environment (one time step)

mkvirtualenv genialis-kpi --python=/usr/local/bin/python3.6
# install dependencies, see links above

Initiate this repository (one time step)

For easier accessing of the repository, consider adding a SSH key to GitHub.

# cd to appropriate folder, e.g. ~/Documents/projects
# fork this repository (on GitHub) and clone it
git clone [e-mail]:<username>/csmonitor.git

Run Jupyter Notebook

To ignore certain user names in the analysis, add them to creds.py.example and rename it to creds.py.

workon genialis-kpi
./start_notebook.sh
# default browser should pop-up, navigate to `CS monitoring.ipynb` notebook or create your own

To finish working, press CTRL+c and confirm the shutting down of the server. To leave the virtual envirnment, use deactive.