.rst .pdf

repository open issue suggest edit

Contents

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!

Getting started

New to Pooch?

Start here

Need help?

Ask on our chat room

Join our Slack

Reference documentation

A list of our functions and classes

API reference

Using Pooch for research?

Citations help support our work

Cite Pooch

See also

Pooch is a part of the Fatiando a Terra project.

Table of contents

Getting Started

• Why use Pooch?
• Installing
• Retrieving a single data file
• Fetching files from a registry
• Manage a package’s sample data

Training your Pooch

• Hashes: Calculating and bypassing
• User-defined cache location
• Registry files
• Multiple download URLs
• Download protocols
• Logging and verbosity
• Downloaders: Customizing the download
• Processors: Post-download actions
• Authentication
• Printing progress bars
• Unpacking archives
• Decompressing

Reference

• List of functions and classes (API)
• Compatibility notes
• Citing Pooch
• Changelog
• Documentation for other versions

Community

• Join the community
• Code of Conduct
• How to contribute
• Source code on GitHub
• Authors
• Fatiando a Terra

Why use Pooch?