Metadata-Version: 2.1
Name: dotenv-cli
Version: 2.2.0
Summary: Simple dotenv CLI.
Home-page: https://github.com/venthur/dotenv-cli
Author: Bastian Venthur
Author-email: mail@venthur.de
License: MIT
Description: # dotenv CLI
        
        Dotenv-CLI is a simple package that provides the `dotenv` command. It reads the
        `.env` file from the current directory puts the contents in the environment and
        executes the given command.
        
        `dotenv` supports alternative `.env` files like `.env.development` via the `-e`
        or `--dotenv` parametes.
        
        `dotenv` provides bash completion, so you can use `dotenv` like this:
        
        ```bash
        $ dotenv make <TAB>
        all      clean    docs     lint     release  test
        ```
        
        ## Install
        
        ### Using PyPi
        
        dotenv-cli is [available on PyPi][pypi], you can install it via:
        
        [pypi]: https://pypi.org/project/dotenv-cli/
        
        ```bash
        $ pip install dotenv-cli
        ```
        
        ### On Debian and Ubuntu
        
        Alternatively, you can install dotenv-cli on Debian based distributions via:
        
        ```bash
        # apt-get install python3-dotenv-cli
        ```
        
        
        ## Usage
        
        Create an `.env` file in the root of your project and populate it with some
        values like so:
        
        ```sh
        SOME_SECRET=donttrythisathome
        SOME_CONFIG=foo
        ```
        
        Just prepend the command you want to run with the extra environment variables
        from the `.env` file with `dotenv`:
        
        ```bash
        $ dotenv some-command
        ```
        
        and those variables will be available in your environment variables.
        
        
        ## Rules
        
        The parser understands the following:
        
        * Basic unquoted values (`BASIC=basic basic`)
        * Lines starting with `export` (`export EXPORT=foo`), so you can `source` the
          file in bash
        * Lines starting with `#` are ignored (`# Comment`)
        * Empty values (`EMPTY=`) become empty strings
        * Inner quotes are maintained in basic values: `INNER_QUOTES=this 'is' a test`
          or `INNER_QUOTES2=this "is" a test`
        * White spaces are trimmed from unquoted values: `TRIM_WHITESPACE=  foo  ` and
          maintained in quoted values:  `KEEP_WHITESPACE="  foo  "`
        * Interpret escapes (e.g. `\n`) in double quoted values, keep them as-is in
          single quoted values.
        
        Example `.env` file:
        
        ```sh
        BASIC=basic basic
        export EXPORT=foo
        EMPTY=
        INNER_QUOTES=this 'is' a test
        INNER_QUOTES2=this "is" a test
        TRIM_WHITESPACE= foo
        KEEP_WHITESPACE="  foo  "
        MULTILINE_DQ="multi\nline"
        MULTILINE_SQ='multi\nline'
        MULTILINE_NQ=multi\nline
        #
        # some comment
        ```
        
        becomes:
        
        ```sh
        $ dotenv env
        BASIC=basic basic
        EXPORT=foo
        EMPTY=
        INNER_QUOTES=this 'is' a test
        INNER_QUOTES2=this "is" a test
        TRIM_WHITESPACE=foo
        KEEP_WHITESPACE=  foo
        MULTILINE_DQ=multi
        line
        MULTILINE_SQ=multi\nline
        MULTILINE_NQ=multi\nline
        ```
        
Keywords: dotenv cli .env
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
