-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2486dd6
commit 7b1bba0
Showing
234 changed files
with
43,777 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
v1.8.0 | ||
v1.8.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +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: 8f23f83272046b59dd86c0692981ccde | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
.. _about: | ||
|
||
Why use Pooch? | ||
============== | ||
|
||
Use cases | ||
--------- | ||
|
||
.. tab-set:: | ||
|
||
.. tab-item:: Just download a file | ||
|
||
**Who**: Scientists/researchers/developers looking to simply download a | ||
file. | ||
|
||
Pooch makes it easy to download a file (one function call). | ||
On top of that, it also comes with some bonus features: | ||
|
||
* Download and cache your data files locally (so it's only downloaded | ||
once). | ||
* Make sure everyone running the code has the same version of the data | ||
files by verifying cryptographic hashes. | ||
* Multiple download protocols HTTP/FTP/SFTP and basic authentication. | ||
* Download from Digital Object Identifiers (DOIs) issued by repositories | ||
like figshare and Zenodo. | ||
* Built-in utilities to unzip/decompress files upon download | ||
|
||
**Start here:** :ref:`retrieve` | ||
|
||
.. tab-item:: Manage sample data for a Python program | ||
|
||
**Who**: Package developers wanting to include sample data for use in | ||
tutorials and tests. | ||
|
||
Pooch was designed for this! It offers: | ||
|
||
* Pure Python and :ref:`minimal dependencies <dependencies>`. | ||
* Download a file only if necessary. | ||
* Verification of download integrity through cryptographic hashes. | ||
* Extensible design: plug in custom download and post-processing functions. | ||
* Built-in utilities to unzip/decompress files upon download | ||
* Multiple download protocols HTTP/FTP/SFTP and basic authentication. | ||
* User control of data cache location through environment variables. | ||
|
||
**Start here:** :ref:`intermediate` | ||
|
||
History | ||
------- | ||
|
||
Pooch was born out of shared need between the | ||
`Fatiando a Terra <https://www.fatiando.org>`__ libraries and | ||
`MetPy <https://unidata.github.io/MetPy/>`__. | ||
During the | ||
`Scipy Conference 2018 <https://www.youtube.com/playlist?list=PLYx7XA2nY5Gd-tNhm79CNMe_qvi35PgUR>`__ | ||
sprints, developers from both projects got together and, realizing the shared | ||
necessity, devised a package that would combine the best of the existing | ||
functionality already present in each project and extend it's capabilities. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,142 @@ | ||
pooch.DOIDownloader | ||
=================== | ||
|
||
.. currentmodule:: pooch | ||
|
||
.. autoclass:: DOIDownloader | ||
|
||
.. rubric:: Methods Summary | ||
|
||
.. autosummary:: | ||
|
||
|
||
DOIDownloader.__call__ | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
---- | ||
|
||
|
||
|
||
.. automethod:: DOIDownloader.__call__ | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
.. raw:: html | ||
|
||
<div style='clear:both'></div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,154 @@ | ||
pooch.Decompress | ||
================ | ||
|
||
.. currentmodule:: pooch | ||
|
||
.. autoclass:: Decompress | ||
|
||
.. rubric:: Methods Summary | ||
|
||
.. autosummary:: | ||
|
||
|
||
Decompress.__call__ | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
---- | ||
|
||
|
||
|
||
.. automethod:: Decompress.__call__ | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
.. raw:: html | ||
|
||
<div style='clear:both'></div> |
Oops, something went wrong.