Metadata-Version: 2.1
Name: COVID19Py
Version: 0.2.0
Summary: Python API Wrapper for tracking Coronavirus (COVID-19, SARS-CoV-2) via https://github.com/ExpDev07/coronavirus-tracker-api
Home-page: https://github.com/Kamaropoulos/covid19py
Author: Konstantinos Kamaropoulos
Author-email: k@kamaropoulos.com
License: GPLv3
Description: # COVID19Py
        <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
        [![Downloads](https://pepy.tech/badge/covid19py)](https://pepy.tech/project/covid19py)
        [![Downloads](https://pepy.tech/badge/covid19py/month)](https://pepy.tech/project/covid19py/month)
        [![Downloads](https://pepy.tech/badge/covid19py/week)](https://pepy.tech/project/covid19py/week)
        [![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](https://opensource.org/licenses/)
        [![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
        [![CodeFactor](https://www.codefactor.io/repository/github/kamaropoulos/covid19py/badge)](https://www.codefactor.io/repository/github/kamaropoulos/covid19py)
        [![HitCount](http://hits.dwyl.com/Kamaropoulos/COVID19Py.svg)](http://hits.dwyl.com/Kamaropoulos/COVID19Py)
        [![GitHub stars](https://img.shields.io/github/stars/Kamaropoulos/COVID19Py.svg?style=social&label=Star)](https://github.com/Kamaropoulos/COVID19Py)
        <!-- ALL-CONTRIBUTORS-BADGE:END -->
        Python API Wrapper for tracking Coronavirus (COVID-19, SARS-CoV-2) via https://github.com/ExpDev07/coronavirus-tracker-api
        
        ## About
        
        COVID19Py is a Python wrapper for the [ExpDev07/coronavirus-tracker-api](https://github.com/ExpDev07/coronavirus-tracker-api) REST API.
        It retrieves data directly from [@ExpDev07](https://github.com/ExpDev07)'s backend but it can also be set up to use a different backend.
        
        To achieve this, just pass the URL of the backend as a parameter to the library's constructor:
        ```python
        import COVID19Py
        covid19 = COVID19Py.COVID19("https://my-awesome-covid19-backend")
        ```
        ## Installation
        
        In order install this package, simply run:
        
        ```bash
        pip install COVID19Py
        ```
        
        ## Usage
        
        To use COVID19Py, you first need to import the package and then create a new instance:
        
        ```python
        import COVID19Py
        covid19 = COVID19Py.COVID19()
        ```
        
        ### Getting latest amount of total confirmed cases, deaths, and recoveries:
        
        ```python
        latest = covid19.getLatest()
        ```
        
        ### Getting all locations:
        
        ```python
        locations = covid19.getLocations()
        ```
        
        or:
        
        ```python
        locations = covid19.getLocations(timelines=True)
        ```
        to also get timelines.
        
        You can also rank the results by `confirmed`, `deaths` or `recovered`.
        
        ```python
        locations = covid19.getLocations(rank_by='recovered')
        ```
        
        ### Getting location by country code:
        
        ```python
        location = covid19.getLocationByCountryCode("US")
        ```
        or:
        ```python
        location = covid19.getLocationByCountryCode("US", timelines=True)
        ```
        to also get timelines.
        
        ### Getting a specific location (includes timelines by default):
        
        ```python
        location = covid19.getLocationById(39)
        ```
        
        ### Getting all data at once:
        
        You can also get all the available data with one command.
        
        ```python
        data = covid19.getAll()
        ```
        or:
        ```python
        data = covid19.getAll(timelines=True)
        ```
        to also get timelines.
        
        `latest` will be available on `data["latest"]` and `locations` will be available on `data["locations"]`.
        
        ### Getting `latest` deltas:
        
        When using `getAll()`, COVID19Py will also store the previous version of the retrieved data. This allows us to easily see how data changed since the last time we requested them.
        
        ```python
        changes = covid19.getLatestChanges()
        ```
        ```json
        {
            "confirmed": 512,
            "deaths": 16,
            "recovered": 1024
        }
        ```
        
        ## Contributors âœ¨
        
        Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
        
        <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
        <!-- prettier-ignore-start -->
        <!-- markdownlint-disable -->
        <table>
          <tr>
            <td align="center"><a href="https://kamaropoulos.com"><img src="https://avatars0.githubusercontent.com/u/10237776?v=4" width="100px;" alt=""/><br /><sub><b>Konstantinos Kamaropoulos</b></sub></a><br /><a href="https://github.com/Kamaropoulos/COVID19Py/commits?author=Kamaropoulos" title="Code">ðŸ’»</a> <a href="https://github.com/Kamaropoulos/COVID19Py/commits?author=Kamaropoulos" title="Documentation">ðŸ“–</a> <a href="#example-Kamaropoulos" title="Examples">ðŸ’¡</a></td>
            <td align="center"><a href="http://www.jaroddeweese.com"><img src="https://avatars1.githubusercontent.com/u/32393906?v=4" width="100px;" alt=""/><br /><sub><b>Jarod DeWeese</b></sub></a><br /><a href="https://github.com/Kamaropoulos/COVID19Py/commits?author=jdeweese1" title="Code">ðŸ’»</a> <a href="https://github.com/Kamaropoulos/COVID19Py/commits?author=jdeweese1" title="Documentation">ðŸ“–</a></td>
          </tr>
        </table>
        
        <!-- markdownlint-enable -->
        <!-- prettier-ignore-end -->
        <!-- ALL-CONTRIBUTORS-LIST:END -->
        
        This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
        
Keywords: covid19,coronavirus,api,covid-19,wrapper
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
Description-Content-Type: text/markdown
