upgrade python-dotenv (1.0.1-1) unstable

CHANGELOG.md

@@ -5,14 +5,95 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this
 project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.1] - 2024-01-23
+
+**Fixed**
+
+* Gracefully handle code which has been imported from a zipfile ([#456] by [@samwyma])
+* Allow modules using load_dotenv to be reloaded when launched in a separate thread ([#497] by [@freddyaboulton])
+* Fix file not closed after deletion, handle error in the rewrite function ([#469] by [@Qwerty-133])
+
+**Misc**
+* Use pathlib.Path in tests ([#466] by [@eumiro])
+* Fix year in release date in changelog.md ([#454] by [@jankislinger])
+* Use https in README links ([#474] by [@Nicals])
+
+## [1.0.0] - 2023-02-24
+
+**Fixed**
+
+* Drop support for python 3.7, add python 3.12-dev (#449 by [@theskumar])
+* Handle situations where the cwd does not exist. (#446 by [@jctanner])
+
+## [0.21.1] - 2023-01-21
+
+**Added**
+
+* Use Python 3.11 non-beta in CI (#438 by [@bbc2])
+* Modernize variables code (#434 by [@Nougat-Waffle])
+* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])
+* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])
+* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])
+* Updated License to align with BSD OSI template (#433 by [@lsmith77])
+
+
+**Fixed**
+
+* Fix Out-of-scope error when "dest" variable is undefined (#413 by [@theGOTOguy])
+* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])
+* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])
+
+## [0.21.0] - 2022-09-03
+
+**Added**
+
+* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])
+* `load_dotenv` function now returns `False`. (#388 by [@larsks])
+* CLI: add --format= option to list command. (#407 by [@sammck])
+
+**Fixed**
+
+* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])
+* Use `open` instead of `io.open`. (#389 by [@rabinadk1])
+* Improve documentation for variables without a value (#390 by [@bbc2])
+* Add `parse_it` to Related Projects (#410 by [@naorlivne])
+* Update README.md (#415 by [@harveer07])
+* Improve documentation with direct use of MkDocs (#398 by [@bbc2])
+
+## [0.20.0] - 2022-03-24
+
+**Added**
+
+- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.
+  (#379 by [@bbc2])
+
+**Fixed**
+
+- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by
+  [@mgorny]).
+- Don't build universal wheels (#387 by [@bbc2]).
+
+## [0.19.2] - 2021-11-11
+
+**Fixed**
+
+- In `set_key`, add missing newline character before new entry if necessary. (#361 by
+  [@bbc2])
+
+## [0.19.1] - 2021-08-09
+
+**Added**
+
+- Add support for Python 3.10. (#359 by [@theskumar])
+
 ## [0.19.0] - 2021-07-24
 
-### Changed
+**Changed**
 
 - Require Python 3.5 or a later version.  Python 2 and 3.4 are no longer supported. (#341
   by [@bbc2]).
 
-### Added
+**Added**
 
 - The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,
   os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).
@@ -22,7 +103,7 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [0.18.0] - 2021-06-20
 
-### Changed
+**Changed**
 
 - Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in
   `set_key` (#330 by [@bbc2]).
@@ -35,41 +116,41 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [0.17.1] - 2021-04-29
 
-### Fixed
+**Fixed**
 
 - Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).
 
 ## [0.17.0] - 2021-04-02
 
-### Changed
+**Changed**
 
 - Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).
 
-### Added
+**Added**
 
 - Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).
 
 ## [0.16.0] - 2021-03-27
 
-### Changed
+**Changed**
 
 - The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is
   now `"utf-8"` instead of `None` (#306 by [@bbc2]).
 - Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).
 
 ## [0.15.0] - 2020-10-28
 
-### Added
+**Added**
 
 - Add `--export` option to `set` to make it prepend the binding with `export` (#270 by
   [@jadutter]).
 
-### Changed
+**Changed**
 
 - Make `set` command create the `.env` file in the current directory if no `.env` file was
   found (#270 by [@jadutter]).
 
-### Fixed
+**Fixed**
 
 - Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).
 - Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).
@@ -78,54 +159,54 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [0.14.0] - 2020-07-03
 
-### Changed
+**Changed**
 
 - Privilege definition in file over the environment in variable expansion (#256 by
   [@elbehery95]).
 
-### Fixed
+**Fixed**
 
 - Improve error message for when file isn't found (#245 by [@snobu]).
 - Use HTTPS URL in package meta data (#251 by [@ekohl]).
 
 ## [0.13.0] - 2020-04-16
 
-### Added
+**Added**
 
 - Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).
 
 ## [0.12.0] - 2020-02-28
 
-### Changed
+**Changed**
 
 - Use current working directory to find `.env` when bundled by PyInstaller (#213 by
   [@gergelyk]).
 
-### Fixed
+**Fixed**
 
 - Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).
 - Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).
 - Remove warning when last line is empty (#238 by [@bbc2]).
 
 ## [0.11.0] - 2020-02-07
 
-### Added
+**Added**
 
 - Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation
   (#232 by [@ulyssessouza]).
 
-### Changed
+**Changed**
 
 - Use logging instead of warnings (#231 by [@bbc2]).
 
-### Fixed
+**Fixed**
 
 - Fix installation in non-UTF-8 environments (#225 by [@altendky]).
 - Fix PyPI classifiers (#228 by [@bbc2]).
 
 ## [0.10.5] - 2020-01-19
 
-### Fixed
+**Fixed**
 
 - Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):
   - Don't print warning when key has no value.
@@ -134,7 +215,7 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [0.10.4] - 2020-01-17
 
-### Added
+**Added**
 
 - Make typing optional (#179 by [@techalchemy]).
 - Print a warning on malformed line (#211 by [@bbc2]).
@@ -221,13 +302,13 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 ## 0.6.2
 
 -   Fix dotenv list command ([@ticosax](https://github.com/ticosax))
--   Add iPython Suport
+-   Add iPython Support
     ([@tillahoffmann](https://github.com/tillahoffmann))
 
 ## 0.6.0
 
 -   Drop support for Python 2.6
--   Handle escaped charaters and newlines in quoted values. (Thanks
+-   Handle escaped characters and newlines in quoted values. (Thanks
     [@iameugenejo](https://github.com/iameugenejo))
 -   Remove any spaces around unquoted key/value. (Thanks
     [@paulochf](https://github.com/paulochf))
@@ -259,33 +340,65 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 [#172]: https://github.com/theskumar/python-dotenv/issues/172
 [#176]: https://github.com/theskumar/python-dotenv/issues/176
 [#183]: https://github.com/theskumar/python-dotenv/issues/183
+[#359]: https://github.com/theskumar/python-dotenv/issues/359
+[#469]: https://github.com/theskumar/python-dotenv/issues/469
+[#456]: https://github.com/theskumar/python-dotenv/issues/456
+[#466]: https://github.com/theskumar/python-dotenv/issues/466
+[#454]: https://github.com/theskumar/python-dotenv/issues/454
+[#474]: https://github.com/theskumar/python-dotenv/issues/474
 
-[@Flimm]: https://github.com/Flimm
 [@alanjds]: https://github.com/alanjds
 [@altendky]: https://github.com/altendky
 [@andrewsmith]: https://github.com/andrewsmith
 [@asyncee]: https://github.com/asyncee
 [@bbc2]: https://github.com/bbc2
 [@befeleme]: https://github.com/befeleme
 [@cjauvin]: https://github.com/cjauvin
+[@eaf]: https://github.com/eaf
 [@earlbread]: https://github.com/earlbread
+[@eggplants]: https://github.com/@eggplants
 [@ekohl]: https://github.com/ekohl
 [@elbehery95]: https://github.com/elbehery95
+[@eumiro]: https://github.com/eumiro
+[@Flimm]: https://github.com/Flimm
+[@freddyaboulton]: https://github.com/freddyaboulton
 [@gergelyk]: https://github.com/gergelyk
 [@gongqingkui]: https://github.com/gongqingkui
 [@greyli]: https://github.com/greyli
+[@harveer07]: https://github.com/@harveer07
 [@jadutter]: https://github.com/jadutter
+[@jankislinger]: https://github.com/jankislinger
+[@jctanner]: https://github.com/jctanner
+[@larsks]: https://github.com/@larsks
+[@lsmith77]: https://github.com/lsmith77
+[@mgorny]: https://github.com/mgorny
+[@naorlivne]: https://github.com/@naorlivne
+[@Nicals]: https://github.com/Nicals
+[@Nougat-Waffle]: https://github.com/Nougat-Waffle
 [@qnighy]: https://github.com/qnighy
+[@Qwerty-133]: https://github.com/Qwerty-133
+[@rabinadk1]: https://github.com/@rabinadk1
+[@sammck]: https://github.com/@sammck
+[@samwyma]: https://github.com/samwyma
 [@snobu]: https://github.com/snobu
 [@techalchemy]: https://github.com/techalchemy
+[@theGOTOguy]: https://github.com/theGOTOguy
 [@theskumar]: https://github.com/theskumar
 [@ulyssessouza]: https://github.com/ulyssessouza
 [@venthur]: https://github.com/venthur
 [@x-yuri]: https://github.com/x-yuri
 [@yannham]: https://github.com/yannham
 [@zueve]: https://github.com/zueve
 
-[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...HEAD
+
+[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v1.0.1...HEAD
+[1.0.1]: https://github.com/theskumar/python-dotenv/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v1.0.0
+[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1
+[0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0
+[0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0
+[0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2
+[0.19.1]: https://github.com/theskumar/python-dotenv/compare/v0.19.0...v0.19.1
 [0.19.0]: https://github.com/theskumar/python-dotenv/compare/v0.18.0...v0.19.0
 [0.18.0]: https://github.com/theskumar/python-dotenv/compare/v0.17.1...v0.18.0
 [0.17.1]: https://github.com/theskumar/python-dotenv/compare/v0.17.0...v0.17.1

CONTRIBUTING.md

@@ -16,3 +16,14 @@ or with [tox](https://pypi.org/project/tox/) installed:
 
     $ tox
 
+
+Documentation is published with [mkdocs]():
+
+```shell
+$ pip install -r requirements-docs.txt
+$ pip install -e .
+$ mkdocs serve
+```
+
+Open http://127.0.0.1:8000/ to view the documentation locally.
+