Metadata-Version: 1.1
Name: e2j2
Version: 0.2.0
Summary: e2j2 is a commandline utility to render text/configuration files from jinja2 templates from shell environment variables
Home-page: http://github.com/provonet/e2j2
Author: Johan Bakker
Author-email: johan.bakker@gmail.com
License: MIT
Description: e2j2 [|Build Status| |Coverage Status|]
        =======================================
        
        What is e2j2?
        -------------
        
        e2j2 (environment to jinja2 variables) is a commandline tool which will
        render jinja2 templates to textfiles. all environment variables can be
        used in the jinja2 templates, within the environment variables you can
        use special tags which give you the option to insert json, json file
        paths, base64 hashes, consul kv keys.
        
        e2j2 can be used within docker containers, or for other simple configuration templating tasks. Within a docker container you can simply add the j2 extention to a configuration file, or to multiple files within one or more folder structures and then run e2j2 as part of your docker entrypoint script.
        
        Example:
        --------
        
        lets assume we want to render the following server block in nginx, if we
        place the server configuration in a nginx include directory for example
        /etc/nginx/conf.d
        
        .. code:: bash
        
           server {
             server_name {{ NGINX.server_name }};
             listen 80;
             listen [::]:80;
             error_page 500 502 503 504 /50x.html;
        
             location / {
               index {{ NGINX.index_page }};
               root {{ NGINX.web_root }};
             }
        
             location ~ \.php$ {
               fastcgi_index index.php;
               fastcgi_param SCRIPT_FILENAME  $document_root$fastcgi_script_name;
               fastcgi_pass unix:{{ NGINX.fpm_socket }};
               fastcgi_split_path_info ^(.+\.php)(/.+)$;
               include {{ NGINX.fcgi_params }};
               root {{ NGINX.web_root }};
               try_files $uri =404;
             }
           }
        
        if you then set the NGINX environment variable, running e2j2 will render
        the jinja2 template and place it in the same folder:
        
        .. code:: bash
        
           ~> export NGINX='json:
           {
           "server_name": "www.myweb.com",
           "index_page": "index.php",
           "web_root": "/usr/local/www/myweb",
           "fcgi_params": "/usr/local/etc/nginx/myweb-fcgi-params",
           "fpm_socket": "/var/run/php-fpm/myweb.socket"
           }'
           ~> e2j2
        
           In: .
               rendering: nginx_vhost_config.conf.j2=>done => writing: nginx_vhost_config.conf=>done
        
           ~> cat nginx_vhost_config.conf
           server {
             server_name www.myweb.com;
             listen 80;
             listen [::]:80;
             error_page 500 502 503 504 /50x.html;
        
             location / {
               index index.php;
               root /usr/local/www/myweb;
             }
        
             location ~ \.php$ {
               fastcgi_index index.php;
               fastcgi_param SCRIPT_FILENAME  $document_root$fastcgi_script_name;
               fastcgi_pass unix:/var/run/php-fpm/myweb.socket;
               fastcgi_split_path_info ^(.+\.php)(/.+)$;
               include /usr/local/etc/nginx/myweb-fcgi-params;
               root /usr/local/www/roundcube;
               try_files $uri =404;
             }
           }
        
        Environment variable examples:
        ------------------------------
        
        Plain environment variable:
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Example:
        
        setting:
        
        ::
        
           MYENVVAR='plain environment variable'
        
        will render envvar-example.j2 to:
        
        ::
        
           This is a plain environment variable
        
        Tag file:
        ~~~~~~~~~
        
        Example:
        
        setting:
        
        ::
        
           MYFILEVAR=file:./file-example.txt
        
        will render file-example.j2 to:
        
        ::
        
           This is a file example
        
        Tag json:
        ~~~~~~~~~
        
        Example:
        
        setting:
        
        ::
        
           MYJSONVAR='json:{"key": "json-example"}'
        
        will render json-example.j2 to:
        
        ::
        
           This is a json-example
        
        Tag jsonfile:
        ~~~~~~~~~~~~~
        
        Example:
        
        setting:
        
        ::
        
           MYJSONFILEVAR='jsonfile:jsonfile-example.json'
        
        will render jsonfile-example.j2 to:
        
        ::
        
           This is a jsonfile example with subkey
        
        Tag base64:
        ~~~~~~~~~~~
        
        Example:
        
        Setting:
        
        ::
        
           export MYBASE64VAR='base64:YmFzZTY0IGV4YW1wbGU='
        
        will render base64-example.j2 to:
        
        ::
        
           This is a base64 example
        
        Tag consul:
        ~~~~~~~~~~~
        
        Configuration:
        
        You can configure the consul tag by setting the CONSUL_CONFIG
        environment variable. The following config items are supported:
        
        ============ =============================== =====================
        Item         Explanation                     Default
        ============ =============================== =====================
        url          consul url                      http://127.0.0.1:8500
        scheme       consul url scheme http or https scheme from url
        host         consul host                     hostname from url
        port         consul http(s) port             port from url
        token        consul token                    none
        ============ =============================== =====================
        
        Global config example:
        
        ::
        
           read -d '' CONSUL_CONFIG << EOF
           {
              "url": "https://consul.foobar.tld",
              "token": "abcdef01-0123-abcd-1234-0123456789ab"
           }
           EOF
        
        The ACL token can be configured by either the above configuration or by setting the CONSUL_TOKEN variable.
        
        As an alternative for the global configuration it is also possible to configure / adjust the global configuration for each consul tag, by simply include the configuration when using the consul tag.
        
        Tag config example:
        
        ::
        
            export MYCONSULVAR='consul:config={"url": "https://consul2.foobar.tld", "token": "012345678-0123-abcd-1234-0123456789ab"}:consulvar"
        
        
        
        Consul example:
        
        Setting:
        
        key: consulvar in consul to value: consul example
        
        and
        
        ::
        
           export MYCONSULVAR='consul:consulvar'
        
        will render consul-example.j2 to:
        
        ::
        
           This is a consul example
        
        Tag list:
        ~~~~~~~~~
        
        Example:
        
        Setting:
        
        ::
        
           export MYLIST='list:"first","second","third","fourth"'
        
        will render list-example.j2 to:
        
        ::
        
           "first"
           "second"
           "third"
           "fourth"
        
        Two pass rendering
        ~~~~~~~~~~~~~~~~~~
        
        Starting from version 0.1.12 e2j2 supports embedding jinja2 macros in
        environment variables.
        
        Example:
        
        Setting the following two environment variables:
        
        ::
        
            export WORDPRESS='json:{"database": {"name": "mydb", "user": "mydb_user", "password": "{{ DBSECRET }}", "host": "localhost"}}'
            export DBSECRET='file:./twopass-secret'
        
        will render (by running: ``e2j2 -f twopass-example.j2 -2``) to:
        
        ::
        
           // ** MySQL settings - You can get this info from your web host ** //
           /** The name of the database for WordPress */
           define( 'DB_NAME', 'mydb' );
        
           /** MySQL database username */
           define( 'DB_USER', 'mydb_user' );
        
           /** MySQL database password */
           define( 'DB_PASSWORD', 'Db$ecr3t' );
        
           /** MySQL hostname */
           define( 'DB_HOST', 'localhost' );
        
        
        Tag vault:
        ~~~~~~~~~~~
        
        Configuration:
        
        You can configure the vault tag by setting the VAULT_CONFIG
        environment variable. The following config items are supported:
        
        ============ ============================== =====================
        Item         Explanation                    Default
        ============ ============================== =====================
        url          vault url                      http://127.0.0.1:8200
        scheme       vault url scheme http or https scheme from url
        host         vault host                     hostname from url
        port         vault http(s) port             port from url
        backend      vault secret backend           raw
        token        vault token                    none
        ============ ============================== =====================
        
        the following backends are supported:
        
        ======= =========================================
        backend Description
        ======= =========================================
        raw     use plain GET request to secret store API
        kv1     key/value version 1
        kv2     key/value version 2
        ======= =========================================
        
        Global config example:
        
        ::
        
           read -d '' VAULT_CONFIG << EOF
            {
              "url": "https://vault.foobar.tld:8200",
              "token": "s.xxxxxxxxxxxxxxxxxxxxxxx",
              "backend: "kv2"
            }
           EOF
        
        The Authentication token can be configured by either the above configuration or by setting the VAULT_TOKEN variable.
        
        As an alternative for the global configuration it is also possible to configure / adjust the global configuration for each vault tag, by simply include the configuration when using the vault tag.
        
        Tag config example:
        
        ::
        
            export MYVAULTVAR='vault:config={"backend": "kv1"}:kv/my-secret"
        
        Vault example:
        
        Setting:
        
        ::
        
           vault kv put secret/my-secret secret=topsecret
           export MYVAULTVAR='vault:secret/my-secret'
        
        will render vault-kv1-example.j2 (by running: ``e2j2 -f vault-example.j2``) to:
        
        ::
        
           ** topsecret **
           This is a vault example
        
        .. |Build Status| image:: https://travis-ci.org/provonet/e2j2.svg?branch=master
           :target: https://travis-ci.org/provonet/e2j2
        .. |Coverage Status| image:: https://coveralls.io/repos/github/provonet/e2j2/badge.svg
           :target: https://coveralls.io/github/provonet/e2j2
        
        
        Changelog
        =========
        0.2.0 (2019-07-23)
        ------------------
        
        Added
        -----
        - vault secrets support
        - per tag config (for the consul and vault tags)
        - add support for token variables (for the consul and vault tags)
        
        Changed
        -------
        - Add json schema validation for consul and vault config
        
        0.1.21 (2019-07-09)
        -------------------
        
        Fixed
        -----
        - Fix issue with included templates in other directories
        
        Added
        -----
        - Add option to "copy" file ownership and file permissions
        
        0.1.20 (2019-06-12)
        -------------------
        
        Fixed
        -----
        - fix "only render one file" issue
        
        0.1.19 (2019-06-10)
        -------------------
        
        Added
        -----
        - add option to whitelist / blacklist environment variables
        
        Fixed
        -----
        - set proper exit codes (0=success / 1=failure)
        
        Changed
        -------
        - add unittests
        - add functional tests
        
        0.1.18 (2019-05-17)
        -------------------
        
        Fixed
        -----
        -  Fix bug in consul parser
        
        .. _section-1:
        
        0.1.17 (2019-05-17)
        -------------------
        
        Fixed
        -----
        
        -  Fix bug with include statements in jinja2 template
        
        .. _section-2:
        
        0.1.16 (2019-05-16)
        -------------------
        
        .. _fixed-1:
        
        Fixed
        -----
        
        -  Fix bug with default jinja marker
        
        .. _section-3:
        
        0.1.15 (2019-05-16)
        -------------------
        
        Changed
        -------
        
        -  add options to overwrite the default jinja2 markers (block start/end,
           variable start/end and comment start/end)
        
        Breaking change
        ~~~~~~~~~~~~~~~
        
        -  removed “hack” for twopass rendering, you can use the new marker for
           handling conflicting characters in your template
        
        .. _section-4:
        
        0.1.14 (2019-04-30)
        -------------------
        
        .. _fixed-2:
        
        Fixed
        ~~~~~
        
        -  preserve newlines at end of file
        -  CVE-2019-10906, module now requires jinja2>=2.10.1
        
        .. _section-5:
        
        0.1.13 (2019-03-29)
        -------------------
        
        .. _fixed-3:
        
        Fixed
        ~~~~~
        
        -  Fix for ignored raw tag with two-pass rendering
        
        .. _section-6:
        
        0.1.12 (2019-03-14)
        -------------------
        
        Added
        ~~~~~
        
        -  add support for two pass rendering
        
        .. _section-7:
        
        0.1.11 (2019-01-30)
        -------------------
        
        .. _changed-1:
        
        Changed
        ~~~~~~~
        
        -  Changed behavior of nested keys with the consul tag.
        
        example: in consul we have an key key1/key2/123 envvar
        KEY=consul:key1/key2 => {{ KEY }} will now render to 123 and no longer
        to {“key2”: 123}
        
        .. _section-8:
        
        0.1.10 (2018-09-24)
        -------------------
        
        .. _added-1:
        
        Added
        ~~~~~
        
        -  add file tag, this tag will place the content of the file into the
           variable
        
        .. _section-9:
        
        0.1.9 (2018-09-21)
        ------------------
        
        .. _fixed-4:
        
        Fixed
        ~~~~~
        
        -  fix import issue on python 2.7
        
        .. _section-10:
        
        0.1.8 (2018-09-21)
        ------------------
        
        .. _changed-2:
        
        Changed
        ~~~~~~~
        
        -  handle hashrocket characters in json tag (as produced by hiera)
        
        .. _section-11:
        
        0.1.7 (2018-09-20)
        ------------------
        
        .. _added-2:
        
        Added
        ~~~~~
        
        -  Add list tag which will parse a comma separated list
        
        .. _section-12:
        
        0.1.6 (2018-05-17)
        ------------------
        
        .. _changed-3:
        
        Changed
        ~~~~~~~
        
        -  Improved error messages
        -  Handle json decode errors
        
        .. _section-13:
        
        0.1.5 (2018-05-11)
        ------------------
        
        .. _added-3:
        
        Added
        ~~~~~
        
        -  add no-color option
        
        .. _section-14:
        
        0.1.4 (2017-08-21)
        ------------------
        
        .. _added-4:
        
        Added
        ~~~~~
        
        -  add version option
        -  add file list option
        
        .. _fixed-5:
        
        Fixed
        ~~~~~
        
        -  Fix bug with empty consul key values
        
        .. _section-15:
        
        0.1.3 (2017-07-11)
        ------------------
        
        .. _breaking-change-1:
        
        Breaking change
        ~~~~~~~~~~~~~~~
        
        -  the consul tags will now use default jinja2 objects, this breaks the
           previous behaviour of separation by underscores
        
        .. _changed-4:
        
        Changed
        ~~~~~~~
        
        -  remove dependency click, use argparse instead.
        
        .. _fixed-6:
        
        Fixed
        ~~~~~
        
        -  make sure that bytes are casted to strings (for base64 and consul
           tags)
        
        .. _section-16:
        
        0.1.2 (2017-05-17)
        ------------------
        
        .. _fixed-7:
        
        Fixed
        ~~~~~
        
        -  additional fix for install issue on python2 (added MANIFEST.in)
        
        .. _section-17:
        
        0.1.1 (2017-05-17)
        ------------------
        
        .. _fixed-8:
        
        Fixed
        ~~~~~
        
        -  add README.rst and CHANGELOG.rst as package_data this fixes install
           issue with python 2.x
        
        Removed
        ~~~~~~~
        
        -  remove dependency colorama
        
        .. _changed-5:
        
        Changed
        ~~~~~~~
        
        -  move methods to separate helper files
        
        .. _section-18:
        
        0.1.0 (2017-05-16)
        ------------------
        
        .. _added-5:
        
        Added
        ~~~~~
        
        -  add short options for extention (-e) searchlist (-s) and noop (-N)
        -  add (MIT) license
        
        .. _changed-6:
        
        Changed
        ~~~~~~~
        
        -  e2j2 is now packaged as pip package
        -  split script and module, script will be installed in /usr/bin or
           /usr/local/bin
        
        .. _section-19:
        
        0.0.2 (2017-05-16)
        ------------------
        
        .. _added-6:
        
        Added
        ~~~~~
        
        -  Add recurse flag
        
        .. _changed-7:
        
        Changed
        ~~~~~~~
        
        -  Searchlist is no longer a required option e2j2 will use the current
           directory as default
        -  Recursion is no longer on by default
        -  Improve error handling, e2j2 will now report failures and render
           \*.err files which will make debugging errors much easier
        
        .. _section-20:
        
        0.0.1 (2017-05-01)
        ------------------
        
        Initial release
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Software Development :: Libraries
