Environment Variables

The following displays information about the environment variables that affect xonsh performance in some way. It also lists their default values, if applicable.

$ACTIVITIES

$DAG

$DOCKERFILE

$DOCKERFILE_CONTEXT

$DOCKERFILE_TAGS

$DOCKER_APT_DEPS

$DOCKER_BASE_FILE

$DOCKER_BASE_FROM

$DOCKER_BASE_IMAGE

$DOCKER_CONDA_CHANNELS

$DOCKER_CONDA_DEPS

$DOCKER_GIT_EMAIL

$DOCKER_GIT_NAME

$DOCKER_HOME

$DOCKER_INSTALL_COMMAND

$DOCKER_INSTALL_ENVVARS

$DOCKER_INSTALL_FILE

$DOCKER_INSTALL_IMAGE

$DOCKER_INSTALL_SOURCE

$DOCKER_INSTALL_URL

$DOCKER_PIP_DEPS

$DOCKER_PIP_REQUIREMENTS

$DOCKER_ROOT

$DOCKER_WORKDIR

$GCLOUD_CLUSTER

$GCLOUD_CONTAINER_NAME

$GCLOUD_DOCKER_HOST

$GCLOUD_DOCKER_ORG

$GCLOUD_DOCKER_REPO

$GCLOUD_PROJECT_ID

$GCLOUD_ZONE

$GITHUB_CREDFILE

$GITHUB_ORG

$GITHUB_REPO

$LOGGER

$PROJECT

$PYTHON

$RELEASE_DATE

$REVER_CONFIG_DIR

$REVER_DIR

$REVER_FORCED

$REVER_QUIET

$REVER_USER

$REVER_VCS

$RUNNING_ACTIVITIES

$VERSION

$WEBSITE_URL

Listing

$ACTIVITIES

Default list of activity names for rever to execute, if they have not already been executed.

configurable: True

default: []

store_as_str: False


$DAG

Directed acyclic graph of activities as represented by a dict with str keys and Activity objects as values.

configurable: True

default: {‘authors’: <rever.activities.authors.Authors object at 0x7f8d032285d0>,

‘bibtex’: <rever.activities.bibtex.BibTex object at 0x7f8d0310f350>, ‘changelog’: <rever.activities.changelog.Changelog object at 0x7f8d03121610>, ‘conda_forge’: <rever.activities.conda_forge.CondaForge object at 0x7f8d031d4ed0>, ‘deploy_to_gcloud’: <rever.activities.gcloud.DeploytoGCloud object at 0x7f8d03131610>, ‘deploy_to_gcloud_app’: <rever.activities.gcloud.DeploytoGCloudApp object at 0x7f8d031bb250>, ‘docker_build’: <rever.activities.docker.DockerBuild object at 0x7f8d03b97450>, ‘docker_push’: <rever.activities.docker.DockerPush object at 0x7f8d032673d0>, ‘ghpages’: <rever.activities.ghpages.GHPages object at 0x7f8d03216b50>, ‘ghrelease’: <rever.activities.ghrelease.GHRelease object at 0x7f8d03216910>, ‘nose’: <rever.activities.nose.Nose object at 0x7f8d0321e750>, ‘push_tag’: <rever.activities.push_tag.PushTag object at 0x7f8d0323c850>, ‘pypi’: <rever.activities.pypi.PyPI object at 0x7f8d03257a10>, ‘pytest’: <rever.activities.pytest.PyTest object at 0x7f8d03bb1b50>, ‘sphinx’: <rever.activities.sphinx.Sphinx object at 0x7f8d03213a10>, ‘tag’: <rever.activities.tag.Tag object at 0x7f8d03213910>, ‘version_bump’: <rever.activities.version_bump.VersionBump object at 0x7f8d0324c990>}

store_as_str: False


$DOCKERFILE

Path to Dockerfile, default is empty string.

configurable: True

default: ‘’

store_as_str: False


$DOCKERFILE_CONTEXT

Context (ie the directory) that the $DOCKERFILE should be built in. The default (an empty string) indicates that the image should be built in directory containing the $DOCKERFILE.

configurable: True

default: ‘’

store_as_str: False


$DOCKERFILE_TAGS

Tag that the $DOCKERFILE should be built and pushed with. The default is ["$REVER_USER/$PROJECT:$VERSION", "$REVER_USER/$PROJECT:latest"].

configurable: True

default: (‘$REVER_USER/$PROJECT:$VERSION’, ‘$REVER_USER/$PROJECT:latest’)

store_as_str: False


$DOCKER_APT_DEPS

Dependencies to install in the base container via apt-get.

configurable: True

default: []

store_as_str: False


$DOCKER_BASE_FILE

Path to base dockerfile, default $REVER_DIR/rever-base.dockerfile

configurable: True

default: ‘$REVER_DIR/rever-base.dockerfile’

store_as_str: False


$DOCKER_BASE_FROM

Image to include in the base rever image.

configurable: True

default: ‘debian:latest’

store_as_str: False


$DOCKER_BASE_IMAGE

Image name for the base docker image. This is evaluated in the current environment, default $PROJECT/rever-base

configurable: True

default: ‘$PROJECT/rever-base’

store_as_str: False


$DOCKER_CONDA_CHANNELS

