Metadata-Version: 1.1
Name: speckenv
Version: 1.1
Summary: UNKNOWN
Home-page: https://github.com/matthiask/speckenv/
Author: Matthias Kestenholz
Author-email: mk@feinheit.ch
License: BSD License
Description: ========
        speckenv
        ========
        
        speckenv because a speck is a synonym for a dot and because Speck is awesome.
        
        Usage
        =====
        
        Read the settings contained in ``./.env`` into ``os.environ`` (or a
        different mapping; pass a dict-like object as ``mapping``)::
        
            from speckenv import read_speckenv
        
            read_speckenv()
        
        Note that ``read_speckenv`` uses ``os.environ.setdefault`` to set new values,
        which means that if a particular key exists more than once in the file the
        first value is retained, not the last.
        
        If the file is named differently or resides in a different path, pass the
        full path as first argument to ``read_speckenv``.
        
        Read individual values::
        
            from speckenv import env
        
            SETTING1 = env('SETTING1')
            SETTING2 = env('SETTING2', default='bla')
            SETTING3 = env('SETTING3 ', required=True)  # Fail hard if missing.
        
            # Different mapping: env('SOMETHING', mapping=...)
        
        The following values are evaluated as Python literals::
        
            BOOL=True  # And False, None etc.
            NUMBER=42
            SWEET_HOME=['localhost', '127.0.0.1']
        
        Additional whitespace around the equals sign is supported. Empty lines and
        lines starting with a ``#`` are ignored.
        
        **NOTE!** You should treat everything except for the first argument to
        both ``env`` and ``read_speckenv`` as keyword-only. Since speckenv still
        supports Python 2 this isn't enforced by the code right now.
        
Platform: OS Independent
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
