forked from theskumar/python-dotenv
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
816 lines (527 loc) · 34.4 KB
/
index.html
File metadata and controls
816 lines (527 loc) · 34.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="lang:clipboard.copy" content="Copy to clipboard">
<meta name="lang:clipboard.copied" content="Copied to clipboard">
<meta name="lang:search.language" content="en">
<meta name="lang:search.pipeline.stopwords" content="True">
<meta name="lang:search.pipeline.trimmer" content="True">
<meta name="lang:search.result.none" content="No matching documents">
<meta name="lang:search.result.one" content="1 matching document">
<meta name="lang:search.result.other" content="# matching documents">
<meta name="lang:search.tokenizer" content="[\s\-]+">
<link rel="shortcut icon" href="assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2">
<title>python-dotenv</title>
<link rel="stylesheet" href="assets/stylesheets/application.30686662.css">
<link rel="stylesheet" href="assets/stylesheets/application-palette.a8b3c06d.css">
<meta name="theme-color" content="#4caf50">
<script src="assets/javascripts/modernizr.74668098.js"></script>
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback">
<style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
<link rel="stylesheet" href="assets/fonts/material-icons.css">
</head>
<body dir="ltr" data-md-color-primary="green" data-md-color-accent="lightgreen">
<svg class="md-svg">
<defs>
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
</defs>
</svg>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
<a href="#python-dotenv" tabindex="1" class="md-skip">
Skip to content
</a>
<header class="md-header" data-md-component="header">
<nav class="md-header-nav md-grid">
<div class="md-flex">
<div class="md-flex__cell md-flex__cell--shrink">
<a href="." title="python-dotenv" class="md-header-nav__button md-logo">
<i class="md-icon"></i>
</a>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
</div>
<div class="md-flex__cell md-flex__cell--stretch">
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
<span class="md-header-nav__topic">
python-dotenv
</span>
<span class="md-header-nav__topic">
Home
</span>
</div>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
<label class="md-icon md-search__icon" for="__search"></label>
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">

