Merge pull request #632 from cmu-delphi/krivard/covidcast-py-release

Prepare covidcast-py for release 0.2.1
cmu-delphi · Jun 1, 2023 · 01d8dc4 · 01d8dc4
2 parents fd8463a + 3414805
commit 01d8dc4
Show file tree

Hide file tree

Showing 22 changed files with 45 additions and 36 deletions.
diff --git a/Python-packages/covidcast-py/covidcast/covidcast.py b/Python-packages/covidcast-py/covidcast/covidcast.py
@@ -28,7 +28,7 @@ def use_api_key(key):
     the requested parameters having multiple selections (signals, dates, issues,
     regions, etc). To be exempt from these limits, use this function to apply an
     API key to all subsequent queries. You can register for an API key at
-    <https://forms.gle/hkBr5SfQgxguAfEt7>.
+    <https://api.delphi.cmu.edu/epidata/admin/registration_form>.
 
     Consult the `API documentation
     <https://cmu-delphi.github.io/delphi-epidata/api/api_keys.html>`_

diff --git a/Python-packages/covidcast-py/docs/changelog.rst b/Python-packages/covidcast-py/docs/changelog.rst
@@ -1,6 +1,13 @@
 Changelog
 =========
 
+v0.2.1, June 1, 2023
+--------------------
+
+- Bug fix: Corrected how API keys are installed in the underlying interface.
+- Bug fix: Corrected minimum dependency version for delphi-epidata library.
+- Update: Replaced link for API key registration.
+
 v0.2.0, May 23, 2023
 --------------------
 

diff --git a/Python-packages/covidcast-py/docs/conf.py b/Python-packages/covidcast-py/docs/conf.py
@@ -21,7 +21,7 @@
 author = 'Delphi research group'
 
 # The full version, including alpha/beta/rc tags
-release = '0.2.0'
+release = '0.2.1'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/Python-packages/covidcast-py/docs/index.rst b/Python-packages/covidcast-py/docs/index.rst
@@ -35,13 +35,8 @@ To get started, check out :ref:`getting started <getting-started>`.
    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`.
+   which do not apply if you use an API key to authenticate your queries. For
+   more information, 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

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.2.0",  # also update in docs/conf.py
+    version="0.2.1",  # 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/index.doctree b/docs/covidcast-py/doctrees/index.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: 2369533cf5779109d35a10647f334044
+config: adc91b801928f140c7be8ffe81e03415
 tags: 645f666f9bcd5a90fca523b33c5a78b7
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.1, June 1, 2023
+--------------------
+
+- Bug fix: Corrected how API keys are installed in the underlying interface.
+- Bug fix: Corrected minimum dependency version for delphi-epidata library.
+- Update: Replaced link for API key registration.
+
 v0.2.0, May 23, 2023
 --------------------
 

diff --git a/docs/covidcast-py/html/_sources/index.rst.txt b/docs/covidcast-py/html/_sources/index.rst.txt
@@ -35,13 +35,8 @@ To get started, check out :ref:`getting started <getting-started>`.
    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`.
+   which do not apply if you use an API key to authenticate your queries. For
+   more information, 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

diff --git a/docs/covidcast-py/html/_static/documentation_options.js b/docs/covidcast-py/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.2.0',
+    VERSION: '0.2.1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/covidcast-py/html/changelog.html b/docs/covidcast-py/html/changelog.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Changelog &#8212; COVIDcast API client 0.2.0 documentation</title>
+    <title>Changelog &#8212; COVIDcast API client 0.2.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
@@ -33,6 +33,14 @@
 
   <section id="changelog">
 <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this heading">¶</a></h1>
+<section id="v0-2-1-june-1-2023">
+<h2>v0.2.1, June 1, 2023<a class="headerlink" href="#v0-2-1-june-1-2023" title="Permalink to this heading">¶</a></h2>
+<ul class="simple">
+<li><p>Bug fix: Corrected how API keys are installed in the underlying interface.</p></li>
+<li><p>Bug fix: Corrected minimum dependency version for delphi-epidata library.</p></li>
+<li><p>Update: Replaced link for API key registration.</p></li>
+</ul>
+</section>
 <section id="v0-2-0-may-23-2023">
 <h2>v0.2.0, May 23, 2023<a class="headerlink" href="#v0-2-0-may-23-2023" title="Permalink to this heading">¶</a></h2>
 <ul class="simple">
@@ -180,6 +188,7 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="plot_examples.html">Plotting Examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="plotting.html">Plotting Reference</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#v0-2-1-june-1-2023">v0.2.1, June 1, 2023</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#v0-2-0-may-23-2023">v0.2.0, May 23, 2023</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#v0-1-5-may-11-2021">v0.1.5, May 11, 2021</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#v0-1-4-february-24-2021">v0.1.4, February 24, 2021</a></li>

