grim/envconfig2

Add the missing example for integers and add an example for url's

2017-08-29, Gary Kramlich
7d652f5b5a92
Parents 0bd92d883490
Children 11f381cdb6ce
Add the missing example for integers and add an example for url's
1 files changed, 16 insertions(+), 0 deletions(-)
  • +16 -0
    README.md
    • --- a/README.md Tue Aug 29 14:44:25 2017 -0500
    +++ b/README.md Tue Aug 29 14:47:10 2017 -0500
    @@ -17,6 +17,14 @@
    >>> envconfig2.integer('DB_PORT')
    5432
    +### Integer Example
    +
    + >>> import os
    + >>> os.environ['PORT'] = '80'
    + >>> import envconfig2
    + >>> envconfig2.integer('PORT')
    + 80
    +
    ### Boolean Example
    >>> import os
    @@ -41,6 +49,14 @@
    >>> envconfig2.json('JSON')
    {u'debug': True}
    +### URL Example
    +
    + >>> import os
    + >>> os.environ['URL'] = 'https://example.com'
    + >>> import envconfig2
    + >>> envconfig2.url('URL')
    + ParseResult(scheme='https', netloc='example.com', path='', params='', query='', fragment='')
    +
    ### Required Example
    >>> import envconfig2