Skip to main content

Compares expected environment variables to those set in production.

Project description

Unix: Unix Build Status Windows: Windows Build StatusMetrics: Coverage Status Scrutinizer Code QualityUsage: PyPI Version

Overview

diff-env is a command-line to tool to generate reports to compare the value of environment variables in each of your environments against the defaults defined in various files. It will help you you find:

  • variables absent from production, but will be required for a new feature in test
  • production values that shouldn’t be shared to your staging environment
  • variables set that are no longer referenced in any files

This tool was built with Heroku, but should work with any infrastructure that supports running commands remotely.

Setup

Requirements

  • Python 3.6+

Installation

Install env-diff with pip:

$ pip install env-diff

or directly from the source code:

$ git clone https://github.com/jacebrowning/env-diff.git
$ cd env-diff
$ python setup.py install

Usage

Generate a sample config file:

$ env-diff --init

Customize this file to match your project:

  • sourcefiles: contain references to environment variables used in your project
    • path: relative path to source file
  • environments: the environments in which your project runs
    • name: name of the environment
    • command: command to display currently set environment variables

Generate reports to show the differences between each environment variable:

$ env-diff

Demo

Input YAML config file:

input

Running in a terminal:

run

Output (as viewed in TableTool):

output

Revision History

0.4 (2017-04-03)

  • Added extra context around variable use in Heroku app.json files.

0.3 (2017-03-30)

  • Added CSV report generation.

0.2 (2017-03-30)

  • Added detection of source variables matching export FOO=bar.
  • Added Markdown report generation.

0.1 (2017-03-30)

  • Initial alpha release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
env_diff-0.4-py3-none-any.whl (13.9 kB) Copy SHA256 hash SHA256 Wheel py3
env-diff-0.4.tar.gz (36.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page