Environments & Variables
Environment allows you to set environment variables and docker image to use when running apps.
Info
Please see the Environment API Reference for more details. You can also create Environments directly from the Web interface.
Overview
Apps often contain variables such as database keys and passwords, which you do not want embedding in your source code and visible to the outside world.
In addition, you'll often want to include custom dependencies and packages outside those in our default Docker image.
Datapane lets you specify your variables and Docker images through Environments.
Creating an environment
You can create a new environment from Python, the CLI or the web interface. Adding multiple versions of environments with the same name will create new versions.
Parameters
Parameter | Description | Required |
---|---|---|
name |
The name of your environment | True |
environment |
A dictionary of key:value pairs for your variables | True |
docker-image |
Your image name on DockerHub | False |
project |
Project this environment is part of (default is home ) |
False |
Loading an environment
To tell your app which environment and Docker image to use, specify the environment in your datapane.yaml
file.
To access variables inside your Python script, use os.environ.get
as follows:
import datapane as dp
import os
env = dp.Environment.get(name="my-environment", owner = "john")
var = os.environ.get("foo")
Get Parameters
Parameter | Description | Required |
---|---|---|
name |
The name of your environment | True |
project |
The project of the environment. This defaults to the home or shared project if not found in home , so should be set explicitly if you want other people to run the app with an environment you created. |
False |
Warning
If you want other people inside your organisation to run your apps with an environment which you created, you should specify the project
in this method. When someone runs your script, it will try and look for the environment in the default project and may fail.