A wrapper allowing users to get specific state-based COVID statistics from the Covid Act Now database.
Project description
Covid Act Now Database Wrapper
This package is an extremely bare-bones wrapper around Covid Act Now's database of COVID-19 related information. View the PyPi project here, and the original post page here.
Usage is simple. Install the package with pip install covidactnow
.
Instantiate a user object with your API key as an argument. You can easily generate an API key here.
import covidactnow
api = covidactnow.User(api_key = 'yourapikey')
washingtonInfectionRate = api.infRate('WA')
massachussettsVaxRate = api.vaxRate('MA')
print(f"{washingtonInfectionRate = }")
print(f"{massachussettsVaxRate = }")
This will result (with different data, of course):
washingtonInfectionRate = 1.16
massachussettsVaxRate = 76.3
To view the docstring (explainer) of a particular function, use covidactnow.User.infRate.__doc__
where infRate
can be repalced with any other function. For example, running print(covidactnow.User.freeBedPercentage.__doc__)
will return: Get's the percentage of free hospital beds by state.
Depending on your IDE, hovering over a function in the editor will show the function's docstring (works in VS Code).
import covidactnow
if __name__ == "__main__":
print(covidactnow.User.infRate.__doc__)
print(covidactnow.User.freeBedPercentage.__doc__)
""" Result:
>>> Gets today's COVID infection rate by state.
>>> Get's the percentage of free hospital beds by state.
"""
----
For more information on how the wrapper works, particularly how it was redesigned to be package-friendly, read the "Updated for Distribution" section of this [page](https://covidinfo.preritdas.com). Note that this version has been updated to get data from within a `User` class allowing individual API keys to be used (as opposed to defining a state as an object and defining statistics as object attributes).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file covidactnow-1.1.76.tar.gz
.
File metadata
- Download URL: covidactnow-1.1.76.tar.gz
- Upload date:
- Size: 3.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e21152c47eaf4d52fdd82c81db7f7aecf790586576623bd8a88ff7bb9547bf1c |
|
MD5 | ebdf71d203bbcf534fd337a6e7c38917 |
|
BLAKE2b-256 | ce2089fd7d7556f6e4487f9059cd95e1e83c50c98f516d218a07b93ee479ac0f |
Provenance
File details
Details for the file covidactnow-1.1.76-py3-none-any.whl
.
File metadata
- Download URL: covidactnow-1.1.76-py3-none-any.whl
- Upload date:
- Size: 3.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 159446c2b6fbcaa60fbf7f691f8e0b9ab8406940f0af4e7395bc2e5de8ae5e6e |
|
MD5 | 88924e8b1651f27e44ceb509933efee2 |
|
BLAKE2b-256 | 3a52c6424d1bd72e2f3b07eef5d0547715bcb639dc2b6d8b22c32f9e0bbcfe09 |