Merge pull request #626 from cmu-delphi/krivard/covidcast-python-release

Prepare covidcast-py v0.2.0 for release
cmu-delphi · May 23, 2023 · 072e317 · 072e317
2 parents 5900ee6 + 89444e7
commit 072e317
Show file tree

Hide file tree

Showing 73 changed files with 1,321 additions and 12,064 deletions.
diff --git a/Python-packages/covidcast-py/Makefile b/Python-packages/covidcast-py/Makefile
@@ -16,8 +16,9 @@ install:  venv
 	pip install -r requirements_dev.txt; \
 	pip install -e .
 
-build:
-	python3 setup.py clean
+build: venv
+	. env/bin/activate; \
+	python3 setup.py clean && \
 	python3 setup.py sdist bdist_wheel
 
 sphinx: venv

diff --git a/Python-packages/covidcast-py/docs/changelog.rst b/Python-packages/covidcast-py/docs/changelog.rst
@@ -1,8 +1,8 @@
 Changelog
 =========
 
-v0.1.6, May _, 2023
--------------------
+v0.2.0, May 23, 2023
+--------------------
 
 - New feature: This package now supports queries that require an API key. Call
   :py:func:`covidcast.use_api_key` before running fetch functions to

diff --git a/Python-packages/covidcast-py/docs/conf.py b/Python-packages/covidcast-py/docs/conf.py
@@ -17,11 +17,11 @@
 # -- Project information -----------------------------------------------------
 
 project = 'COVIDcast API client'
-copyright = '2021, Delphi research group'
+copyright = '2023, Delphi research group'
 author = 'Delphi research group'
 
 # The full version, including alpha/beta/rc tags
-release = '0.1.5'
+release = '0.2.0'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/Python-packages/covidcast-py/setup.py b/Python-packages/covidcast-py/setup.py
@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="covidcast",
-    version="0.1.5",  # also update in docs/conf.py
+    version="0.2.0",  # also update in docs/conf.py
     author="Alex Reinhart",
     author_email="areinhar@stat.cmu.edu",
     description="Access COVID-19 data through the Delphi COVIDcast API",

