pollutri
/
res_levis_API
1
0
Креирај огранак 0
Код Дискусије 0 Захтеви за спајање 0 Издања 0 Вики Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
5 Комити
1 Грана
203 MiB
 
 
 
 
Дрво: 1141c5ca64
Гране Ознаке
${ item.name }
Create branch ${ searchTerm }
from '1141c5ca64'
${ noResults }
res_levis_API/lib/python3.6/site-packages/python_dotenv-0.10.3.dist-info/METADATA

479 lines
15 KiB
Датотека Blame Историја 

  1. Metadata-Version: 2.1

  2. Name: python-dotenv

  3. Version: 0.10.3

  4. Summary: Add .env support to your django/flask apps in development and deployments

  5. Home-page: http://github.com/theskumar/python-dotenv

  6. Author: Saurabh Kumar

  7. Author-email: me+github@saurabh-kumar.com

  8. License: UNKNOWN

  9. Keywords: environment variables,deployments,settings,env,dotenv,configurations,python

  10. Platform: UNKNOWN

  11. Classifier: Development Status :: 5 - Production/Stable

  12. Classifier: Programming Language :: Python

  13. Classifier: Programming Language :: Python :: 2.7

  14. Classifier: Programming Language :: Python :: 3.4

  15. Classifier: Programming Language :: Python :: 3.5

  16. Classifier: Programming Language :: Python :: 3.6

  17. Classifier: Programming Language :: Python :: 3.7

  18. Classifier: Programming Language :: Python :: Implementation :: PyPy

  19. Classifier: Intended Audience :: Developers

  20. Classifier: Intended Audience :: System Administrators

  21. Classifier: License :: OSI Approved :: BSD License

  22. Classifier: Operating System :: OS Independent

  23. Classifier: Topic :: System :: Systems Administration

  24. Classifier: Topic :: Utilities

  25. Classifier: Environment :: Web Environment

  26. Description-Content-Type: text/markdown

  27. Requires-Dist: typing ; python_version < "3.5"

  28. Provides-Extra: cli

  29. Requires-Dist: click (>=5.0) ; extra == 'cli'

  30. 

  31. ```

  32.         _______ .__   __. ____    ____

  33.        |   ____||  \ |  | \   \  /   /

  34.        |  |__   |   \|  |  \   \/   /

  35.        |   __|  |  . `  |   \      /

  36.     __ |  |____ |  |\   |    \    /

  37.    (__)|_______||__| \__|     \__/

  38. ```

  39. python-dotenv | [![Build Status](https://travis-ci.org/theskumar/python-dotenv.svg?branch=master)](https://travis-ci.org/theskumar/python-dotenv) [![Coverage Status](https://coveralls.io/repos/theskumar/python-dotenv/badge.svg?branch=master)](https://coveralls.io/r/theskumar/python-dotenv?branch=master) [![PyPI version](https://badge.fury.io/py/python-dotenv.svg)](http://badge.fury.io/py/python-dotenv) [![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/theskumar)

  40. ===============================================================================

  41. 

  42. Reads the key,value pair from `.env` file and adds them to environment

  43. variable. It is great for managing app settings during development and

  44. in production using [12-factor](http://12factor.net/) principles.

  45. 

  46. > Do one thing, do it well!

  47. 

  48. - [Usages](#usages)

  49. - [Installation](#installation)

  50. - [Command-line interface](#command-line-interface)

  51. - [iPython Support](#ipython-support)

  52. - [Setting config on remote servers](#setting-config-on-remote-servers)

  53. - [Related Projects](#related-projects)

  54. - [Contributing](#contributing)

  55. - [Changelog](#changelog)

  56. 

  57. > Hey just wanted to let you know that since I've started writing 12-factor apps I've found python-dotenv to be invaluable for all my projects. It's super useful and “just works.” --Daniel Fridkin

  58. 

  59. Usages

  60. ======

  61. 

  62. The easiest and most common usage consists on calling `load_dotenv` when

  63. the application starts, which will load environment variables from a

  64. file named `.env` in the current directory or any of its parents or from

  65. the path specificied; after that, you can just call the

  66. environment-related method you need as provided by `os.getenv`.

  67. 

  68. `.env` looks like this:

  69. 

  70. ```shell

  71. # a comment and that will be ignored.

  72. REDIS_ADDRESS=localhost:6379

  73. MEANING_OF_LIFE=42

  74. MULTILINE_VAR="hello\nworld"

  75. ```

  76. 

  77. You can optionally prefix each line with the word `export`, which is totally ignored by this library, but might allow you to [`source`](https://bash.cyberciti.biz/guide/Source_command) the file in bash.

  78. 

  79. ```

  80. export S3_BUCKET=YOURS3BUCKET

  81. export SECRET_KEY=YOURSECRETKEYGOESHERE

  82. ```

  83. 

  84. `.env` can interpolate variables using POSIX variable expansion,

  85. variables are replaced from the environment first or from other values

  86. in the `.env` file if the variable is not present in the environment.

  87. (`Note`: Default Value Expansion is not supported as of yet, see

  88. [\#30](https://github.com/theskumar/python-dotenv/pull/30#issuecomment-244036604).)

  89. 

  90. ```shell

  91. CONFIG_PATH=${HOME}/.config/foo

  92. DOMAIN=example.org

  93. EMAIL=admin@${DOMAIN}

  94. ```

  95. 

  96. Getting started

  97. ===============

  98. 

  99. Assuming you have created the `.env` file along-side your settings

  100. module.

  101. 

  102.     .

  103.     ├── .env

  104.     └── settings.py

  105. 

  106. Add the following code to your `settings.py`

  107. 

  108. ```python

  109. # settings.py

  110. from dotenv import load_dotenv

  111. load_dotenv()

  112. 

  113. # OR, the same with increased verbosity:

  114. load_dotenv(verbose=True)

  115. 

  116. # OR, explicitly providing path to '.env'

  117. from pathlib import Path  # python3 only

  118. env_path = Path('.') / '.env'

  119. load_dotenv(dotenv_path=env_path)

  120. ```

  121. 

  122. At this point, parsed key/value from the .env file is now present as

  123. system environment variable and they can be conveniently accessed via

  124. `os.getenv()`

  125. 

  126. ```python

  127. # settings.py

  128. import os

  129. SECRET_KEY = os.getenv("EMAIL")

  130. DATABASE_PASSWORD = os.getenv("DATABASE_PASSWORD")

  131. ```

  132. 

  133. `load_dotenv` do not override existing System environment variables. To

  134. override, pass `override=True` to `load_dotenv()`.

  135. 

  136. `load_dotenv` also accepts `encoding` parameter to open the `.env` file. The default encoding is platform dependent (whatever `locale.getpreferredencoding()` returns), but any encoding supported by Python can be used. See the [codecs](https://docs.python.org/3/library/codecs.html#standard-encodings) module for the list of supported encodings.

  137. 

  138. You can use `find_dotenv()` method that will try to find a `.env` file

  139. by (a) guessing where to start using `__file__` or the working directory

  140. -- allowing this to work in non-file contexts such as IPython notebooks

  141. and the REPL, and then (b) walking up the directory tree looking for the

  142. specified file -- called `.env` by default.

  143. 

  144. ```python

  145. from dotenv import load_dotenv, find_dotenv

  146. load_dotenv(find_dotenv())

  147. ```

  148. 

  149. In-memory filelikes

  150. -------------------

  151. 

  152. It is possible to not rely on the filesystem to parse filelikes from

  153. other sources (e.g. from a network storage). `load_dotenv` and

  154. `dotenv_values` accepts a filelike `stream`. Just be sure to rewind it

  155. before passing.

  156. 

  157. ```python

  158. >>> from io import StringIO     # Python2: from StringIO import StringIO

  159. >>> from dotenv import dotenv_values

  160. >>> filelike = StringIO('SPAM=EGGS\n')

  161. >>> filelike.seek(0)

  162. >>> parsed = dotenv_values(stream=filelike)

  163. >>> parsed['SPAM']

  164. 'EGGS'

  165. ```

  166. 

  167. The returned value is dictionary with key value pair.

  168. 

  169. `dotenv_values` could be useful if you need to *consume* the envfile but

  170. not *apply* it directly into the system environment.

  171. 

  172. Django

  173. ------

  174. 

  175. If you are using django you should add the above loader script at the

  176. top of `wsgi.py` and `manage.py`.

  177. 

  178. Installation

  179. ============

  180. 

  181.     pip install -U python-dotenv

  182. 

  183. iPython Support

  184. ---------------

  185. 

  186. You can use dotenv with iPython. You can either let the dotenv search

  187. for .env with %dotenv or provide the path to .env file explicitly, see

  188. below for usages.

  189. 

  190.     %load_ext dotenv

  191. 

  192.     # Use find_dotenv to locate the file

  193.     %dotenv

  194. 

  195.     # Specify a particular file

  196.     %dotenv relative/or/absolute/path/to/.env

  197. 

  198.     # Use '-o' to indicate override of existing variables

  199.     %dotenv -o

  200. 

  201.     # Use '-v' to turn verbose mode on

  202.     %dotenv -v

  203. 

  204. Command-line interface

  205. ======================

  206. 

  207. For commandline support, use the cli option during installation:

  208. 

  209.     pip install -U "python-dotenv[cli]"

  210. 

  211. A cli interface `dotenv` is also included, which helps you manipulate

  212. the `.env` file without manually opening it. The same cli installed on

  213. remote machine combined with fabric (discussed later) will enable you to

  214. update your settings on remote server, handy isn't it!

  215. 

  216. ```

  217. Usage: dotenv [OPTIONS] COMMAND [ARGS]...

  218. 

  219.   This script is used to set, get or unset values from a .env file.

  220. 

  221. Options:

  222.   -f, --file PATH                 Location of the .env file, defaults to .env

  223.                                   file in current working directory.

  224.   -q, --quote [always|never|auto]

  225.                                   Whether to quote or not the variable values.

  226.                                   Default mode is always. This does not affect

  227.                                   parsing.

  228.   --help                          Show this message and exit.

  229. 

  230. Commands:

  231.   get    Retrive the value for the given key.

  232.   list   Display all the stored key/value.

  233.   run    Run command with environment variables from .env file present

  234.   set    Store the given key/value.

  235.   unset  Removes the given key.

  236. ```

  237. 

  238. Setting config on remote servers

  239. --------------------------------

  240. 

  241. We make use of excellent [Fabric](http://www.fabfile.org/) to acomplish

  242. this. Add a config task to your local fabfile, `dotenv_path` is the

  243. location of the absolute path of `.env` file on the remote server.

  244. 

  245. ```python

  246. # fabfile.py

  247. 

  248. import dotenv

  249. from fabric.api import task, run, env

  250. 

  251. # absolute path to the location of .env on remote server.

  252. env.dotenv_path = '/opt/myapp/.env'

  253. 

  254. @task

  255. def config(action=None, key=None, value=None):

  256.     '''Manage project configuration via .env

  257. 

  258.     e.g: fab config:set,<key>,<value>

  259.          fab config:get,<key>

  260.          fab config:unset,<key>

  261.          fab config:list

  262.     '''

  263.     run('touch %(dotenv_path)s' % env)

  264.     command = dotenv.get_cli_string(env.dotenv_path, action, key, value)

  265.     run(command)

  266. ```

  267. 

  268. Usage is designed to mirror the heroku config api very closely.

  269. 

  270. Get all your remote config info with `fab config`

  271. 

  272.     $ fab config

  273.     foo="bar"

  274. 

  275. Set remote config variables with `fab config:set,<key>,<value>`

  276. 

  277.     $ fab config:set,hello,world

  278. 

  279. Get a single remote config variables with `fab config:get,<key>`

  280. 

  281.     $ fab config:get,hello

  282. 

  283. Delete a remote config variables with `fab config:unset,<key>`

  284. 

  285.     $ fab config:unset,hello

  286. 

  287. Thanks entirely to fabric and not one bit to this project, you can chain

  288. commands like so

  289. `fab config:set,<key1>,<value1> config:set,<key2>,<value2>`

  290. 

  291.     $ fab config:set,hello,world config:set,foo,bar config:set,fizz=buzz

  292. 

  293. Related Projects

  294. ================

  295. 

  296. -   [Honcho](https://github.com/nickstenning/honcho) - For managing

  297.     Procfile-based applications.

  298. -   [django-dotenv](https://github.com/jpadilla/django-dotenv)

  299. -   [django-environ](https://github.com/joke2k/django-environ)

  300. -   [django-configuration](https://github.com/jezdez/django-configurations)

  301. -   [dump-env](https://github.com/sobolevn/dump-env)

  302. -   [environs](https://github.com/sloria/environs)

  303. 

  304. Contributing

  305. ============

  306. 

  307. All the contributions are welcome! Please open [an

  308. issue](https://github.com/theskumar/python-dotenv/issues/new) or send us

  309. a pull request.

  310. 

  311. This project is currently maintained by [Saurabh Kumar](https://saurabh-kumar.com) and [Bertrand Bonnefoy-Claudet](https://github.com/bbc2) and would not

  312. have been possible without the support of these [awesome

  313. people](https://github.com/theskumar/python-dotenv/graphs/contributors).

  314. 

  315. Executing the tests:

  316. 

  317.     $ pip install -r requirements.txt

  318.     $ pip install -e .

  319.     $ flake8

  320.     $ pytest

  321. 

  322. or with [tox](https://pypi.org/project/tox/) installed:

  323. 

  324.     $ tox

  325. 

  326. Changelog

  327. =========

  328. 

  329. Unreleased

  330. -----

  331. 

  332. - Improve interactive mode detection ([@andrewsmith])([#183]).

  333. - Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).

  334.   - Interpret escapes as control characters only in double-quoted strings.

  335.   - Interpret `#` as start of comment only if preceded by whitespace.

  336. 

  337. 0.10.2

  338. -----

  339. 

  340. - Add type hints and expose them to users ([@qnighy])([#172])

  341. - `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`

  342.   ([@theskumar])([@earlbread])([#161])

  343. - Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])

  344. - Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])

  345. 

  346. 0.10.1

  347. -----

  348. - Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])

  349. 

  350. 0.10.0

  351. -----

  352. 

  353. - Add support for UTF-8 in unquoted values ([@bbc2])([#148])

  354. - Add support for trailing comments ([@bbc2])([#148])

  355. - Add backslashes support in values ([@bbc2])([#148])

  356. - Add support for newlines in values ([@bbc2])([#148])

  357. - Force environment variables to str with Python2 on Windows ([@greyli])

  358. - Drop Python 3.3 support ([@greyli])

  359. - Fix stderr/-out/-in redirection ([@venthur])

  360. 

  361. 

  362. 0.9.0

  363. -----

  364. - Add `--version` parameter to cli ([@venthur])

  365. - Enable loading from current directory ([@cjauvin])

  366. - Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])

  367. 

  368. 0.8.1

  369. -----

  370. 

  371. -   Add tests for docs ([@Flimm])

  372. -   Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])

  373. 

  374. 0.8.0

  375. -----

  376. 

  377. -   `set_key` and `unset_key` only modified the affected file instead of

  378.     parsing and re-writing file, this causes comments and other file

  379.     entact as it is.

  380. -   Add support for `export` prefix in the line.

  381. -   Internal refractoring ([@theskumar])

  382. -   Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])

  383. 

  384. 0.7.1

  385. -----

  386. 

  387. -   Remove hard dependency on iPython ([@theskumar])

  388. 

  389. 0.7.0

  390. -----

  391. 

  392. -   Add support to override system environment variable via .env.

  393.     ([@milonimrod](https://github.com/milonimrod))

  394.     ([\#63](https://github.com/theskumar/python-dotenv/issues/63))

  395. -   Disable ".env not found" warning by default

  396.     ([@maxkoryukov](https://github.com/maxkoryukov))

  397.     ([\#57](https://github.com/theskumar/python-dotenv/issues/57))

  398. 

  399. 0.6.5

  400. -----

  401. 

  402. -   Add support for special characters `\`.

  403.     ([@pjona](https://github.com/pjona))

  404.     ([\#60](https://github.com/theskumar/python-dotenv/issues/60))

  405. 

  406. 0.6.4

  407. -----

  408. 

  409. -   Fix issue with single quotes ([@Flimm])

  410.     ([\#52](https://github.com/theskumar/python-dotenv/issues/52))

  411. 

  412. 0.6.3

  413. -----

  414. 

  415. -   Handle unicode exception in setup.py

  416.     ([\#46](https://github.com/theskumar/python-dotenv/issues/46))

  417. 

  418. 0.6.2

  419. -----

  420. 

  421. -   Fix dotenv list command ([@ticosax](https://github.com/ticosax))

  422. -   Add iPython Suport

  423.     ([@tillahoffmann](https://github.com/tillahoffmann))

  424. 

  425. 0.6.0

  426. -----

  427. 

  428. -   Drop support for Python 2.6

  429. -   Handle escaped charaters and newlines in quoted values. (Thanks

  430.     [@iameugenejo](https://github.com/iameugenejo))

  431. -   Remove any spaces around unquoted key/value. (Thanks

  432.     [@paulochf](https://github.com/paulochf))

  433. -   Added POSIX variable expansion. (Thanks

  434.     [@hugochinchilla](https://github.com/hugochinchilla))

  435. 

  436. 0.5.1

  437. -----

  438. 

  439. -   Fix find\_dotenv - it now start search from the file where this

  440.     function is called from.

  441. 

  442. 0.5.0

  443. -----

  444. 

  445. -   Add `find_dotenv` method that will try to find a `.env` file.

  446.     (Thanks [@isms](https://github.com/isms))

  447. 

  448. 0.4.0

  449. -----

  450. 

  451. -   cli: Added `-q/--quote` option to control the behaviour of quotes

  452.     around values in `.env`. (Thanks

  453.     [@hugochinchilla](https://github.com/hugochinchilla)).

  454. -   Improved test coverage.

  455. 

  456. [#161]: https://github.com/theskumar/python-dotenv/issues/161

  457. [#78]: https://github.com/theskumar/python-dotenv/issues/78

  458. [#148]: https://github.com/theskumar/python-dotenv/issues/148

  459. [#158]: https://github.com/theskumar/python-dotenv/issues/158

  460. [#172]: https://github.com/theskumar/python-dotenv/issues/172

  461. [#121]: https://github.com/theskumar/python-dotenv/issues/121

  462. [#176]: https://github.com/theskumar/python-dotenv/issues/176

  463. [#170]: https://github.com/theskumar/python-dotenv/issues/170

  464. [#183]: https://github.com/theskumar/python-dotenv/issues/183

  465. 

  466. [@andrewsmith]: https://github.com/andrewsmith

  467. [@asyncee]: https://github.com/asyncee

  468. [@greyli]: https://github.com/greyli

  469. [@venthur]: https://github.com/venthur

  470. [@Flimm]: https://github.com/Flimm

  471. [@theskumar]: https://github.com/theskumar

  472. [@alanjds]: https://github.com/alanjds

  473. [@cjauvin]: https://github.com/cjauvin

  474. [@bbc2]: https://github.com/bbc2

  475. [@qnighy]: https://github.com/qnighy

  476. [@earlbread]: https://github.com/earlbread

  477.