</button>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="result">
<div class="md-search-result__meta">
Type to start searching
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<div class="md-header-nav__source">
<a href="https://github.com/theskumar/python-dotenv/" title="Go to repository" class="md-source" data-md-source="github">
<div class="md-source__icon">
<svg viewBox="0 0 24 24" width="24" height="24">
<use xlink:href="#__github" width="24" height="24"></use>
</svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container">
<main class="md-main" role="main">
<div class="md-main__inner md-grid" data-md-component="container">
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" data-md-level="0">
<label class="md-nav__title md-nav__title--site" for="__drawer">
<a href="." title="python-dotenv" class="md-nav__button md-logo">
<i class="md-icon"></i>
</a>
python-dotenv
</label>
<div class="md-nav__source">
<a href="https://github.com/theskumar/python-dotenv/" title="Go to repository" class="md-source" data-md-source="github">
<div class="md-source__icon">
<svg viewBox="0 0 24 24" width="24" height="24">
<use xlink:href="#__github" width="24" height="24"></use>
</svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Home
</label>
<a href="." title="Home" class="md-nav__link md-nav__link--active">
Home
</a>
<nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">Table of contents</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#usages" class="md-nav__link">
Usages
</a>
</li>
<li class="md-nav__item">
<a href="#getting-started" class="md-nav__link">
Getting started
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#in-memory-filelikes" class="md-nav__link">
In-memory filelikes
</a>
</li>
<li class="md-nav__item">
<a href="#django" class="md-nav__link">
Django
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#ipython-support" class="md-nav__link">
IPython Support
</a>
</li>
<li class="md-nav__item">
<a href="#command-line-interface" class="md-nav__link">
Command-line Interface
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#setting-config-on-remote-servers" class="md-nav__link">
Setting config on Remote Servers
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#related-projects" class="md-nav__link">
Related Projects
</a>
</li>
<li class="md-nav__item">
<a href="#acknowledgements" class="md-nav__link">
Acknowledgements
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="CHANGELOG/" title="Changelog" class="md-nav__link">
Changelog
</a>
</li>
<li class="md-nav__item">
<a href="CONTRIBUTING/" title="Contributing" class="md-nav__link">
Contributing
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
<label class="md-nav__link" for="nav-4">
Reference
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-4">
Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="reference/dotenv/" title="Dotenv" class="md-nav__link">
Dotenv
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">Table of contents</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#usages" class="md-nav__link">
Usages
</a>
</li>
<li class="md-nav__item">
<a href="#getting-started" class="md-nav__link">
Getting started
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#in-memory-filelikes" class="md-nav__link">
In-memory filelikes
</a>
</li>
<li class="md-nav__item">
<a href="#django" class="md-nav__link">
Django
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#ipython-support" class="md-nav__link">
IPython Support
</a>
</li>
<li class="md-nav__item">
<a href="#command-line-interface" class="md-nav__link">
Command-line Interface
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#setting-config-on-remote-servers" class="md-nav__link">
Setting config on Remote Servers
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#related-projects" class="md-nav__link">
Related Projects
</a>
</li>
<li class="md-nav__item">
<a href="#acknowledgements" class="md-nav__link">
Acknowledgements
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/theskumar/python-dotenv/edit/master/docs/README.md" title="Edit this page" class="md-icon md-content__icon"></a>
<div class="codehilite"><pre><span></span> <span class="n">_______</span> <span class="p">.</span><span class="n">__</span> <span class="n">__</span><span class="p">.</span> <span class="n">____</span> <span class="n">____</span>
<span class="o">|</span> <span class="n">____</span><span class="o">||</span> <span class="err">\</span> <span class="o">|</span> <span class="o">|</span> <span class="err">\</span> <span class="err">\</span> <span class="o">/</span> <span class="o">/</span>
<span class="o">|</span> <span class="o">|</span><span class="n">__</span> <span class="o">|</span> <span class="err">\</span><span class="o">|</span> <span class="o">|</span> <span class="err">\</span> <span class="err">\</span><span class="o">/</span> <span class="o">/</span>
<span class="o">|</span> <span class="n">__</span><span class="o">|</span> <span class="o">|</span> <span class="p">.</span> <span class="o">`</span> <span class="o">|</span> <span class="err">\</span> <span class="o">/</span>
<span class="n">__</span> <span class="o">|</span> <span class="o">|</span><span class="n">____</span> <span class="o">|</span> <span class="o">|</span><span class="err">\</span> <span class="o">|</span> <span class="err">\</span> <span class="o">/</span>
<span class="p">(</span><span class="n">__</span><span class="p">)</span><span class="o">|</span><span class="n">_______</span><span class="o">||</span><span class="n">__</span><span class="o">|</span> <span class="err">\</span><span class="n">__</span><span class="o">|</span> <span class="err">\</span><span class="n">__</span><span class="o">/</span>
</pre></div>
<h1 id="python-dotenv">python-dotenv | <a href="https://travis-ci.org/theskumar/python-dotenv"><img alt="Build Status" src="https://travis-ci.org/theskumar/python-dotenv.svg?branch=master" /></a> <a href="https://coveralls.io/r/theskumar/python-dotenv?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/theskumar/python-dotenv/badge.svg?branch=master" /></a> <a href="http://badge.fury.io/py/python-dotenv"><img alt="PyPI version" src="https://badge.fury.io/py/python-dotenv.svg" /></a> <a href="https://saythanks.io/to/theskumar"><img alt="Say Thanks!" src="https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg" /></a></h1>
<p>Reads the key-value pair from <code>.env</code> file and adds them to environment
variable. It is great for managing app settings during development and
in production using <a href="http://12factor.net/">12-factor</a> principles.</p>
<blockquote>
<p>Do one thing, do it well!</p>
</blockquote>
<h2 id="usages">Usages</h2>
<p>The easiest and most common usage consists on calling <code>load_dotenv</code> when
the application starts, which will load environment variables from a
file named <code>.env</code> in the current directory or any of its parents or from
the path specificied; after that, you can just call the
environment-related method you need as provided by <code>os.getenv</code>.</p>
<p><code>.env</code> looks like this:</p>
<div class="codehilite"><pre><span></span><span class="c1"># a comment that will be ignored.</span>
<span class="nv">REDIS_ADDRESS</span><span class="o">=</span>localhost:6379
<span class="nv">MEANING_OF_LIFE</span><span class="o">=</span><span class="m">42</span>
<span class="nv">MULTILINE_VAR</span><span class="o">=</span><span class="s2">"hello\nworld"</span>
</pre></div>
<p>You can optionally prefix each line with the word <code>export</code>, which is totally ignored by this library, but might allow you to <a href="https://bash.cyberciti.biz/guide/Source_command"><code>source</code></a> the file in bash.</p>
<div class="codehilite"><pre><span></span><span class="n">export</span> <span class="n">S3_BUCKET</span><span class="o">=</span><span class="n">YOURS3BUCKET</span>
<span class="n">export</span> <span class="n">SECRET_KEY</span><span class="o">=</span><span class="n">YOURSECRETKEYGOESHERE</span>
</pre></div>
<p><code>.env</code> can interpolate variables using POSIX variable expansion,
variables are replaced from the environment first or from other values
in the <code>.env</code> file if the variable is not present in the environment.
(<strong>Note</strong>: Default Value Expansion is not supported as of yet, see
<a href="https://github.com/theskumar/python-dotenv/pull/30#issuecomment-244036604">#30</a>.)</p>
<div class="codehilite"><pre><span></span><span class="nv">CONFIG_PATH</span><span class="o">=</span><span class="si">${</span><span class="nv">HOME</span><span class="si">}</span>/.config/foo
<span class="nv">DOMAIN</span><span class="o">=</span>example.org
<span class="nv">EMAIL</span><span class="o">=</span>admin@<span class="si">${</span><span class="nv">DOMAIN</span><span class="si">}</span>
</pre></div>
<h2 id="getting-started">Getting started</h2>
<p>Install the latest version with:</p>
<div class="codehilite"><pre><span></span>pip install -U python-dotenv
</pre></div>
<p>Assuming you have created the <code>.env</code> file along-side your settings
module.</p>
<div class="codehilite"><pre><span></span><span class="p">.</span>
<span class="err">├──</span> <span class="p">.</span><span class="n">env</span>
<span class="err">└──</span> <span class="n">settings</span><span class="p">.</span><span class="n">py</span>
</pre></div>
<p>Add the following code to your <code>settings.py</code>:</p>
<div class="codehilite"><pre><span></span><span class="c1"># settings.py</span>
<span class="kn">from</span> <span class="nn">dotenv</span> <span class="kn">import</span> <span class="n">load_dotenv</span>
<span class="n">load_dotenv</span><span class="p">()</span>
<span class="c1"># OR, the same with increased verbosity</span>
<span class="n">load_dotenv</span><span class="p">(</span><span class="n">verbose</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="c1"># OR, explicitly providing path to '.env'</span>
<span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span> <span class="c1"># python3 only</span>
<span class="n">env_path</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)</span> <span class="o">/</span> <span class="s1">'.env'</span>
<span class="n">load_dotenv</span><span class="p">(</span><span class="n">dotenv_path</span><span class="o">=</span><span class="n">env_path</span><span class="p">)</span>
</pre></div>
<p>At this point, parsed key/value from the <code>.env</code> file is now present as
system environment variable and they can be conveniently accessed via
<code>os.getenv()</code>:</p>
<div class="codehilite"><pre><span></span><span class="c1"># settings.py</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="n">SECRET_KEY</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">"EMAIL"</span><span class="p">)</span>
<span class="n">DATABASE_PASSWORD</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">"DATABASE_PASSWORD"</span><span class="p">)</span>
</pre></div>
<p><code>load_dotenv</code> do not override existing System environment variables. To
override, pass <code>override=True</code> to <code>load_dotenv()</code>.</p>
<p><code>load_dotenv</code> also accepts <code>encoding</code> parameter to open the <code>.env</code> file. The default encoding is platform dependent (whatever <code>locale.getpreferredencoding()</code> returns), but any encoding supported by Python can be used. See the <a href="https://docs.python.org/3/library/codecs.html#standard-encodings">codecs</a> module for the list of supported encodings.</p>
<p>You can use <code>find_dotenv()</code> method that will try to find a <code>.env</code> file
by (a) guessing where to start using <code>__file__</code> or the working directory
-- allowing this to work in non-file contexts such as IPython notebooks
and the REPL, and then (b) walking up the directory tree looking for the
specified file -- called <code>.env</code> by default.</p>
<div class="codehilite"><pre><span></span><span class="kn">from</span> <span class="nn">dotenv</span> <span class="kn">import</span> <span class="n">load_dotenv</span><span class="p">,</span> <span class="n">find_dotenv</span>
<span class="n">load_dotenv</span><span class="p">(</span><span class="n">find_dotenv</span><span class="p">())</span>
</pre></div>
<h3 id="in-memory-filelikes">In-memory filelikes</h3>
<p>It is possible to not rely on the filesystem to parse filelikes from
other sources (e.g. from a network storage). <code>load_dotenv</code> and
<code>dotenv_values</code> accepts a filelike <code>stream</code>. Just be sure to rewind it
before passing.</p>
<div class="codehilite"><pre><span></span><span class="o">>>></span> <span class="kn">from</span> <span class="nn">io</span> <span class="kn">import</span> <span class="n">StringIO</span> <span class="c1"># Python2: from StringIO import StringIO</span>
<span class="o">>>></span> <span class="kn">from</span> <span class="nn">dotenv</span> <span class="kn">import</span> <span class="n">dotenv_values</span>
<span class="o">>>></span> <span class="n">filelike</span> <span class="o">=</span> <span class="n">StringIO</span><span class="p">(</span><span class="s1">'SPAM=EGGS</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
<span class="o">>>></span> <span class="n">filelike</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="o">>>></span> <span class="n">parsed</span> <span class="o">=</span> <span class="n">dotenv_values</span><span class="p">(</span><span class="n">stream</span><span class="o">=</span><span class="n">filelike</span><span class="p">)</span>
<span class="o">>>></span> <span class="n">parsed</span><span class="p">[</span><span class="s1">'SPAM'</span><span class="p">]</span>
<span class="s1">'EGGS'</span>
</pre></div>
<p>The returned value is dictionary with key-value pair.</p>
<p><code>dotenv_values</code> could be useful if you need to <em>consume</em> the envfile but
not <em>apply</em> it directly into the system environment.</p>
<h3 id="django">Django</h3>
<p>If you are using Django, you should add the above loader script at the
top of <code>wsgi.py</code> and <code>manage.py</code>.</p>
<h2 id="ipython-support">IPython Support</h2>
<p>You can use dotenv with IPython. You can either let the dotenv search
for <code>.env</code> with <code>%dotenv</code> or provide the path to the <code>.env</code> file explicitly; see
below for usages.</p>
<div class="codehilite"><pre><span></span><span class="nf">%load_ext</span> <span class="n">dotenv</span>
<span class="cp"># Use find_dotenv to locate the file</span>
<span class="nf">%dotenv</span>
<span class="cp"># Specify a particular file</span>
<span class="nf">%dotenv</span> <span class="n">relative</span><span class="o">/</span><span class="n">or</span><span class="o">/</span><span class="n">absolute</span><span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="p">.</span><span class="n">env</span>
<span class="cp"># Use '-o' to indicate override of existing variables</span>
<span class="nf">%dotenv</span> <span class="o">-</span><span class="n">o</span>
<span class="cp"># Use '-v' to turn verbose mode on</span>
<span class="nf">%dotenv</span> <span class="o">-</span><span class="n">v</span>
</pre></div>
<h2 id="command-line-interface">Command-line Interface</h2>
<p>For command-line support, use the CLI option during installation:</p>
<div class="codehilite"><pre><span></span>pip install -U <span class="s2">"python-dotenv[cli]"</span>
</pre></div>
<p>A CLI interface <code>dotenv</code> is also included, which helps you manipulate
the <code>.env</code> file without manually opening it. The same CLI installed on
remote machine combined with fabric (discussed later) will enable you to
update your settings on a remote server; handy, isn't it!</p>
<div class="codehilite"><pre><span></span><span class="nv">Usage</span>: <span class="nv">dotenv</span> [<span class="nv">OPTIONS</span>] <span class="nv">COMMAND</span> [<span class="nv">ARGS</span>]...
<span class="nv">This</span> <span class="nv">script</span> <span class="nv">is</span> <span class="nv">used</span> <span class="nv">to</span> <span class="nv">set</span>, <span class="nv">get</span> <span class="nv">or</span> <span class="nv">unset</span> <span class="nv">values</span> <span class="nv">from</span> <span class="nv">a</span> .<span class="nv">env</span> <span class="nv">file</span>.
<span class="nv">Options</span>:
<span class="o">-</span><span class="nv">f</span>, <span class="o">--</span><span class="nv">file</span> <span class="nv">PATH</span> <span class="nv">Location</span> <span class="nv">of</span> <span class="nv">the</span> .<span class="nv">env</span> <span class="nv">file</span>, <span class="nv">defaults</span> <span class="nv">to</span> .<span class="nv">env</span>
<span class="nv">file</span> <span class="nv">in</span> <span class="nv">current</span> <span class="nv">working</span> <span class="nv">directory</span>.
<span class="o">-</span><span class="nv">q</span>, <span class="o">--</span><span class="nv">quote</span> [<span class="nv">always</span><span class="o">|</span><span class="nv">never</span><span class="o">|</span><span class="nv">auto</span>]
<span class="nv">Whether</span> <span class="nv">to</span> <span class="nv">quote</span> <span class="nv">or</span> <span class="nv">not</span> <span class="nv">the</span> <span class="nv">variable</span> <span class="nv">values</span>.
<span class="nv">Default</span> <span class="nv">mode</span> <span class="nv">is</span> <span class="nv">always</span>. <span class="nv">This</span> <span class="nv">does</span> <span class="nv">not</span> <span class="nv">affect</span>
<span class="nv">parsing</span>.
<span class="o">--</span><span class="nv">help</span> <span class="k">Show</span> <span class="nv">this</span> <span class="nv">message</span> <span class="nv">and</span> <span class="k">exit</span>.
<span class="nv">Commands</span>:
<span class="nv">get</span> <span class="nv">Retrive</span> <span class="nv">the</span> <span class="nv">value</span> <span class="k">for</span> <span class="nv">the</span> <span class="nv">given</span> <span class="nv">key</span>.
<span class="nv">list</span> <span class="nv">Display</span> <span class="nv">all</span> <span class="nv">the</span> <span class="nv">stored</span> <span class="nv">key</span><span class="o">/</span><span class="nv">value</span>.
<span class="nv">run</span> <span class="nv">Run</span> <span class="nv">command</span> <span class="nv">with</span> <span class="nv">environment</span> <span class="nv">variables</span> <span class="nv">from</span> .<span class="nv">env</span> <span class="nv">file</span> <span class="nv">present</span>
<span class="nv">set</span> <span class="nv">Store</span> <span class="nv">the</span> <span class="nv">given</span> <span class="nv">key</span><span class="o">/</span><span class="nv">value</span>.
<span class="nv">unset</span> <span class="nv">Removes</span> <span class="nv">the</span> <span class="nv">given</span> <span class="nv">key</span>.
</pre></div>
<h3 id="setting-config-on-remote-servers">Setting config on Remote Servers</h3>
<p>We make use of excellent <a href="http://www.fabfile.org/">Fabric</a> to accomplish
this. Add a config task to your local fabfile; <code>dotenv_path</code> is the
location of the absolute path of <code>.env</code> file on the remote server.</p>
<div class="codehilite"><pre><span></span><span class="c1"># fabfile.py</span>
<span class="kn">import</span> <span class="nn">dotenv</span>
<span class="kn">from</span> <span class="nn">fabric.api</span> <span class="kn">import</span> <span class="n">task</span><span class="p">,</span> <span class="n">run</span><span class="p">,</span> <span class="n">env</span>
<span class="c1"># absolute path to the location of .env on remote server.</span>
<span class="n">env</span><span class="o">.</span><span class="n">dotenv_path</span> <span class="o">=</span> <span class="s1">'/opt/myapp/.env'</span>
<span class="nd">@task</span>
<span class="k">def</span> <span class="nf">config</span><span class="p">(</span><span class="n">action</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">'''Manage project configuration via .env</span>
<span class="sd"> e.g: fab config:set,<key>,<value></span>
<span class="sd"> fab config:get,<key></span>
<span class="sd"> fab config:unset,<key></span>
<span class="sd"> fab config:list</span>
<span class="sd"> '''</span>
<span class="n">run</span><span class="p">(</span><span class="s1">'touch </span><span class="si">%(dotenv_path)s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">env</span><span class="p">)</span>
<span class="n">command</span> <span class="o">=</span> <span class="n">dotenv</span><span class="o">.</span><span class="n">get_cli_string</span><span class="p">(</span><span class="n">env</span><span class="o">.</span><span class="n">dotenv_path</span><span class="p">,</span> <span class="n">action</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="n">run</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
</pre></div>
<p>Usage is designed to mirror the Heroku config API very closely.</p>
<p>Get all your remote config info with <code>fab config</code>:</p>
<div class="codehilite"><pre><span></span>$ fab config
<span class="nv">foo</span><span class="o">=</span><span class="s2">"bar"</span>
</pre></div>
<p>Set remote config variables with <code>fab config:set,<key>,<value></code>:</p>
<div class="codehilite"><pre><span></span>$ fab config:set,hello,world
</pre></div>
<p>Get a single remote config variables with <code>fab config:get,<key></code>:</p>
<div class="codehilite"><pre><span></span>$ fab config:get,hello
</pre></div>
<p>Delete a remote config variables with <code>fab config:unset,<key></code>:</p>
<div class="codehilite"><pre><span></span>$ fab config:unset,hello
</pre></div>
<p>Thanks entirely to fabric and not one bit to this project, you can chain
commands like so:
<code>fab config:set,<key1>,<value1> config:set,<key2>,<value2></code></p>
<div class="codehilite"><pre><span></span>$ fab config:set,hello,world config:set,foo,bar config:set,fizz<span class="o">=</span>buzz
</pre></div>
<h2 id="related-projects">Related Projects</h2>
<ul>
<li><a href="https://github.com/nickstenning/honcho">Honcho</a> - For managing
Procfile-based applications.</li>
<li><a href="https://github.com/jpadilla/django-dotenv">django-dotenv</a></li>
<li><a href="https://github.com/joke2k/django-environ">django-environ</a></li>
<li><a href="https://github.com/jezdez/django-configurations">django-configuration</a></li>
<li><a href="https://github.com/sobolevn/dump-env">dump-env</a></li>
<li><a href="https://github.com/sloria/environs">environs</a></li>
<li><a href="https://github.com/rochacbruno/dynaconf">dynaconf</a></li>
</ul>
<h2 id="acknowledgements">Acknowledgements</h2>
<p>This project is currently maintained by <a href="https://saurabh-kumar.com">Saurabh Kumar</a> and <a href="https://github.com/bbc2">Bertrand Bonnefoy-Claudet</a> and would not
have been possible without the support of these <a href="https://github.com/theskumar/python-dotenv/graphs/contributors">awesome
people</a>.</p>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid">
<a href="CHANGELOG/" title="Changelog" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
<span class="md-flex__ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Changelog
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
</div>
</a>
</nav>
</div>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-footer-copyright">
Powered by
<a href="http://timothycrosley.github.io/portray">portray.</a>
You too can
<a href="http://timothycrosley.github.io/portray">
portray</a>
your Python project well using automatic documentation.
</div>
</div>
</div>
</footer>
</div>
<script src="assets/javascripts/application.c648116f.js"></script>
<script>app.initialize({version:"1.0.4",url:{base:"."}})</script>
</body>
</html>