Skip to main content

Download remote data (HTTP, FTP, SFTP) and store locally for data pipeline

Project description

fetch-data

Build Status codecov License:MITpypi

[![Documentation Status](https://readthedocs.org/projects/fetch-data/badge/?version=latest)](https://fetch-data.readthedocs.io/en/latest/?badge=latest)

Download remote data (HTTP, FTP, SFTP) and store locally for data pipeline.

This package was created out of the frustration that it is very difficult to download data easily with intake. fetch-data is a mash-up of fsspec and pooch making it easy to download multiple files and store all the info, making it good for data pipeline applications.

Installation

Currently, this package is pip install git+https://github.com/lukegre/fetch-data.git

Basic usage

Use the download function directly:

flist = fd.download(url)

The file will be downloaded to the current directory and will be populated with a readme file, cached file list, and logging information.

Using with YAML catalogs

Use the catalog YAML entry

cat = df.read_catalog(cat_fname)
flist = fd.download(**cat['entry_name'])

The catalog should be structured as shown below:

entry_name:
    url: remote path to file/s. Can contain *
    dest: where the file/s will be stored - can have optional {} placeholders that will be replaced
    meta:  # this will be written to the README file
        doi: url to the data source
        description: info about the data
        citation: how to cite this dataset
    placeholder: value  # optional will replace values in dest

Project based on the cookiecutter science project template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fetch_data-0.1.tar.gz (21.4 kB view details)

Uploaded Source

Built Distribution

fetch_data-0.1-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file fetch_data-0.1.tar.gz.

File metadata

  • Download URL: fetch_data-0.1.tar.gz
  • Upload date:
  • Size: 21.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for fetch_data-0.1.tar.gz
Algorithm Hash digest
SHA256 c7c531e382f20a2e5e30279bab65b764effa311fc3f80f9886e211f0327ef082
MD5 9acdff6c62e61b52f1c1fb86a91a1192
BLAKE2b-256 97cf09268dd7b746abce5468711fb76be4339ce916d85d4bb19582e588f5c73d

See more details on using hashes here.

File details

Details for the file fetch_data-0.1-py3-none-any.whl.

File metadata

  • Download URL: fetch_data-0.1-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for fetch_data-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f8000445a0429c6a05e94e17ec27ba78fbcf3857b3f84d7228dbee49103ef39f
MD5 41159bcdeb2cf3293e25e6bac00021c9
BLAKE2b-256 ff0ce78c83d28cc748da328e270f0ec3de490d5ad382d9a6d12811a1313a1810

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page