Contents

List of functions and classes (API)

Core

create(path, base_url[, version, …])

Create a Pooch with sensible defaults to fetch data files.

Pooch(path, base_url[, registry, urls, …])

Manager for a local data storage that can fetch from a remote source.

retrieve(url, known_hash[, fname, path, …])

Download and cache a single file locally.

Utilities

os_cache(project)

Default cache location based on the operating system.

make_registry(directory, output[, recursive])

Make a registry of files and hashes for the given directory.

file_hash(fname[, alg])

Calculate the hash of a given file.

check_version(version[, fallback])

Check if a version is PEP440 compliant and there are no unreleased changes.

get_logger()

Get the default event logger.

Downloaders

HTTPDownloader([progressbar, chunk_size])

Download manager for fetching files over HTTP/HTTPS.

FTPDownloader([port, username, password, …])

Download manager for fetching files over FTP.

SFTPDownloader([port, username, password, …])

Download manager for fetching files over SFTP.

DOIDownloader([progressbar, chunk_size])

Download manager for fetching files from Digital Object Identifiers (DOIs).

Processors

Unzip([members, extract_dir])

Processor that unpacks a zip archive and returns a list of all files.

Untar([members, extract_dir])

Processor that unpacks a tar archive and returns a list of all files.

Decompress([method, name])

Processor that decompress a file and returns the decompressed version.

Miscellaneous

test([doctest, verbose, coverage])

Run the test suite.
Decompressing pooch.create