.. title:: Home

========
|banner|
========

.. |banner| image:: _static/readme-banner.png
    :alt: Pooch Documentation
    :align: middle

.. raw:: html

    <p class="lead centered front-page-callout">
        Just want to download a file without messing with
        <code>requests</code> and <code>urllib</code>?
        <br>
        Trying to add sample datasets to your Python package?
        <br>
        <strong>Pooch is here to help!</strong>
    </p>


.. 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 <https://www.fatiando.org/>`_ 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 <https://www.fatiando.org/contact/>
    Code of Conduct <https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md>
    How to contribute <https://github.com/fatiando/pooch/blob/main/CONTRIBUTING.md>
    Source code on GitHub <https://github.com/fatiando/pooch>
    Authors <https://github.com/fatiando/pooch/blob/main/AUTHORS.md>
    Fatiando a Terra <https://www.fatiando.org>
