trx.fetcher

Attributes

TEST_DATA_REPO
TEST_DATA_TAG
TEST_DATA_API_URL
TEST_DATA_BASE_URL

Functions

get_home()	Set a user-writeable file-system location to put files
get_testing_files_dict()	Get dictionary linking zip file to their GitHub release URL & checksums.
md5sum(filename)	Compute one md5 checksum for a file
sha256sum(filename)	Compute one sha256 checksum for a file
fetch_data(files_dict[, keys])	Downloads files to folder and checks their md5 checksums

Module Contents

trx.fetcher.TEST_DATA_REPO = 'tee-ar-ex/trx-test-data'

trx.fetcher.TEST_DATA_TAG = 'v0.1.0'

trx.fetcher.TEST_DATA_API_URL = 'https://api.github.com/repos/tee-ar-ex/trx-test-data/releases/tags/v0.1.0'

trx.fetcher.TEST_DATA_BASE_URL = 'https://github.com/tee-ar-ex/trx-test-data/releases/download/v0.1.0'

trx.fetcher.get_home()

Set a user-writeable file-system location to put files

trx.fetcher.get_testing_files_dict()

Get dictionary linking zip file to their GitHub release URL & checksums.

Assets are hosted under the v0.1.0 release of tee-ar-ex/trx-test-data. If URLs change, check TEST_DATA_API_URL to discover the latest asset locations.

trx.fetcher.md5sum(filename)

Compute one md5 checksum for a file

trx.fetcher.sha256sum(filename)

Compute one sha256 checksum for a file

trx.fetcher.fetch_data(files_dict, keys=None)

Downloads files to folder and checks their md5 checksums

Parameters:

files_dictdictionary

For each file in files_dict the value should be (url, md5). The file will be downloaded from url, if the file does not already exist or if the file exists but the md5 checksum does not match. Zip files are automatically unzipped and its content* are md5 checked.

Raises:

ValueError

Raises if the md5 checksum of the file does not match the expected value. The downloaded file is not deleted when this error is raised.