Skip to content

Commit 519682f

Browse files
author
Saurabh Kumar
committed
Add docs for 0.4.0 release
1 parent 8c2c707 commit 519682f

1 file changed

Lines changed: 26 additions & 17 deletions

File tree

README.rst

Lines changed: 26 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ gets higher precedence** and it's advised not to include it in version control.
6363
6464
6565
``.env`` is a simple text file. With each environment variables listed
66-
per line, in the format of ``KEY="Value"``, lines starting with `#` is
66+
per line, in the format of ``KEY="Value"``, lines starting with `#` is
6767
ignored.
6868

6969
.. code:: shell
@@ -93,25 +93,25 @@ the ``.env`` file without manually opening it. The same cli installed on
9393
remote machine combined with fabric (discussed later) will enable you to
9494
update your settings on remote server, handy isn't it!
9595

96-
.. raw:: html
96+
::
9797

98-
<pre>
99-
$ dotenv
100-
Usage: dotenv [OPTIONS] COMMAND [ARGS]...
98+
Usage: dotenv [OPTIONS] COMMAND [ARGS]...
10199

102-
This script is used to set, get or unset values from a .env file.
100+
This script is used to set, get or unset values from a .env file.
103101

104-
Options:
105-
-f, --file PATH Location of the .env file, defaults to .env file in current
106-
working directory.
107-
--help Show this message and exit.
102+
Options:
103+
-f, --file PATH Location of the .env file, defaults to .env
104+
file in current working directory.
105+
-q, --quote [always|never|auto]
106+
Whether to quote or not the variable values.
107+
Default mode is always.
108+
--help Show this message and exit.
108109

109-
Commands:
110-
get Retrive the value for the given key.
111-
list Display all the stored key/value.
112-
set Store the given key/value.
113-
unset Removes the given key.
114-
</pre>
110+
Commands:
111+
get Retrive the value for the given key.
112+
list Display all the stored key/value.
113+
set Store the given key/value.
114+
unset Removes the given key.
115115

116116
Setting config on remote servers
117117
--------------------------------
@@ -194,9 +194,18 @@ All the contributions are welcome! Please open `an
194194
issue <https://github.com/theskumar/python-dotenv/issues/new>`__ or send
195195
us a pull request.
196196

197-
This project is currently maintained by `Saurabh Kumar <https://saurabh-kumar.com>`__ and
197+
This project is currently maintained by `Saurabh Kumar <https://saurabh-kumar.com>`__ and
198198
would not have been possible without the support of these `awesome people <https://github.com/theskumar/python-dotenv/graphs/contributors>`__.
199199

200+
Changelog
201+
=========
202+
203+
0.4.0
204+
-----
205+
- cli: Added `-q/--quote` option to control the behaviour of quotes around values in .env. (Thanks `@hugochinchilla`_).
206+
- Improved test coverage.
207+
208+
.. _@hugochinchilla: https://github.com/hugochinchilla
200209

201210
.. |Build Status| image:: https://travis-ci.org/theskumar/python-dotenv.svg?branch=master
202211
:target: https://travis-ci.org/theskumar/python-dotenv

0 commit comments

Comments
 (0)