covid-data-api 1.5
 Real time data extractor - web scrapper for covid19 from john hopkins university url: https://gisanddata.maps.arcgis.com/apps/opsdashboard/index.html#/bda7594740fd40299423467b48e9ecf6
License: MIT
Requires Python: >=3.6
Keywords: Data extractor covid19

## COVID-19 DATA API

This package makes **COVID-19** data available through python API. All the data are directy taken from the [CSSEGISandData-covi19](https://github.com/CSSEGISandData/COVID-19#2019-novel-coronavirus-covid-19-2019-ncov-data-repository-by-johns-hopkins-csse) with the below mentioned data sources. There are several methods to extract the statistics and counts for the coutry or province.

## Installation:
#### Also available in pypi:
    covid-data-api

#### From GitHub:
  * Clone this repo.
  * pip install -r requirements.txt
  * python setup.py install

## How to user:

#### Initialising the instance/api:
```
from covid.api import CovId19Data

api = CovId19Data(force=False)
```
If force = True, every time object is instantiated new data is downloaded. Otherwise data will be refreshed after 24 hrs.

#### Method 1: Get stats:
Get the latest total stats for all confirmed, deaths and recovered till the latest date available.
```
res = api.get_stats()
```
#### Method 2: Get records for all the countries:
```
res = api.get_all_records_by_country()
```
#### Method 3: Get records for all the state/Province:
```
res = api.get_all_records_by_provinces()
```

#### Method 4: Filter by Country:
To find all the countries availabe, plese use show_all_available_countries api.
```
res = api.filter_by_country("ireland")
```

#### Method 5: Filter by Province/State:
To find all the countries availabe, plese use show_all_available_regions api.
```
res = api.filter_by_province("British Columbia")
```

#### Method 6: Show all available Countries:
```
res = api.show_available_countries()
```
#### Method 7: Show all valiable Province/State:
```
res = api.show_available_regions()
```

#### Method 8: Get history data for a given Country:
```
res = api.get_history_by_country("ireland")
```
Shows all the country metrics confirmed, recovered and deaths for the dates till the latest date.

#### Method 9: Get history data for a given State/Province:
```
res = api.get_history_by_province("British Columbia")
```
Shows all the state/province metrics confirmed, recovered and deaths for the dates till the latest date.

## Data Sources:

All used data sources [CSSEGISandData-covi19](https://github.com/CSSEGISandData/COVID-19#2019-novel-coronavirus-covid-19-2019-ncov-data-repository-by-johns-hopkins-csse).

## Support and Maintenance:

Please raise an issues with issues of this git repo. This is not actively supported, however anyone with the interest can solve the raised issues.

## Copying and License
##### Terms and conditions of the data provider:
[CSSEGISandData-covi19](https://github.com/CSSEGISandData/COVID-19#2019-novel-coronavirus-covid-19-2019-ncov-data-repository-by-johns-hopkins-csse)

##### Terms and Condition of this repo:
License: [MIT](https://github.com/gtkChop/covid19/blob/master/LICENSE)

## Authors:

 * [gtkChop](https://github.com/gtkChop)
 * [vipin-tech](https://github.com/vipin-tech)

see also [contributors](https://github.com/gtkChop/covid19/graphs/contributors)

## ChangeLog:

* 1.1, 1.2, 1.3 - Initial Versions

* 1.4 - Change in recovered cases in source CoViD data repository.