epidatpy¶
This package provides Python access to the Delphi Epidata API published by the Delphi research group at Carnegie Mellon University. The package source code and bug tracker can be found on GitHub.
Note
You should consider subscribing to the API mailing list to be notified of package updates, new data sources, corrections, and other updates.
See also the CMU Delphi Terms of Use, noting that the data is a research product and not warranted for a particular purpose.
Installation¶
This package will soon be available on PyPI as epidatpy. Meanwhile, it can be installed from GitHub:
pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy"
API Keys¶
The Delphi Epidata API requires a (free) API key for full functionality. To
generate your key, register for a pseudo-anonymous account here and see more
discussion on the general API website. The epidatpy
client will automatically look for this key in the environment variable
DELPHI_EPIDATA_KEY. We recommend storing your key in a .env file, using
python-dotenv to load it into
your environment, and adding .env to your .gitignore file.
Note that for the time being, the private endpoints (i.e. those prefixed with
pvt) will require additional permissions (contact us for more information).