covid-data-dashboard-pkg 1.0.2
A simple personalised covid dashboard to visualise data streams relevant to the COVID-19 pandemic
Requires Python: >=3.6

# Covid Data Dashboard

A simple personalised covid dashboard to visualise data streams relevant to the COVID-19 pandemic

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install the Covid Data Dashboard.

```bash
pip install covid-data-dashboard-pkg
```

### Requirements
Public Health England's COVID API
```bash
pip install uk_covid19
```

Flask
```bash
pip install flask
```

## Usage
### Introduction
This section will serve as a basic overview/tutorial of the Covid Data Dashboard's functionality and usage.

To run the application, navigate to the installation location and execute the terminal command:
```bash
python main.py
```
Note: if you have multiple versions of Python installed, you may need to use the following command instead:
```bash
python3 main.py
```

Now navigate to the main webpage at http://127.0.0.1:5000/index

### Covid Data
The Covid Data Dashboard displays various statistics about the COVID-19 pandemic. These include local 7-day infection rate, national 7-day infection rate, national hospital cases, and national death toll. These are displayed on the centre column. 
These statistics are sourced from Public Health England, and are updated each time the webpage is refreshed, as well as whenever a scheduled covid update occurs (more on update in the 'Scheduling' section.
Local location, and national location can be changed by adjusting the values in the SETTINGS section of the config file (config.ini).

### Covid News
The dashboard also displays news about the COVID-19 pandemic in the right-hand side. News articles can be hidden by pressing the 'x' in the corner of the item.
These artilces are sourced from NewsAPI.org, and are updated each time the webpage is refreshed, as well as whenever a scheduled news update occurs (more on update in the 'Scheduling' section.
By editing the config file, you can also change how news articles are sorted.
Possible options: relevancy, popularity, publishedAt.
* relevancy = articles more closely related to q come first.
* popularity = articles from popular sources and publishers come first.
* publishedAt = newest articles come first. 

### Scheduling
Updates can be scheduled by inputting a desired time into the input field on the webpage. A name/title must be given for the update. You can also select whether you want it to update covid news, data or both.
Updates are displayed on the left hand side of the page.

### Config
Language, national location, and local location (lower-tier local authorities) can be configured in the config.ini file.

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License
[GPL3]

## Changelog
### 0.0.1
#### Initial test release

### 0.0.2
#### Second test release
* Replaced placeholder names

### 1.0.0
#### Full release
* Added testing
* Removed redundant commented-out code
* Expanded config file to include more details for constructing the NewsAPI URL
* Improved docstrings
* Improved PEP8 and Pylint compliance

### 1.0.1
#### Update
* Removed typos from README.md file

### 1.0.2
#### Final release
* Removed typos from README.md file
* Added more settings for news request