diff --git a/README.rst b/README.rst index f4c5aac..d85beea 100644 --- a/README.rst +++ b/README.rst @@ -38,35 +38,19 @@ Supported Formats - ``import envcfg.smart.foo as config``: Try to import each ``FOO_*`` environment variable as JSON body, if fail then import it as string. -There is an example table: - -+----------------------+---------------------------+-----------------------+ -| Environment Variable | Python Import Statement | Python Variable Value | -+======================+===========================+=======================+ -| ``FOO_NAME=foo`` | ``envcfg.raw.foo.NAME`` | ``'foo'`` | -+----------------------+---------------------------+-----------------------+ -| ``FOO_NAME="foo"`` | ``envcfg.raw.foo.NAME`` | ``'"foo"'`` | -+----------------------+---------------------------+-----------------------+ -| ``FOO_NUM1=42`` | ``envcfg.raw.foo.NUM1`` | ``'42'`` | -+----------------------+---------------------------+-----------------------+ -| ``FOO_NUM1="42"`` | ``envcfg.raw.foo.NUM1`` | ``'"42"'`` | -+----------------------+---------------------------+-----------------------+ -| ``FOO_NAME=foo`` | ``envcfg.json.foo.NAME`` | *ImportError* | -+----------------------+---------------------------+-----------------------+ -| ``FOO_NAME="foo"`` | ``envcfg.json.foo.NAME`` | ``'foo'`` | -+----------------------+---------------------------+-----------------------+ -| ``FOO_NUM1=42`` | ``envcfg.json.foo.NUM1`` | ``42`` | -+----------------------+---------------------------+-----------------------+ -| ``FOO_NUM1="42"`` | ``envcfg.json.foo.NUM1`` | ``'42'`` | -+----------------------+---------------------------+-----------------------+ -| ``FOO_NAME=foo`` | ``envcfg.smart.foo.NAME`` | ``'foo'`` | -+----------------------+---------------------------+-----------------------+ -| ``FOO_NAME="foo"`` | ``envcfg.smart.foo.NAME`` | ``'foo'`` | -+----------------------+---------------------------+-----------------------+ -| ``FOO_NUM1=42`` | ``envcfg.smart.foo.NUM1`` | ``42`` | -+----------------------+---------------------------+-----------------------+ -| ``FOO_NUM1="42"`` | ``envcfg.smart.foo.NUM1`` | ``'42'`` | -+----------------------+---------------------------+-----------------------+ +There is an example: + ++-------------------+------------------------+-------------------------+--------------------------+ +| | ``envcfg.raw.foo.VAL`` | ``envcfg.json.foo.VAL`` | ``envcfg.smart.foo.VAL`` | ++===================+========================+=========================+==========================+ +| ``FOO_VAL=foo`` | ``'foo'`` | ``ImportError`` | ``'foo'`` | ++-------------------+------------------------+-------------------------+--------------------------+ +| ``FOO_VAL="foo"`` | ``'"foo"'`` | ``'foo'`` | ``'foo'`` | ++-------------------+------------------------+-------------------------+--------------------------+ +| ``FOO_VAL=42`` | ``'42'`` | ``42`` | ``42`` | ++-------------------+------------------------+-------------------------+--------------------------+ +| ``FOO_VAL="42"`` | ``'"42"'`` | ``'42'`` | ``'42'`` | ++-------------------+------------------------+-------------------------+--------------------------+ Examples --------