Skip to content

Commit

Permalink
Deploy dev from d2d0202
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Jun 21, 2023
1 parent da9cae2 commit ef70525
Show file tree
Hide file tree
Showing 59 changed files with 105 additions and 73 deletions.
2 changes: 1 addition & 1 deletion dev/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ <h1>All modules for which code is available</h1>
<p>

&copy; Copyright 2023, The Pooch Developers.<br/>
Last updated on Feb 27, 2023.<br/>
Last updated on Jun 21, 2023.<br/>
</p>
</footer>
</main>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/pooch.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,7 @@ <h1>Source code for pooch</h1><div class="highlight"><pre>
<p>

&copy; Copyright 2023, The Pooch Developers.<br/>
Last updated on Feb 27, 2023.<br/>
Last updated on Jun 21, 2023.<br/>
</p>
</footer>
</main>
Expand Down
4 changes: 2 additions & 2 deletions dev/_modules/pooch/core.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,7 @@ <h1>Source code for pooch.core</h1><div class="highlight"><pre>
<span class="sd"> existing file needs to be updated.</span>
<span class="sd"> fname : str or None</span>
<span class="sd"> The name that will be used to save the file. Should NOT include the</span>
<span class="sd"> full the path, just the file name (it will be appended to *path*). If</span>
<span class="sd"> full path, just the file name (it will be appended to *path*). If</span>
<span class="sd"> None, will create a unique file name using a combination of the last</span>
<span class="sd"> part of the URL (assuming it&#39;s the file name) and the MD5 hash of the</span>
<span class="sd"> URL. For example, ``81whdo2d2e928yd1wi22-data-file.csv``. This ensures</span>
Expand Down Expand Up @@ -1259,7 +1259,7 @@ <h1>Source code for pooch.core</h1><div class="highlight"><pre>
<p>

&copy; Copyright 2023, The Pooch Developers.<br/>
Last updated on Feb 27, 2023.<br/>
Last updated on Jun 21, 2023.<br/>
</p>
</footer>
</main>
Expand Down
4 changes: 2 additions & 2 deletions dev/_modules/pooch/downloaders.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -942,7 +942,7 @@ <h1>Source code for pooch.downloaders</h1><div class="highlight"><pre>

<span class="sd"> * `figshare &lt;https://www.figshare.com&gt;`__</span>
<span class="sd"> * `Zenodo &lt;https://www.zenodo.org&gt;`__</span>
<span class="sd"> * `DataVerse &lt;https://dataverse.org/&gt;`__ instances</span>
<span class="sd"> * `Dataverse &lt;https://dataverse.org/&gt;`__ instances</span>

<span class="sd"> .. attention::</span>

Expand Down Expand Up @@ -1506,7 +1506,7 @@ <h1>Source code for pooch.downloaders</h1><div class="highlight"><pre>
<p>

&copy; Copyright 2023, The Pooch Developers.<br/>
Last updated on Feb 27, 2023.<br/>
Last updated on Jun 21, 2023.<br/>
</p>
</footer>
</main>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/pooch/hashes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -663,7 +663,7 @@ <h1>Source code for pooch.hashes</h1><div class="highlight"><pre>
<p>

&copy; Copyright 2023, The Pooch Developers.<br/>
Last updated on Feb 27, 2023.<br/>
Last updated on Jun 21, 2023.<br/>
</p>
</footer>
</main>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/pooch/processors.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -812,7 +812,7 @@ <h1>Source code for pooch.processors</h1><div class="highlight"><pre>
<p>

&copy; Copyright 2023, The Pooch Developers.<br/>
Last updated on Feb 27, 2023.<br/>
Last updated on Jun 21, 2023.<br/>
</p>
</footer>
</main>
Expand Down
2 changes: 1 addition & 1 deletion dev/_modules/pooch/utils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -788,7 +788,7 @@ <h1>Source code for pooch.utils</h1><div class="highlight"><pre>
<p>

&copy; Copyright 2023, The Pooch Developers.<br/>
Last updated on Feb 27, 2023.<br/>
Last updated on Jun 21, 2023.<br/>
</p>
</footer>
</main>
Expand Down
4 changes: 4 additions & 0 deletions dev/_sources/api/generated/pooch.DOIDownloader.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ pooch.DOIDownloader








Expand Down Expand Up @@ -130,6 +132,8 @@ pooch.DOIDownloader








Expand Down
4 changes: 4 additions & 0 deletions dev/_sources/api/generated/pooch.Decompress.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ pooch.Decompress








Expand Down Expand Up @@ -142,6 +144,8 @@ pooch.Decompress








Expand Down
4 changes: 4 additions & 0 deletions dev/_sources/api/generated/pooch.FTPDownloader.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ pooch.FTPDownloader








Expand Down Expand Up @@ -130,6 +132,8 @@ pooch.FTPDownloader








Expand Down
4 changes: 4 additions & 0 deletions dev/_sources/api/generated/pooch.HTTPDownloader.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ pooch.HTTPDownloader








Expand Down Expand Up @@ -130,6 +132,8 @@ pooch.HTTPDownloader








Expand Down
4 changes: 4 additions & 0 deletions dev/_sources/api/generated/pooch.Pooch.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ pooch.Pooch








Expand Down Expand Up @@ -174,6 +176,8 @@ pooch.Pooch








Expand Down
4 changes: 4 additions & 0 deletions dev/_sources/api/generated/pooch.SFTPDownloader.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ pooch.SFTPDownloader








Expand Down Expand Up @@ -130,6 +132,8 @@ pooch.SFTPDownloader








Expand Down
4 changes: 4 additions & 0 deletions dev/_sources/api/generated/pooch.Untar.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ pooch.Untar








Expand Down Expand Up @@ -138,6 +140,8 @@ pooch.Untar








Expand Down
4 changes: 4 additions & 0 deletions dev/_sources/api/generated/pooch.Unzip.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ pooch.Unzip








Expand Down Expand Up @@ -142,6 +144,8 @@ pooch.Unzip








Expand Down
Binary file removed dev/_static/__pycache__/__init__.cpython-310.pyc
View file
Binary file not shown.
Binary file added dev/_static/__pycache__/__init__.cpython-311.pyc
View file
Binary file not shown.
10 changes: 5 additions & 5 deletions dev/about.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -487,8 +487,8 @@ <h2> Contents </h2>
<div class="section" id="use-cases">
<h2>Use cases<a class="headerlink" href="#use-cases" title="Permalink to this headline"></a></h2>
<div class="tabbed-set docutils">
<input checked="checked" id="60fbd169-9f91-4053-a53a-0c55f6b7881f" name="85c76eb9-8457-4a71-9d49-b3faa0ea973b" type="radio">
</input><label class="tabbed-label" for="60fbd169-9f91-4053-a53a-0c55f6b7881f">
<input checked="checked" id="6896246a-e7c8-4f5a-94ae-07af44695fdd" name="1f3a7bc7-9fd2-470a-a935-cacb5759b23d" type="radio">
</input><label class="tabbed-label" for="6896246a-e7c8-4f5a-94ae-07af44695fdd">
Just download a file</label><div class="tabbed-content docutils">
<p><strong>Who</strong>: Scientists/researchers/developers looking to simply download a
file.</p>
Expand All @@ -506,8 +506,8 @@ <h2>Use cases<a class="headerlink" href="#use-cases" title="Permalink to this he
</ul>
<p><strong>Start here:</strong> <a class="reference internal" href="retrieve.html#retrieve"><span class="std std-ref">Retrieving a single data file</span></a></p>
</div>
<input id="8343b0a2-8629-41b5-b42a-09f20691ce56" name="85c76eb9-8457-4a71-9d49-b3faa0ea973b" type="radio">
</input><label class="tabbed-label" for="8343b0a2-8629-41b5-b42a-09f20691ce56">
<input id="0c2df136-e913-40e3-b081-d39e3d520831" name="1f3a7bc7-9fd2-470a-a935-cacb5759b23d" type="radio">
</input><label class="tabbed-label" for="0c2df136-e913-40e3-b081-d39e3d520831">
Use by another library</label><div class="tabbed-content docutils">
<p><strong>Who</strong>: Package developers wanting to include sample data for use in
tutorials and tests.</p>
Expand Down Expand Up @@ -566,7 +566,7 @@ <h2>History<a class="headerlink" href="#history" title="Permalink to this headli
<p>

&copy; Copyright 2023, The Pooch Developers.<br/>
Last updated on Feb 27, 2023.<br/>
Last updated on Jun 21, 2023.<br/>
</p>
</footer>
</main>
Expand Down
10 changes: 5 additions & 5 deletions dev/api/generated/pooch.DOIDownloader.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@ <h1>pooch.DOIDownloader<a class="headerlink" href="#pooch-doidownloader" title="
the download URL from the DOI and file name. It then uses
<a class="reference internal" href="pooch.HTTPDownloader.html#pooch.HTTPDownloader" title="pooch.HTTPDownloader"><code class="xref py py-class docutils literal notranslate"><span class="pre">pooch.HTTPDownloader</span></code></a> to download the URL into the specified local
file. Allowing “URL”s to be specified with the DOI instead of the actual
HTTP download link. Uses the <a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#module-requests" title="(in Requests v2.28.2)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">requests</span></code></a> library to manage downloads
HTTP download link. Uses the <a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#module-requests" title="(in Requests v2.31.0)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">requests</span></code></a> library to manage downloads
and interact with the APIs.</p>
<p>The <strong>format of the “URL”</strong> is: <code class="docutils literal notranslate"><span class="pre">doi:{DOI}/{file</span> <span class="pre">name}</span></code>.</p>
<p>Notice that there are no <code class="docutils literal notranslate"><span class="pre">//</span></code> like in HTTP/FTP and you must specify a
Expand All @@ -470,7 +470,7 @@ <h1>pooch.DOIDownloader<a class="headerlink" href="#pooch-doidownloader" title="
<ul class="simple">
<li><p><a class="reference external" href="https://www.figshare.com">figshare</a></p></li>
<li><p><a class="reference external" href="https://www.zenodo.org">Zenodo</a></p></li>
<li><p><a class="reference external" href="https://dataverse.org/">DataVerse</a> instances</p></li>
<li><p><a class="reference external" href="https://dataverse.org/">Dataverse</a> instances</p></li>
</ul>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
Expand All @@ -488,7 +488,7 @@ <h1>pooch.DOIDownloader<a class="headerlink" href="#pooch-doidownloader" title="
<li><p><strong>chunk_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – Files are streamed <em>chunk_size</em> bytes at a time instead of loading
everything into memory at one. Usually doesn’t need to be changed.</p></li>
<li><p><strong>**kwargs</strong> – All keyword arguments given when creating an instance of this class
will be passed to <a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#requests.get" title="(in Requests v2.28.2)"><code class="xref py py-func docutils literal notranslate"><span class="pre">requests.get</span></code></a>.</p></li>
will be passed to <a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#requests.get" title="(in Requests v2.31.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">requests.get</span></code></a>.</p></li>
</ul>
</dd>
</dl>
Expand Down Expand Up @@ -542,7 +542,7 @@ <h1>pooch.DOIDownloader<a class="headerlink" href="#pooch-doidownloader" title="
<dd><p>Download the given DOI URL over HTTP to the given output file.</p>
<p>Uses the repository’s API to determine the actual HTTP download URL
from the given DOI.</p>
<p>Uses <a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#requests.get" title="(in Requests v2.28.2)"><code class="xref py py-func docutils literal notranslate"><span class="pre">requests.get</span></code></a>.</p>
<p>Uses <a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#requests.get" title="(in Requests v2.31.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">requests.get</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Expand Down Expand Up @@ -584,7 +584,7 @@ <h1>pooch.DOIDownloader<a class="headerlink" href="#pooch-doidownloader" title="
<p>

&copy; Copyright 2023, The Pooch Developers.<br/>
Last updated on Feb 27, 2023.<br/>
Last updated on Jun 21, 2023.<br/>
</p>
</footer>
</main>
Expand Down
2 changes: 1 addition & 1 deletion dev/api/generated/pooch.Decompress.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@ <h1>pooch.Decompress<a class="headerlink" href="#pooch-decompress" title="Permal
<p>

&copy; Copyright 2023, The Pooch Developers.<br/>
Last updated on Feb 27, 2023.<br/>
Last updated on Jun 21, 2023.<br/>
</p>
</footer>
</main>
Expand Down
2 changes: 1 addition & 1 deletion dev/api/generated/pooch.FTPDownloader.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -544,7 +544,7 @@ <h1>pooch.FTPDownloader<a class="headerlink" href="#pooch-ftpdownloader" title="
<p>

&copy; Copyright 2023, The Pooch Developers.<br/>
Last updated on Feb 27, 2023.<br/>
Last updated on Jun 21, 2023.<br/>
</p>
</footer>
</main>
Expand Down
12 changes: 6 additions & 6 deletions dev/api/generated/pooch.HTTPDownloader.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ <h1>pooch.HTTPDownloader<a class="headerlink" href="#pooch-httpdownloader" title
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pooch.</span></span><span class="sig-name descname"><span class="pre">HTTPDownloader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">progressbar</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chunk_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1024</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pooch/downloaders.html#HTTPDownloader"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pooch.HTTPDownloader" title="Permalink to this definition"></a></dt>
<dd><p>Download manager for fetching files over HTTP/HTTPS.</p>
<p>When called, downloads the given file URL into the specified local file.
Uses the <a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#module-requests" title="(in Requests v2.28.2)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">requests</span></code></a> library to manage downloads.</p>
Uses the <a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#module-requests" title="(in Requests v2.31.0)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">requests</span></code></a> library to manage downloads.</p>
<p>Use with <a class="reference internal" href="pooch.Pooch.html#pooch.Pooch.fetch" title="pooch.Pooch.fetch"><code class="xref py py-meth docutils literal notranslate"><span class="pre">pooch.Pooch.fetch</span></code></a> or <a class="reference internal" href="pooch.retrieve.html#pooch.retrieve" title="pooch.retrieve"><code class="xref py py-func docutils literal notranslate"><span class="pre">pooch.retrieve</span></code></a> to customize
the download of files (for example, to use authentication or print a
progress bar).</p>
Expand All @@ -467,7 +467,7 @@ <h1>pooch.HTTPDownloader<a class="headerlink" href="#pooch-httpdownloader" title
<li><p><strong>chunk_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><em>int</em></a>) – Files are streamed <em>chunk_size</em> bytes at a time instead of loading
everything into memory at one. Usually doesn’t need to be changed.</p></li>
<li><p><strong>**kwargs</strong> – All keyword arguments given when creating an instance of this class
will be passed to <a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#requests.get" title="(in Requests v2.28.2)"><code class="xref py py-func docutils literal notranslate"><span class="pre">requests.get</span></code></a>.</p></li>
will be passed to <a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#requests.get" title="(in Requests v2.31.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">requests.get</span></code></a>.</p></li>
</ul>
</dd>
</dl>
Expand All @@ -490,8 +490,8 @@ <h1>pooch.HTTPDownloader<a class="headerlink" href="#pooch-httpdownloader" title
</pre></div>
</div>
<p>Authentication can be handled by passing a user name and password to
<a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#requests.get" title="(in Requests v2.28.2)"><code class="xref py py-func docutils literal notranslate"><span class="pre">requests.get</span></code></a>. All arguments provided when creating an instance of
the class are forwarded to <a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#requests.get" title="(in Requests v2.28.2)"><code class="xref py py-func docutils literal notranslate"><span class="pre">requests.get</span></code></a>. We’ll use
<a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#requests.get" title="(in Requests v2.31.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">requests.get</span></code></a>. All arguments provided when creating an instance of
the class are forwarded to <a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#requests.get" title="(in Requests v2.31.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">requests.get</span></code></a>. We’ll use
<code class="docutils literal notranslate"><span class="pre">auth=(username,</span> <span class="pre">password)</span></code> to use basic HTTPS authentication. The
<a class="reference external" href="https://httpbin.org">https://httpbin.org</a> website allows us to make a fake a login request using
whatever username and password we provide to it:</p>
Expand Down Expand Up @@ -538,7 +538,7 @@ <h1>pooch.HTTPDownloader<a class="headerlink" href="#pooch-httpdownloader" title
<dt class="sig sig-object py" id="pooch.HTTPDownloader.__call__">
<span class="sig-prename descclassname"><span class="pre">HTTPDownloader.</span></span><span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pooch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pooch/downloaders.html#HTTPDownloader.__call__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pooch.HTTPDownloader.__call__" title="Permalink to this definition"></a></dt>
<dd><p>Download the given URL over HTTP to the given output file.</p>
<p>Uses <a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#requests.get" title="(in Requests v2.28.2)"><code class="xref py py-func docutils literal notranslate"><span class="pre">requests.get</span></code></a>.</p>
<p>Uses <a class="reference external" href="https://requests.readthedocs.io/en/latest/api/#requests.get" title="(in Requests v2.31.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">requests.get</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Expand Down Expand Up @@ -587,7 +587,7 @@ <h1>pooch.HTTPDownloader<a class="headerlink" href="#pooch-httpdownloader" title
<p>