Conda channels to use, in order of decreasing precedence. Defaults to conda-forge

configurable: True

default: (‘conda-forge’,)

store_as_str: False


$DOCKER_CONDA_DEPS

Dependencies to install in the base container via conda.

configurable: True

default: []

store_as_str: False


$DOCKER_GIT_EMAIL

Email to configure for git in the docker container

configurable: True

default: ‘’

store_as_str: False


$DOCKER_GIT_NAME

Username to configure for git in the docker container

configurable: True

default: ‘’

store_as_str: False


$DOCKER_HOME

Home directory in the docker container, default /root

configurable: True

default: ‘/root’

store_as_str: False


$DOCKER_INSTALL_COMMAND

Command for installing the project that is used in docker.

configurable: True

default: ‘’

store_as_str: False


$DOCKER_INSTALL_ENVVARS

Environment variables to set at the end of the docker install. May be either a Python dictionary mapping string variable names to string values or None, default None.

configurable: True

default: None

store_as_str: False


$DOCKER_INSTALL_FILE

Path to base dockerfile, odefault $REVER_DIR/rever-install.dockerfile

configurable: True

default: ‘$REVER_DIR/rever-install.dockerfile’

store_as_str: False


$DOCKER_INSTALL_IMAGE

Image name for the install docker image. This is evaluated in the current environment, default $PROJECT/rever-install

configurable: True

default: ‘$PROJECT/rever-install’

store_as_str: False


$DOCKER_INSTALL_SOURCE

Command for obtaining the source code in the install container.This command shoudl create the $DOCKER_WORKDIR.

configurable: True

default: ‘’

store_as_str: False


$DOCKER_INSTALL_URL

URL to clone to in docker in the install image.

configurable: True

default: ‘’

store_as_str: False


$DOCKER_PIP_DEPS

Dependencies to install in the base container via pip.

configurable: True

default: []

store_as_str: False


$DOCKER_PIP_REQUIREMENTS

Requirements files to use in pip install.

configurable: True

default: []

store_as_str: False


$DOCKER_ROOT

Root directory for docker to use.

configurable: True

default: ‘’

store_as_str: False


$DOCKER_WORKDIR

The working directory for the docker container. This is evaluated in the container itself, default $HOME/$PROJECT

configurable: True

default: ‘$HOME/$PROJECT’

store_as_str: False


$GCLOUD_CLUSTER

The kubernetes cluster to deploy to

configurable: True

default: ‘’

store_as_str: False


$GCLOUD_CONTAINER_NAME

The name of the container image to deploy to

configurable: True

default: ‘’

store_as_str: False


$GCLOUD_DOCKER_HOST

The name of the docker host to pull the container from

configurable: True

default: ‘docker.io’

store_as_str: False


$GCLOUD_DOCKER_ORG

The name of the docker org to pull the container from

configurable: True

default: ‘’

store_as_str: False


$GCLOUD_DOCKER_REPO

The name of the docker container repo to use

configurable: True

default: ‘’

store_as_str: False


$GCLOUD_PROJECT_ID

The ID for the gcloud project

configurable: True

default: ‘’

store_as_str: False


$GCLOUD_ZONE

The gcloud zone

configurable: True

default: ‘us-central1-a’

store_as_str: False


$GITHUB_CREDFILE

GitHub credential file to use

configurable: True

default: ‘’

store_as_str: False


$GITHUB_ORG

GitHub organization name

configurable: True

default: ‘’

store_as_str: False


$GITHUB_REPO

GitHub repository name

configurable: True

default: ‘’

store_as_str: False


$LOGGER

Rever logger object. Setting this variable to a string will change the filename of the logger.

configurable: True

default: <rever.logger.Logger object at 0x7f8d03bb3d50>

store_as_str: False


$PROJECT

Project name

configurable: True

default: ‘’

store_as_str: False


$PYTHON

Path to Python executable that rever is run with or “python”.

configurable: True

default: ‘/home/travis/miniconda/bin/python3.7’

store_as_str: False


$RELEASE_DATE

The date of the release, defaults to today, string representations have “YYYY-MM-DD” format.

configurable: True

default: datetime.date(2020, 1, 5)

store_as_str: False


$REVER_CONFIG_DIR

Path to rever configuration directory

configurable: True

default: ‘/home/travis/.config/rever’

store_as_str: False


$REVER_DIR

Path to directory used for storing rever temporary files.

configurable: True

default: ‘rever’

store_as_str: False


$REVER_FORCED

Path to directory used for storing rever temporary files.

configurable: True

default: False

store_as_str: False


$REVER_QUIET

If True do not write progress during hashing

configurable: True

default: False

store_as_str: False


$REVER_USER

Name of the user who ran the rever command.

configurable: True

default: ‘travis’

store_as_str: False


$REVER_VCS

Version control system used by rever. May be ‘None’ to not use version control.

configurable: True

default: ‘git’

store_as_str: False


$RUNNING_ACTIVITIES

List of activity names that rever is actually executing.

configurable: True

default: []

store_as_str: False


$VERSION

Version string of new version that is being released.

configurable: True

default: ‘x.y.z’

store_as_str: False


$WEBSITE_URL

Project URL, usually for docs.

configurable: True

default: ‘’

store_as_str: False