- Provides a web-based dashboard for viewing COVID-19 statistics and news, all in one place.
- Highly configurable, choose your own title, images, favicon and more!
- Can be quickly setup to work for any location within the UK.
- Easily extendible, with well structured and clearly documented code .
- Get up and running in under two minutes!
| Dependency | Version |
|---|---|
| Python | 3.8.9 |
| Flask | 2.0.2 |
| pytest | 6.2.5 |
| requests | 2.26.0 |
| uk-covid19 | 1.2.2 |
Note. everything but python can be automatically installed using venv.
- Open the folder you would like install the dashboard into in your terminal/command prompt and run
python -m venv .venvto create a virutal environment. If you're on MacOS use python3 instead
python3 -m venv .venv- Enter the python virtual environment
source .venv/bin/activateon MacOS, or the following on Windows
.venv\bin\activate.bat- Now, in the virtual environment, run
pip install -e .
pip install -r requirements.txtto install the dashboard and its dependencies.
- Run the dashboard for the first time with
python app.pyto generate a new config.json file.
-
Modify
config.jsonwith your location, nation, and API key from NewsAPI.org. -
Restart the dashboard then visit http://127.0.0.1:5000/ to view your local COVID data and news!
The dashboard was written with the idea of modification and tweaking in mind, so it should be fairly easy to extend it however you please.
Format the code with
black filename.pyAnd make sure to run the tests with
pytest .in the projects root directory.