bucket_F8/python-python-dotenv

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-python-dotenv
   4 VERSION=                1.0.1
   5 KEYWORDS=               python
   6 VARIANTS=               v11 v12
   7 SDESC[v11]=             Sets environment from .env file (3.11)
   8 SDESC[v12]=             Sets environment from .env file (3.12)
   9 HOMEPAGE=               https://github.com/theskumar/python-dotenv
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/6a/3e/b68c118422ec867fa7ab88444e1274aa40681c606d59ac27de5a5588f082
  14 DISTFILE[1]=            python_dotenv-1.0.1-py3-none-any.whl:main
  15 DF_INDEX=               1
  16 SPKGS[v11]=             single
  17 SPKGS[v12]=             single
  18
  19 OPTIONS_AVAILABLE=      PY311 PY312
  20 OPTIONS_STANDARD=       none
  21 VOPTS[v11]=             PY311=ON PY312=OFF
  22 VOPTS[v12]=             PY311=OFF PY312=ON
  23
  24 DISTNAME=               python_dotenv-1.0.1.dist-info
  25
  26 GENERATED=              yes
  27
  28 [PY311].USES_ON=                        python:v11,wheel
  29
  30 [PY312].USES_ON=                        python:v12,wheel
  31
  32 [FILE:2508:descriptions/desc.single]
  33 # python-dotenv
  34
  35 [![Build Status][build_status_badge]][build_status_link]
  36 [![PyPI version][pypi_badge]][pypi_link]
  37
  38 Python-dotenv reads key-value pairs from a `.env` file and can set them as
  39 environment
  40 variables. It helps in the development of applications following the
  41 [12-factor] principles.
  42
  43 - [Getting Started]
  44 - [Other Use Cases]
  45   * [Load configuration without altering the environment]
  46   * [Parse configuration as a stream]
  47   * [Load .env files in IPython]
  48 - [Command-line Interface]
  49 - [File format]
  50   * [Multiline values]
  51   * [Variable expansion]
  52 - [Related Projects]
  53 - [Acknowledgements]
  54
  55 ## Getting Started
  56
  57 ```shell
  58 pip install python-dotenv
  59 ```
  60
  61 If your application takes its configuration from environment variables,
  62 like a 12-factor
  63 application, launching it in development is not very practical because you
  64 have to set
  65 those environment variables yourself.
  66
  67 To help you with that, you can add Python-dotenv to your application to
  68 make it load the
  69 configuration from a `.env` file when it is present (e.g. in development)
  70 while remaining
  71 configurable via the environment:
  72
  73 ```python
  74 from dotenv import load_dotenv
  75
  76 load_dotenv()  # take environment variables from .env.
  77
  78 # Code of your application, which uses environment variables (e.g. from
  79 `os.environ` or
  80 # `os.getenv`) as if they came from the actual environment.
  81 ```
  82
  83 By default, `load_dotenv` doesn't override existing environment variables.
  84
  85 To configure the development environment, add a `.env` in the root
  86 directory of your
  87 project:
  88
  89 ```
  90 .
  91 ├── .env
  92 └── foo.py
  93 ```
  94
  95 The syntax of `.env` files supported by python-dotenv is similar to that of
  96 Bash:
  97
  98 ```bash
  99 # Development settings
 100 DOMAIN=example.org
 101 ADMIN_EMAIL=admin@${DOMAIN}
 102 ROOT_URL=${DOMAIN}/app
 103 ```
 104
 105 If you use variables in values, ensure they are surrounded with `{` and
 106 `}`, like
 107 `${DOMAIN}`, as bare variables such as `$DOMAIN` are not expanded.
 108
 109 You will probably want to add `.env` to your `.gitignore`, especially if it
 110 contains
 111 secrets like a password.
 112
 113 See the section "File format" below for more information about what you can
 114 write in a
 115 `.env` file.
 116
 117 ## Other Use Cases
 118
 119 ### Load configuration without altering the environment
 120
 121 The function `dotenv_values` works more or less the same way as
 122 `load_dotenv`, except it
 123 doesn't touch the environment, it just returns a `dict` with the values
 124 parsed from the
 125 `.env` file.
 126
 127 ```python
 128 from dotenv import dotenv_values
 129
 130 config = dotenv_values(".env")  # config = {"USER": "foo", "EMAIL":
 131 "foo@example.org"}
 132 ```
 133
 134
 135 [FILE:115:distinfo]
 136 f7b63ef50f1b690dddf550d03497b66d609393b40b564ed0d674909a68ebf16a        19863 python_dotenv-1.0.1-py3-none-any.whl
 137