diff --git a/README b/README deleted file mode 100644 index e69de29..0000000 diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..20283b2 --- /dev/null +++ b/README.rst @@ -0,0 +1,34 @@ +Env: Environment Variables for Humans +===================================== + +Mapping environment variables can be a bit of a pain. + +Now you can replace this boilerplate:: + + ZENDESK_URL = os.environ['ZENDESK_URL'] + ZENDESK_USER = os.environ['ZENDESK_USER'] + ZENDESK_PASS = os.environ['ZENDESK_PASS'] + ZENDESK_VIEW = os.environ['ZENDESK_VIEW'] + +With a simple call:: + + >>> import env + +:: + + >>> zendesk = env.prefix('zendesk_') + >>> zendesk + {'user': ..., 'pass': ..., 'url': ..., 'view': ...} + +Or have a bit more control:: + + >>> env.map(user='zendesk_user') + {'user': ...} + + +Installation +------------ + +Installation is easy with pip:: + + $ pip instal env \ No newline at end of file