Skip to main content

A utility tool to create .env files

Project description

# A utility tool to create .env files

[![Build Status](https://travis-ci.org/sobolevn/dump-env.svg?branch=master)](https://travis-ci.org/sobolevn/dump-env) [![Coverage](https://coveralls.io/repos/github/sobolevn/dump-env/badge.svg?branch=master)](https://coveralls.io/github/sobolevn/dump-env?branch=master) [![Python Version](https://img.shields.io/pypi/pyversions/dump-env.svg)](https://https://pypi-hypernode.com/project/dump-env/) [![Docs](https://readthedocs.org/projects/dump-env/badge/?version=latest)](http://dump-env.readthedocs.io/en/latest/?badge=latest)

dump-env takes an .env.template file and some optional environmental variables to create a new .env file from these two sources. No external dependencies are used.

## Why?

Why do we need such a tool? Well, this tool is very helpful when your CI is building docker (or other) images. [Previously](https://github.com/wemake-services/wemake-django-template/blob/6a7ab060e8435fd855cd806706c5d1b5a9e76d12/%7B%7Bcookiecutter.project_name%7D%7D/.gitlab-ci.yml#L25) we had some complex logic of encrypting and decrypting files, importing secret keys and so on. Now we can just create secret variables for our CI, add some prefix to it, and use dump-env to make our life easier.

## Quickstart

This quick demo will demonstrate the main and the only purpose of dump-env:

`bash $ dump-env --template=.env.template --prefix='SECRET_ENV_' > .env `

This command will:

  1. take .env.template

  2. parse its keys and values

  3. read and all the variables from the environment starting with SECRET_ENV_

  4. remove this prefix

  5. mix it all together, where environment variables could override ones with the same name from the template

  6. sort keys in alphabetic order

  7. dump all the keys and values into the .env file

## Installation

`bash $ pip install dump-env `

## Creating secret variables in some CIs

Project details


Download files

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

Source Distribution

dump-env-0.2.0.tar.gz (4.8 kB view details)

Uploaded Source

Built Distributions

dump_env-0.2.0-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

dump_env-0.2.0-py2-none-any.whl (4.0 kB view details)

Uploaded Python 2

File details

Details for the file dump-env-0.2.0.tar.gz.

File metadata

  • Download URL: dump-env-0.2.0.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for dump-env-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0c6dd783d453ed3444abd21f818a1289b5638f223127277c70d5b9e7f6509140
MD5 9387c5287e4dc50fbedaa4a66a6e61ac
BLAKE2b-256 ea271c09fe02dce4c87cbf7a300963fdbbbeb8a866c9b5649fc9a363530d888d

See more details on using hashes here.

File details

Details for the file dump_env-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for dump_env-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dc4e3d689d61c84cbeb064d941c68a8b171ab2b574da2ee16a42f1382024705d
MD5 71fd70be93b0ee424353d6258d3555f4
BLAKE2b-256 22bf23b8f2c7a6550b4c6c8ab6d5393f4151732345e637c3166ae970f6b68a40

See more details on using hashes here.

File details

Details for the file dump_env-0.2.0-py2-none-any.whl.

File metadata

File hashes

Hashes for dump_env-0.2.0-py2-none-any.whl
Algorithm Hash digest
SHA256 df3cc34d29ef8945144b80e07b5d7d288848a693574fa1b78a47f877bf8563b1
MD5 346048aade5e0a6a4a16b7a6c2355266
BLAKE2b-256 fbeb4d2e206ce8aff8b6dabf489811f0bd6cfbb4f4c4ce6e0d913bb2c4182cba

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page