&copy; Copyright 2023, The Pooch Developers.<br/>
Last updated on Feb 27, 2023.<br/>
Last updated on Jun 21, 2023.<br/>
</p>
</footer>
</main>
Expand Down
2 changes: 1 addition & 1 deletion dev/api/generated/pooch.Pooch.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -653,7 +653,7 @@ <h1>pooch.Pooch<a class="headerlink" href="#pooch-pooch" title="Permalink to thi
<p>

&copy; Copyright 2023, The Pooch Developers.<br/>
Last updated on Feb 27, 2023.<br/>
Last updated on Jun 21, 2023.<br/>
</p>
</footer>
</main>
Expand Down
2 changes: 1 addition & 1 deletion dev/api/generated/pooch.SFTPDownloader.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@ <h1>pooch.SFTPDownloader<a class="headerlink" href="#pooch-sftpdownloader" title
<p>

&copy; Copyright 2023, The Pooch Developers.<br/>
Last updated on Feb 27, 2023.<br/>
Last updated on Jun 21, 2023.<br/>
</p>
</footer>
</main>
Expand Down
2 changes: 1 addition & 1 deletion dev/api/generated/pooch.Untar.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@ <h1>pooch.Untar<a class="headerlink" href="#pooch-untar" title="Permalink to thi
<p>

&copy; Copyright 2023, The Pooch Developers.<br/>
Last updated on Feb 27, 2023.<br/>
Last updated on Jun 21, 2023.<br/>
</p>
</footer>
</main>
Expand Down
Loading

0 comments on commit ef70525

Please sign in to comment.