Installation

You can install this package via conda, simply pointing to our stable or beta channels:

$ conda create -n bdt -c https://www.idiap.ch/software/bob/conda bob.devtools
# or, for beta releases:
$ conda create -n bdt -c https://www.idiap.ch/software/bob/conda/label/beta -c https://www.idiap.ch/software/bob/conda bob.devtools

If you use one of our supported Python versions on your base environment, you may also install bdt on it:

$ conda install -n base -c https://www.idiap.ch/software/bob/conda bob.devtools
# or, for beta releases:
$ conda install -n base -c https://www.idiap.ch/software/bob/conda/label/beta -c https://www.idiap.ch/software/bob/conda bob.devtools

We provide packages for both 64-bit Linux and MacOS, for Python 3.6+. Once installed, you can use these tools within the created environment like this:

$ conda activate base  #or bdt, depending where you installed it
(bdt) $ bdt --help

Setup

Some of the commands in the bdt command-line application require access to your gitlab private token, which you can pass at every iteration, or setup at your ~/.python-gitlab.cfg. Please note that in case you don’t set it up, it will request for your API token on-the-fly, what can be cumbersome and repeatitive. Your ~/.python-gitlab.cfg should roughly look like this (there must be an “idiap” section on it, at least):

[global]
default = idiap
ssl_verify = true
timeout = 15

[idiap]
url = https://gitlab.idiap.ch
private_token = <obtain token at your settings page in gitlab>
api_version = 4

We recommend you set chmod 600 to this file to avoid prying eyes to read out your personal token. Once you have your token set up, communication should work transparently between the built-in gitlab client and the server.

If you would like to use the WebDAV interface to our web service for manually uploading contents, you may also setup the address, username and password for that server inside the file ~/.bdtrc. Here is a skeleton:

[webdav]
server = http://example.com
username = username
password = password

You may obtain these parameters from our internal page explaining the WebDAV configuration. You shoul also set chmod 600 to this file for obvious security reasons.