diff --git a/docs/covidcast-py/doctrees/changelog.doctree b/docs/covidcast-py/doctrees/changelog.doctree
diff --git a/docs/covidcast-py/doctrees/environment.pickle b/docs/covidcast-py/doctrees/environment.pickle
diff --git a/docs/covidcast-py/doctrees/getting_started.doctree b/docs/covidcast-py/doctrees/getting_started.doctree
diff --git a/docs/covidcast-py/doctrees/index.doctree b/docs/covidcast-py/doctrees/index.doctree
diff --git a/docs/covidcast-py/doctrees/plot_examples.doctree b/docs/covidcast-py/doctrees/plot_examples.doctree
diff --git a/docs/covidcast-py/doctrees/plotting.doctree b/docs/covidcast-py/doctrees/plotting.doctree
diff --git a/docs/covidcast-py/doctrees/signals.doctree b/docs/covidcast-py/doctrees/signals.doctree
diff --git a/docs/covidcast-py/html/.buildinfo b/docs/covidcast-py/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 8cf3e1c49da6be7468f46c8184fca677
+config: 2369533cf5779109d35a10647f334044
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/covidcast-py/html/plot_examples-5.png → ...7c15b2675e7ed1dc95d19/plot_examples-5.png b/docs/covidcast-py/html/plot_examples-5.png → ...7c15b2675e7ed1dc95d19/plot_examples-5.png
diff --git a/docs/covidcast-py/html/plot_examples-2.png → ...bcf3710411aa42cf37113/plot_examples-2.png b/docs/covidcast-py/html/plot_examples-2.png → ...bcf3710411aa42cf37113/plot_examples-2.png
diff --git a/...vidcast-py/html/plot_examples-7.hires.png → ...3d0aaf2de592836/plot_examples-7.hires.png b/...vidcast-py/html/plot_examples-7.hires.png → ...3d0aaf2de592836/plot_examples-7.hires.png
diff --git a/docs/covidcast-py/html/plot_examples-2.pdf → ...afad3e2a547c8b2caf053/plot_examples-2.pdf b/docs/covidcast-py/html/plot_examples-2.pdf → ...afad3e2a547c8b2caf053/plot_examples-2.pdf
diff --git a/docs/covidcast-py/html/plot_examples-6.png → ...435b55e1e98ecab422147/plot_examples-6.png b/docs/covidcast-py/html/plot_examples-6.png → ...435b55e1e98ecab422147/plot_examples-6.png
diff --git a/...vidcast-py/html/plot_examples-1.hires.png → ...f534143657b8588/plot_examples-1.hires.png b/...vidcast-py/html/plot_examples-1.hires.png → ...f534143657b8588/plot_examples-1.hires.png
diff --git a/docs/covidcast-py/html/plot_examples-5.py → ...df9d30227aca49c0e60421/plot_examples-5.py b/docs/covidcast-py/html/plot_examples-5.py → ...df9d30227aca49c0e60421/plot_examples-5.py
diff --git a/docs/covidcast-py/html/plot_examples-4.pdf → ...ac62defa66c1e1bac3566/plot_examples-4.pdf b/docs/covidcast-py/html/plot_examples-4.pdf → ...ac62defa66c1e1bac3566/plot_examples-4.pdf
diff --git a/docs/covidcast-py/html/plot_examples-2.py → ...8d40bc70776db507250bec/plot_examples-2.py b/docs/covidcast-py/html/plot_examples-2.py → ...8d40bc70776db507250bec/plot_examples-2.py
diff --git a/docs/covidcast-py/html/plot_examples-3.pdf → ...62e38e77d3aec1d4024b6/plot_examples-3.pdf b/docs/covidcast-py/html/plot_examples-3.pdf → ...62e38e77d3aec1d4024b6/plot_examples-3.pdf
diff --git a/...vidcast-py/html/plot_examples-4.hires.png → ...82136711c3fbbbb/plot_examples-4.hires.png b/...vidcast-py/html/plot_examples-4.hires.png → ...82136711c3fbbbb/plot_examples-4.hires.png
diff --git a/docs/covidcast-py/html/plot_examples-3.py → ...0a37ed852fc9bdad934c81/plot_examples-3.py b/docs/covidcast-py/html/plot_examples-3.py → ...0a37ed852fc9bdad934c81/plot_examples-3.py
diff --git a/docs/covidcast-py/html/plot_examples-1.png → ...9693a35552bc97b51cc6b/plot_examples-1.png b/docs/covidcast-py/html/plot_examples-1.png → ...9693a35552bc97b51cc6b/plot_examples-1.png
diff --git a/docs/covidcast-py/html/plot_examples-7.png → ...1e01abb335ce9b415571c/plot_examples-7.png b/docs/covidcast-py/html/plot_examples-7.png → ...1e01abb335ce9b415571c/plot_examples-7.png
diff --git a/...vidcast-py/html/plot_examples-2.hires.png → ...0f0193f206e604a/plot_examples-2.hires.png b/...vidcast-py/html/plot_examples-2.hires.png → ...0f0193f206e604a/plot_examples-2.hires.png
diff --git a/...vidcast-py/html/plot_examples-6.hires.png → ...34fea93884ee4f3/plot_examples-6.hires.png b/...vidcast-py/html/plot_examples-6.hires.png → ...34fea93884ee4f3/plot_examples-6.hires.png
diff --git a/...vidcast-py/html/plot_examples-5.hires.png → ...db0759225e72376/plot_examples-5.hires.png b/...vidcast-py/html/plot_examples-5.hires.png → ...db0759225e72376/plot_examples-5.hires.png
diff --git a/docs/covidcast-py/html/plot_examples-5.pdf → ...eb680b408d696103f7366/plot_examples-5.pdf b/docs/covidcast-py/html/plot_examples-5.pdf → ...eb680b408d696103f7366/plot_examples-5.pdf
diff --git a/...vidcast-py/html/plot_examples-3.hires.png → ...d05283d63a266d4/plot_examples-3.hires.png b/...vidcast-py/html/plot_examples-3.hires.png → ...d05283d63a266d4/plot_examples-3.hires.png
diff --git a/docs/covidcast-py/html/plot_examples-1.pdf → ...3244d635d037298cdb4e0/plot_examples-1.pdf b/docs/covidcast-py/html/plot_examples-1.pdf → ...3244d635d037298cdb4e0/plot_examples-1.pdf
diff --git a/docs/covidcast-py/html/plot_examples-4.png → ...a8c0eb40de19e689e4d0c/plot_examples-4.png b/docs/covidcast-py/html/plot_examples-4.png → ...a8c0eb40de19e689e4d0c/plot_examples-4.png
diff --git a/docs/covidcast-py/html/plot_examples-1.py → ...ba94fc749687d0d5a05bf0/plot_examples-1.py b/docs/covidcast-py/html/plot_examples-1.py → ...ba94fc749687d0d5a05bf0/plot_examples-1.py
diff --git a/docs/covidcast-py/html/plot_examples-7.pdf → ...adcb40083e78e7a5287a2/plot_examples-7.pdf b/docs/covidcast-py/html/plot_examples-7.pdf → ...adcb40083e78e7a5287a2/plot_examples-7.pdf
diff --git a/docs/covidcast-py/html/plot_examples-3.png → ...c113335f39be6352823c2/plot_examples-3.png b/docs/covidcast-py/html/plot_examples-3.png → ...c113335f39be6352823c2/plot_examples-3.png
diff --git a/docs/covidcast-py/html/plot_examples-7.py → ...c8b7b132f415bd8ef2bdc4/plot_examples-7.py b/docs/covidcast-py/html/plot_examples-7.py → ...c8b7b132f415bd8ef2bdc4/plot_examples-7.py
diff --git a/docs/covidcast-py/html/plot_examples-6.pdf → ...4d1b487b8694a98eb3642/plot_examples-6.pdf b/docs/covidcast-py/html/plot_examples-6.pdf → ...4d1b487b8694a98eb3642/plot_examples-6.pdf
diff --git a/docs/covidcast-py/html/plot_examples-4.py → ...77dd16a6bb13e5255f47b8/plot_examples-4.py b/docs/covidcast-py/html/plot_examples-4.py → ...77dd16a6bb13e5255f47b8/plot_examples-4.py
diff --git a/docs/covidcast-py/html/plot_examples-6.py → ...c8ffca0588503bd7c99492/plot_examples-6.py b/docs/covidcast-py/html/plot_examples-6.py → ...c8ffca0588503bd7c99492/plot_examples-6.py
diff --git a/docs/covidcast-py/html/_sources/changelog.rst.txt b/docs/covidcast-py/html/_sources/changelog.rst.txt
@@ -1,6 +1,13 @@
 Changelog
 =========
 
