Unix: Windows: Metrics: Usage:

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.

Metadata

Release files for env-diff 0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for env-diff 0.4
File	Size	Uploaded
env-diff-0.4.tar.gz	36.9 kB	Apr 3, 2017	Details

Built distribution (wheel)

Table of built distributions (wheels) for env-diff 0.4
File	Interpreter	ABI	Platform	Reset
env_diff-0.4-py3-none-any.whl 13.9 kB Apr 3, 2017	Python 3	none	any	Details

Total release size: 50.8 kB

Release files / env-diff-0.4.tar.gz

Download URL	env-diff-0.4.tar.gz
Size	36.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`cdc6fea2a2446a966a283dcf30e29a9598ed41873e8445385d024176915ae2eb`
BLAKE2b-256 checksum How to use checksums	`ec8ca858747ca035eee85f64db61a78aba4cd5c77a7e5c1ff53106dd5e2488bf`
Upload date	Apr 3, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / env_diff-0.4-py3-none-any.whl

Download URL	env_diff-0.4-py3-none-any.whl
Size	13.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`33bb8e8df5ebd113835b4e9d951ee7eb75ae797a5b9caa3d75239337e440343c`
BLAKE2b-256 checksum How to use checksums	`4397e1006d952117b848db246da2268034ae82313045c356faa427f785f9a7f9`
Upload date	Apr 3, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No