Metadata-Version: 1.1
Name: dump-env
Version: 0.2.1
Summary: A utility tool to create .env files
Home-page: https://github.com/sobolevn/dump-env
Author: Nikita Sobolev
Author-email: mail@sobolenv.me
License: MIT
Description: A utility tool to create ``.env`` files
        =======================================
        
        |Build Status| |Coverage| |Python Version| |Docs|
        
        ``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``:
        
        .. code:: 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
        ------------
        
        .. code:: bash
        
            $ pip install dump-env
        
        Creating secret variables in some CIs
        -------------------------------------
        
        -  ``travis``:
           `docs <https://docs.travis-ci.com/user/environment-variables/#Defining-encrypted-variables-in-.travis.yml>`__
        -  ``gitlab-ci``:
           `docs <https://docs.gitlab.com/ce/ci/variables/README.html#secret-variables>`__
        
        .. |Build Status| image:: https://travis-ci.org/sobolevn/dump-env.svg?branch=master
           :target: https://travis-ci.org/sobolevn/dump-env
        .. |Coverage| image:: https://coveralls.io/repos/github/sobolevn/dump-env/badge.svg?branch=master
           :target: https://coveralls.io/github/sobolevn/dump-env?branch=master
        .. |Python Version| image:: https://img.shields.io/pypi/pyversions/dump-env.svg
           :target: https://https://pypi.org/project/dump-env/
        .. |Docs| image:: https://readthedocs.org/projects/dump-env/badge/?version=latest
           :target: http://dump-env.readthedocs.io/en/latest/?badge=latest
        
Keywords: dotenv,.env,tempaltes,secrets,CI/CD
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