+v0.2.0, May 23, 2023
+--------------------
+
+- New feature: This package now supports queries that require an API key. Call
+  :py:func:`covidcast.use_api_key` before running fetch functions to
+  authenticate your requests.
+
 v0.1.5, May 11, 2021
 --------------------
 

diff --git a/docs/covidcast-py/html/_sources/getting_started.rst.txt b/docs/covidcast-py/html/_sources/getting_started.rst.txt
@@ -104,6 +104,18 @@ May 1st were updated on May 23rd based on new data, giving a ``lag`` of 22 days.
 See the :py:func:`covidcast.signal` documentation for details on the returned
 data frame.
 
+.. _api-key-usage:
+.. note ::
+
+   By default, this package submits queries to the API anonymously. If you have an
+   API key, you can use it with this package by calling
+   :py:func:`covidcast.use_api_key`, then call fetch functions as normal:
+
+       >>> covidcast.use_api_key("your_api_key")
+       >>> data = covidcast.signal("fb-survey", "smoothed_cli",
+       ...                         date(2020, 5, 1), date(2020, 5, 7),
+       ...                         "county")
+
 The API documentation lists each available signal and provides technical details
 on how it is estimated and how its standard error is calculated. In this case,
 for example, the `symptom surveys documentation page

diff --git a/docs/covidcast-py/html/_sources/index.rst.txt b/docs/covidcast-py/html/_sources/index.rst.txt
@@ -31,10 +31,23 @@ To get started, check out :ref:`getting started <getting-started>`.
    notified of package updates, new data sources, corrections, and other
    updates.
 
-.. warning :: If you use data from the COVIDcast Epidata API to power a public
-   product, dashboard, app, or other service, please download the data you need
-   and store it centrally rather than making API requests for every user. Our
-   server resources are limited and cannot support high-volume interactive use.
+.. warning :: By default, this package submits queries to the API
+   anonymously. All the examples in the package documentation are compatible
+   with anonymous use of the API, but `there are some limits on anonymous
+   queries <https://cmu-delphi.github.io/delphi-epidata/api/api_keys.html>`_
+   which do not apply if you use an API key to authenticate your queries. If you
+   regularly or frequently use our system, please consider `registering for a
+   free API key <https://forms.gle/hkBr5SfQgxguAfEt7>`_ even if your usage falls
+   within the anonymous usage limits. API key usage helps us understand who and
+   how others are using our Delphi Epidata API, which may in turn inform our
+   future research, data partnerships, and funding. For usage instructions, see
+   :py:func:`covidcast.use_api_key`.
+
+   As we are a research group, our server resources are limited and cannot
+   support high-volume interactive use (with or without an API key). If you use
+   data from the COVIDcast Epidata API to power a public product, dashboard,
+   app, or other service, please download the data you need and store it
+   centrally rather than making API requests for every user.
 
    See also the `COVIDcast Terms of Use
    <https://covidcast.cmu.edu/terms-of-use.html>`_, noting that the data is a

diff --git a/docs/covidcast-py/html/_sources/signals.rst.txt b/docs/covidcast-py/html/_sources/signals.rst.txt
@@ -1,6 +1,11 @@
 Fetching Data
 =============
 
+API keys
+--------
+
+.. autofunction:: covidcast.use_api_key
+
 Signals
 -------
 

diff --git a/docs/covidcast-py/html/_static/alabaster.css b/docs/covidcast-py/html/_static/alabaster.css
@@ -419,7 +419,9 @@ table.footnote td {
 }
 
 dl {
-    margin: 0;
+    margin-left: 0;
+    margin-right: 0;
+    margin-top: 0;
     padding: 0;
 }