Skip to content
This repository has been archived by the owner on Dec 5, 2023. It is now read-only.

Small README changes to assist with install errors #3

Merged
merged 1 commit into from
May 23, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,13 @@ alert data.

## Requirements
* Python 3.9+
* a MariaDB/MySQL server
* Don't forget to run `pip3 install -r requirements.txt`*
* a MariaDB/MySQL server*
* a PagerDuty API token
* Docker/Podman/K8s/OpenShift (optional)

*If pip complains about being unable to find a specific version of a dependency module, it's probably because you're using a version of Python older than 3.9. If pip instead complains about failing to build the MariaDB module, make sure you have the MariaDB C Connector, GCC, and the Python headers installed (e.g., on Fedora/RHEL: `dnf install mariadb-connector-c mariadb-connector-c-devel gcc python39-devel`).

## Initial Caching Database Setup
The PagerDuty API is too slow/rate-limited to be used directly by the web application.
Instead, you'll need to set up, populate, and regularly refresh a caching database.
Expand Down Expand Up @@ -126,11 +129,6 @@ questions specified by the `AA_QUESTION_CLASSES` config value. The columns of ea
support sorting (click the little arrows next to column name) and filtering (enter your
search term or [filter](https://dash.plotly.com/datatable/filtering#filtering-operators) into the cell below the column name)

## Notebooks
The `notebooks/` directory contains the exploratory analyses that eventually led to the
creation of this web application. If you'd like interact with these, install Jupyter
Notebook from `pip3`, navigate to the directory, and run `jupyter notebook`.

## Errata
* Some alert names will be abbreviated when loaded into the cache. See the
`Alert.standardize_name()` function in `models.py` to see how this works.