Authentication

To run Toolchest jobs, you'll need a Toolchest key. If you don't have one yet, you can get a key here.

Setting a Key

The set_key function allows you to set your key, as follows:

import toolchest_client as toolchest
toolchest.set_key("YOUR_TOOLCHEST_KEY")
library(toolchest)
toolchest$set_key("YOUR_TOOLCHEST_KEY")

YOUR_TOOLCHEST_KEY should be a string containing either the key value or a path to a file containing the key.

If you'd prefer to skip the set_key function call, you can also set your key through the TOOLCHEST_KEY environment variable.

Getting a Stored Key

To check the value of the key in use, use the get_key function, which returns a string containing your key value.

import toolchest_client as toolchest
toolchest.get_key()
library(toolchest)
toolchest$get_key()

Private Tools and Databases

All tools and databases currently listed in the docs are accessible to every Toolchest key.

If you'd like to use a private database with Toolchest without exposing it to the general public, Toolchest supports restricting your database to your Toolchest key(s).


Did this page help you?