Utility for downloading large datasets from Synapse.
Project description
Synapse Downloader
Utility for downloading large datasets from Synapse.
Dependencies
- Python3.7
- A Synapse account with a username/password. Authentication through a 3rd party (.e.g., Google) will not work, you must have a Synapse user/pass for the API to authenticate.
Install
pip install synapse-downloader
Configuration
Your Synapse credential can be provided on the command line (--username
, --password
) or via environment variables.
SYNAPSE_USERNAME=your-synapse-username
SYNAPSE_PASSWORD=your-synapse-password
Usage
usage: synapse-downloader [-h] [-e [EXCLUDE]] [-u USERNAME] [-p PASSWORD]
[-ll LOG_LEVEL] [-ld LOG_DIR] [-dt DOWNLOAD_TIMEOUT]
[-w] [-wc] [-c] [-ci [COMPARE_IGNORE]]
entity-id download-path
positional arguments:
entity-id The ID of the Synapse entity to download or compare
(Project, Folder or File).
download-path The local path to save the files to or to compare.
optional arguments:
-h, --help show this help message and exit
-e [EXCLUDE], --exclude [EXCLUDE]
Items to exclude from download. Synapse IDs or names
(names are case-sensitive).
-u USERNAME, --username USERNAME
Synapse username.
-p PASSWORD, --password PASSWORD
Synapse password.
-ll LOG_LEVEL, --log-level LOG_LEVEL
Set the logging level.
-ld LOG_DIR, --log-dir LOG_DIR
Set the directory where the log file will be written.
-dt DOWNLOAD_TIMEOUT, --download-timeout DOWNLOAD_TIMEOUT
Set the maximum time (in seconds) a file can download
before it is canceled.
-w, --with-view Use an entity view for loading file info. Fastest for
large projects.
-wc, --with-compare Run the comparison after downloading everything.
-c, --compare Compare a local directory against a remote project or
folder.
-ci [COMPARE_IGNORE], --compare-ignore [COMPARE_IGNORE]
Path to directories or files to ignore when comparing.
Development Setup
pipenv --three
pipenv shell
make pip_install
make build
make install_local
See Makefile for all commands.
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
synapse-downloader-0.0.3.tar.gz
(17.2 kB
view hashes)
Built Distribution
Close
Hashes for synapse_downloader-0.0.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6bffedacd1c643449ec285d4ef3433bc8ee17a3f7d75098532a703aff6a58ac |
|
MD5 | db7b11446b0afd3cbd975d1de35c3f5a |
|
BLAKE2b-256 | db65e242b60b493c3723c3304530407bef68fa38b98fc41163abf833bd2e5a97 |