Metadata-Version: 2.1
Name: covid19pyclient
Version: 1.0.0
Summary: A Python Wrapper around the COVID-19 API 'https://github.com/marlon360/rki-covid-api'.
Home-page: https://github.com/NiklasTiede/covid19pyclient
Author: Niklas Tiede
Author-email: niklastiede2@gmail.com
License: MIT license
Project-URL: Documentation, https://covid19pyclient.readthedocs.io/en/latest/
Project-URL: Source Code, https://github.com/NiklasTiede/covid19pyclient
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: requests (>=2.21.0)
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: tox ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'



# Example

```python
import json
from covid19pyclient import CovidData

covid = CovidData()
data = covid.germany_total()

print(json.dumps(data, sort_keys=True, indent=4, ensure_ascii=False))
```

```yaml
{
"cases": 3682911,
"casesPer100k": 4428.3475391975035,
"casesPerWeek": 29248,
"deaths": 88595,
"delta": {
"cases": 1785,
"deaths": 153,
"recovered": 11714
},
"meta": {
"contact": "Marlon Lueckert (m.lueckert@me.com)",
"info": "https://github.com/marlon360/rki-covid-api",
"lastCheckedForUpdate": "2021-06-01T08:17:40.241Z",
"lastUpdate": "2021-05-31T23:00:00.000Z",
"source": "Robert Koch-Institut"
},
"r": {
"date": "2021-05-27T00:00:00.000Z",
"value": 0.91
},
"recovered": 3498382,
"weekIncidence": 35.16791712491793
}
```

# Featured Data

- Total number of COVID-19 related cases, deaths, incidence, recovered (country, by state, by district, by demographics)
- Timeseries data (country, districts, vaccinations, tests)
- And data derived therefrom

# Installation

You can install `covid19pyclient` with pip.

```console
$ pip install covid19pyclient
```

Alternatively, you can download and install `covid19pyclient` from github:

```console
$ pip install git+https://github.com/NiklasTiede/Covid19PyClient
```

# How to use

`CovidData`'s class methods return the requested as dictionary.

```python
from covid19pyclient import CovidData

covid = CovidData()
```
Here's a list of all the methods which can be used to access different data about COVID-19 in germany:

```python
covid.germany_total()
covid.germany_timeseries()
covid.germany_by_agegroups()

covid.districts_total()
covid.districts_timeseries()

covid.states_total()
covid.states_by_agegroups()

covid.vaccinations_total()
covid.vaccinations_timeseries()

covid.testing_timeseries()
```

For more information about these function, see [Documentation](https://covid19pyclient.readthedocs.io/en/latest/).

<!-- PYPI-Docs:END -->


