Skip to main content

Download all files in a Blackfynn collection via command line or gui

Project description

collectiondbf

PyPI version Maintainability

Collection Downloads from BlackFynn

A python tool for downloading a collection of files from Blackfynn. Can be run from command line or enter input in a UI

Installation

Windows

pip install collectiondbf

Linux

sudo apt-get install python3-tk
pip3 install collectiondbf

MacOS

pip install collectiondbf

*Note that since macOS python does not come with tkinter, only command line usage is supported.

collectiondbf requires python 3.3+ and tkinter to run

Usage

Command Line

Downloading Collections

The commands below will download the desired directory at the command prompts location.

python -m collectiondbf <collection:ID> [api-key] [api-secret] [--recursive]

Add the --recursive option if you wish to download all nested directories under the given location

If you cannot find the collection ID for the folder you wish to download, check for it in the url like so:

collectionID

Alternatively check out this 50s video tutorial on how to find collection ID and API keys in Blackfynn

NOTE You only have to input your keys once! collectiondbf will save them for you for subsequent downloads!

Downloading Datasets

Downloading datasets works exactly the same as downloading collections! Just put the dataset ID in place of the collection ID

python -m collectiondbf <dataset:ID> [api-key] [api-secret] [--recursive]

User Interface

Running python -m collectiondbfwill start the following ui to input keys and collection ID select_channel_2019-09-13 16-24-58 (2)

Using config.py for regular usage

Set environment variables to your Blackfynn keys

BLACKFYNN_API_TOKEN=xxxxx-xxxxx-xxxxx
BLACKFYNN_API_SECRET=xxxxx-xxxxx-xxxxx

or

Edit config.py to your keys:

config.py

import os
API_TOKEN = 'xxxxx-xxxxx-xxxx'
API_SECRET = 'xxxxx-xxxxx-xxxxx'

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

collectiondbf-1.1.7.tar.gz (5.0 kB view details)

Uploaded Source

File details

Details for the file collectiondbf-1.1.7.tar.gz.

File metadata

  • Download URL: collectiondbf-1.1.7.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.3

File hashes

Hashes for collectiondbf-1.1.7.tar.gz
Algorithm Hash digest
SHA256 f406392c8bd774989a13afcca388acf57c3c3d60c72de783f63257bffd0f7316
MD5 f7b09fdf3d39410bfce34fe3343aa172
BLAKE2b-256 50b44724c3e6860a9f4b0ea3ef29f241679fbe9a552ee165658c31d9078041a3

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