Skip to content

Commit b7759b7

Browse files
author
Saurabh Kumar
committed
Update documentation to suite the new documentation site
1 parent e0f68c2 commit b7759b7

File tree

7 files changed

+231
-207
lines changed

7 files changed

+231
-207
lines changed

CHANGELOG.md

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
# Install the latest
2+
3+
To install the latest version of `python-dotenv` simply run:
4+
5+
`pip install python-dotenv`
6+
7+
OR
8+
9+
`poetry add python-dotenv`
10+
11+
OR
12+
13+
`pipenv install python-dotenv`
14+
15+
16+
Changelog
17+
=========
18+
19+
Latest
20+
-----
21+
22+
- ...
23+
24+
0.10.3
25+
-----
26+
27+
- Improve interactive mode detection ([@andrewsmith])([#183]).
28+
- Refactor parser to fix parsing inconsistencies ([@bbc2])([#170]).
29+
- Interpret escapes as control characters only in double-quoted strings.
30+
- Interpret `#` as start of comment only if preceded by whitespace.
31+
32+
0.10.2
33+
-----
34+
35+
- Add type hints and expose them to users ([@qnighy])([#172])
36+
- `load_dotenv` and `dotenv_values` now accept an `encoding` parameter, defaults to `None`
37+
([@theskumar])([@earlbread])([#161])
38+
- Fix `str`/`unicode` inconsistency in Python 2: values are always `str` now. ([@bbc2])([#121])
39+
- Fix Unicode error in Python 2, introduced in 0.10.0. ([@bbc2])([#176])
40+
41+
0.10.1
42+
-----
43+
- Fix parsing of variable without a value ([@asyncee])([@bbc2])([#158])
44+
45+
0.10.0
46+
-----
47+
48+
- Add support for UTF-8 in unquoted values ([@bbc2])([#148])
49+
- Add support for trailing comments ([@bbc2])([#148])
50+
- Add backslashes support in values ([@bbc2])([#148])
51+
- Add support for newlines in values ([@bbc2])([#148])
52+
- Force environment variables to str with Python2 on Windows ([@greyli])
53+
- Drop Python 3.3 support ([@greyli])
54+
- Fix stderr/-out/-in redirection ([@venthur])
55+
56+
57+
0.9.0
58+
-----
59+
- Add `--version` parameter to cli ([@venthur])
60+
- Enable loading from current directory ([@cjauvin])
61+
- Add 'dotenv run' command for calling arbitrary shell script with .env ([@venthur])
62+
63+
0.8.1
64+
-----
65+
66+
- Add tests for docs ([@Flimm])
67+
- Make 'cli' support optional. Use `pip install python-dotenv[cli]`. ([@theskumar])
68+
69+
0.8.0
70+
-----
71+
72+
- `set_key` and `unset_key` only modified the affected file instead of
73+
parsing and re-writing file, this causes comments and other file
74+
entact as it is.
75+
- Add support for `export` prefix in the line.
76+
- Internal refractoring ([@theskumar])
77+
- Allow `load_dotenv` and `dotenv_values` to work with `StringIO())` ([@alanjds])([@theskumar])([#78])
78+
79+
0.7.1
80+
-----
81+
82+
- Remove hard dependency on iPython ([@theskumar])
83+
84+
0.7.0
85+
-----
86+
87+
- Add support to override system environment variable via .env.
88+
([@milonimrod](https://github.com/milonimrod))
89+
([\#63](https://github.com/theskumar/python-dotenv/issues/63))
90+
- Disable ".env not found" warning by default
91+
([@maxkoryukov](https://github.com/maxkoryukov))
92+
([\#57](https://github.com/theskumar/python-dotenv/issues/57))
93+
94+
0.6.5
95+
-----
96+
97+
- Add support for special characters `\`.
98+
([@pjona](https://github.com/pjona))
99+
([\#60](https://github.com/theskumar/python-dotenv/issues/60))
100+
101+
0.6.4
102+
-----
103+
104+
- Fix issue with single quotes ([@Flimm])
105+
([\#52](https://github.com/theskumar/python-dotenv/issues/52))
106+
107+
0.6.3
108+
-----
109+
110+
- Handle unicode exception in setup.py
111+
([\#46](https://github.com/theskumar/python-dotenv/issues/46))
112+
113+
0.6.2
114+
-----
115+
116+
- Fix dotenv list command ([@ticosax](https://github.com/ticosax))
117+
- Add iPython Suport
118+
([@tillahoffmann](https://github.com/tillahoffmann))
119+
120+
0.6.0
121+
-----
122+
123+
- Drop support for Python 2.6
124+
- Handle escaped charaters and newlines in quoted values. (Thanks
125+
[@iameugenejo](https://github.com/iameugenejo))
126+
- Remove any spaces around unquoted key/value. (Thanks
127+
[@paulochf](https://github.com/paulochf))
128+
- Added POSIX variable expansion. (Thanks
129+
[@hugochinchilla](https://github.com/hugochinchilla))
130+
131+
0.5.1
132+
-----
133+
134+
- Fix find\_dotenv - it now start search from the file where this
135+
function is called from.
136+
137+
0.5.0
138+
-----
139+
140+
- Add `find_dotenv` method that will try to find a `.env` file.
141+
(Thanks [@isms](https://github.com/isms))
142+
143+
0.4.0
144+
-----
145+
146+
- cli: Added `-q/--quote` option to control the behaviour of quotes
147+
around values in `.env`. (Thanks
148+
[@hugochinchilla](https://github.com/hugochinchilla)).
149+
- Improved test coverage.
150+
151+
[#161]: https://github.com/theskumar/python-dotenv/issues/161
152+
[#78]: https://github.com/theskumar/python-dotenv/issues/78
153+
[#148]: https://github.com/theskumar/python-dotenv/issues/148
154+
[#158]: https://github.com/theskumar/python-dotenv/issues/158
155+
[#172]: https://github.com/theskumar/python-dotenv/issues/172
156+
[#121]: https://github.com/theskumar/python-dotenv/issues/121
157+
[#176]: https://github.com/theskumar/python-dotenv/issues/176
158+
[#170]: https://github.com/theskumar/python-dotenv/issues/170
159+
[#183]: https://github.com/theskumar/python-dotenv/issues/183
160+
161+
[@andrewsmith]: https://github.com/andrewsmith
162+
[@asyncee]: https://github.com/asyncee
163+
[@greyli]: https://github.com/greyli
164+
[@venthur]: https://github.com/venthur
165+
[@Flimm]: https://github.com/Flimm
166+
[@theskumar]: https://github.com/theskumar
167+
[@alanjds]: https://github.com/alanjds
168+
[@cjauvin]: https://github.com/cjauvin
169+
[@bbc2]: https://github.com/bbc2
170+
[@qnighy]: https://github.com/qnighy
171+
[@earlbread]: https://github.com/earlbread

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Contributing
2+
============
3+
4+
All the contributions are welcome! Please open [an
5+
issue](https://github.com/theskumar/python-dotenv/issues/new) or send us
6+
a pull request.
7+
8+
Executing the tests:
9+
10+
$ pip install -r requirements.txt
11+
$ pip install -e .
12+
$ flake8
13+
$ pytest
14+
15+
or with [tox](https://pypi.org/project/tox/) installed:
16+
17+
$ tox
18+

0 commit comments

Comments
 (0)