diff --git a/docs/covidcast-py/html/genindex.html b/docs/covidcast-py/html/genindex.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; COVIDcast API client 0.2.0 documentation</title>
+    <title>Index &#8212; COVIDcast API client 0.2.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />

diff --git a/docs/covidcast-py/html/getting_started.html b/docs/covidcast-py/html/getting_started.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Getting Started &#8212; COVIDcast API client 0.2.0 documentation</title>
+    <title>Getting Started &#8212; COVIDcast API client 0.2.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />

diff --git a/docs/covidcast-py/html/index.html b/docs/covidcast-py/html/index.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>COVIDcast API client &#8212; COVIDcast API client 0.2.0 documentation</title>
+    <title>COVIDcast API client &#8212; COVIDcast API client 0.2.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
@@ -55,13 +55,8 @@ <h1>COVIDcast API client<a class="headerlink" href="#covidcast-api-client" title
 anonymously. All the examples in the package documentation are compatible
 with anonymous use of the API, but <a class="reference external" href="https://cmu-delphi.github.io/delphi-epidata/api/api_keys.html">there are some limits on anonymous
 queries</a>
-which do not apply if you use an API key to authenticate your queries. If you
-regularly or frequently use our system, please consider <a class="reference external" href="https://forms.gle/hkBr5SfQgxguAfEt7">registering for a
-free API key</a> 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
-<a class="reference internal" href="signals.html#covidcast.use_api_key" title="covidcast.use_api_key"><code class="xref py py-func docutils literal notranslate"><span class="pre">covidcast.use_api_key()</span></code></a>.</p>
+which do not apply if you use an API key to authenticate your queries. For
+more information, see <a class="reference internal" href="signals.html#covidcast.use_api_key" title="covidcast.use_api_key"><code class="xref py py-func docutils literal notranslate"><span class="pre">covidcast.use_api_key()</span></code></a>.</p>
 <p>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,
@@ -103,6 +98,7 @@ <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this head
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-2-1-june-1-2023">v0.2.1, June 1, 2023</a></li>
 <li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-2-0-may-23-2023">v0.2.0, May 23, 2023</a></li>
 <li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-1-5-may-11-2021">v0.1.5, May 11, 2021</a></li>
 <li class="toctree-l2"><a class="reference internal" href="changelog.html#v0-1-4-february-24-2021">v0.1.4, February 24, 2021</a></li>

diff --git a/docs/covidcast-py/html/plot_examples.html b/docs/covidcast-py/html/plot_examples.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Plotting Examples &#8212; COVIDcast API client 0.2.0 documentation</title>
+    <title>Plotting Examples &#8212; COVIDcast API client 0.2.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />

diff --git a/docs/covidcast-py/html/plotting.html b/docs/covidcast-py/html/plotting.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Plotting Reference &#8212; COVIDcast API client 0.2.0 documentation</title>
+    <title>Plotting Reference &#8212; COVIDcast API client 0.2.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />

diff --git a/docs/covidcast-py/html/search.html b/docs/covidcast-py/html/search.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Search &#8212; COVIDcast API client 0.2.0 documentation</title>
+    <title>Search &#8212; COVIDcast API client 0.2.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />

diff --git a/docs/covidcast-py/html/searchindex.js b/docs/covidcast-py/html/searchindex.js
diff --git a/docs/covidcast-py/html/signals.html b/docs/covidcast-py/html/signals.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Fetching Data &#8212; COVIDcast API client 0.2.0 documentation</title>
+    <title>Fetching Data &#8212; COVIDcast API client 0.2.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
@@ -50,7 +50,7 @@ <h2>API keys<a class="headerlink" href="#api-keys" title="Permalink to this head
 the requested parameters having multiple selections (signals, dates, issues,
 regions, etc). To be exempt from these limits, use this function to apply an
 API key to all subsequent queries. You can register for an API key at
-&lt;<a class="reference external" href="https://forms.gle/hkBr5SfQgxguAfEt7">https://forms.gle/hkBr5SfQgxguAfEt7</a>&gt;.</p>
+&lt;<a class="reference external" href="https://api.delphi.cmu.edu/epidata/admin/registration_form">https://api.delphi.cmu.edu/epidata/admin/registration_form</a>&gt;.</p>
 <p>Consult the <a class="reference external" href="https://cmu-delphi.github.io/delphi-epidata/api/api_keys.html">API documentation</a>
 for details on our API key policies.</p>
 </dd></dl>