.. title:: Home
========
|banner|
========
.. |banner| image:: _static/readme-banner.png
:alt: Pooch Documentation
:align: middle
.. raw:: html
Just want to download a file without messing with
requests
and urllib
?
Trying to add sample datasets to your Python package?
Pooch is here to help!
.. panels::
:header: text-center text-large
:card: border-1 m-1 text-center
**Getting started**
^^^^^^^^^^^^^^^^^^^
New to Pooch?
.. link-button:: about
:type: ref
:text: Start here
:classes: btn-outline-primary btn-block stretched-link
---
**Need help?**
^^^^^^^^^^^^^^
Ask on our community channels
.. link-button:: https://www.fatiando.org/contact
:type: url
:text: Join the conversation
:classes: btn-outline-primary btn-block stretched-link
---
**Reference documentation**
^^^^^^^^^^^^^^^^^^^^^^^^^^^
A list of our functions and classes
.. link-button:: api
:type: ref
:text: API reference
:classes: btn-outline-primary btn-block stretched-link
---
**Using Pooch for research?**
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Citations help support our work
.. link-button:: citing
:type: ref
:text: Cite Pooch
:classes: btn-outline-primary btn-block stretched-link
.. seealso::
Pooch is a part of the
`Fatiando a Terra `_ project.
Table of contents
-----------------
.. toctree::
:caption: Getting Started
:maxdepth: 1
about.rst
install.rst
retrieve.rst
multiple-files.rst
sample-data.rst
.. toctree::
:caption: Training your Pooch
:maxdepth: 1
hashes.rst
user-defined-cache.rst
registry-files.rst
multiple-urls.rst
protocols.rst
logging.rst
downloaders.rst
processors.rst
authentication.rst
progressbars.rst
unpacking.rst
decompressing.rst
.. toctree::
:caption: Reference
:maxdepth: 1
api/index.rst
compatibility.rst
citing.rst
changes.rst
versions.rst
.. toctree::
:caption: Community
Join the community
Code of Conduct
How to contribute
Source code on GitHub
Authors
Fatiando a Terra