logo

Pooch v1.7.0

  • Pooch Documentation

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)
    • pooch.create
    • pooch.Pooch
    • pooch.retrieve
    • pooch.os_cache
    • pooch.make_registry
    • pooch.file_hash
    • pooch.check_version
    • pooch.get_logger
    • pooch.HTTPDownloader
    • pooch.FTPDownloader
    • pooch.SFTPDownloader
    • pooch.DOIDownloader
    • pooch.Unzip
    • pooch.Untar
    • pooch.Decompress
    • pooch.test
  • Version compatibility
  • 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
Theme by the Executable Book Project

Index

_ | C | D | F | G | H | I | L | M | O | P | R | S | T | U

_

  • __call__() (pooch.Decompress method)
    • (pooch.DOIDownloader method)
    • (pooch.FTPDownloader method)
    • (pooch.HTTPDownloader method)
    • (pooch.SFTPDownloader method)
    • (pooch.Untar method)
    • (pooch.Unzip method)

C

  • check_version() (in module pooch)
  • create() (in module pooch)

D

  • Decompress (class in pooch)
  • DOIDownloader (class in pooch)

F

  • fetch() (pooch.Pooch method)
  • file_hash() (in module pooch)
  • FTPDownloader (class in pooch)

G

  • get_logger() (in module pooch)
  • get_url() (pooch.Pooch method)

H

  • HTTPDownloader (class in pooch)

I

  • is_available() (pooch.Pooch method)

L

  • load_registry() (pooch.Pooch method)
  • load_registry_from_doi() (pooch.Pooch method)

M

  • make_registry() (in module pooch)
  • module
    • pooch

O

  • os_cache() (in module pooch)

P

  • pooch
    • module
  • Pooch (class in pooch)

R

  • retrieve() (in module pooch)

S

  • SFTPDownloader (class in pooch)

T

  • test() (in module pooch)

U

  • Untar (class in pooch)
  • Unzip (class in pooch)

© Copyright 2023, The Pooch Developers.
Last updated on Feb 27, 2023.