Merge pull request #327 from joke2k/develop

v0.7.0

.github/workflows/docs.yml

@@ -33,5 +33,18 @@ jobs:
           python -m pip install --upgrade pip
           pip install tox tox-gh-actions
 
+      - name: Check external links in the package documentation
+        run: tox -e linkcheck
+
       - name: Build and test package documentation
         run: tox -e docs
+
+      - name: Archive docs artifacts
+        if: always()
+        uses: actions/upload-artifact@v2
+        with:
+          name: docs
+          path: docs
+          # Artifacts are retained for 90 days by default.
+          # In fact, we don't need such long period.
+          retention-days: 60

AUTHORS.rst

@@ -6,6 +6,9 @@ and currently maintained by `Serghei Iakovlev <https://github.com/sergeyklay/>`_
 
 A full list of contributors can be found in `GitHub <https://github.com/joke2k/django-environ/graphs/contributors>`__.
 
+Acknowledgments
+===============
+
 The existence of ``django-environ`` would have been impossible without these
 projects:
 

BACKERS.rst

@@ -9,9 +9,9 @@ Sponsors
 --------
 
 Support this project by becoming a sponsor. Your logo will show up here with a
-link to your website. `Became sponsor <https://opencollective.com/django-environ#sponsor>`_.
+link to your website. `Became sponsor <https://opencollective.com/django-environ/contribute/sponsors-3474/checkout>`_.
 
-|ocsponsor0| |ocsponsor1| |ocsponsor2|
+|ocsponsor0| |ocsponsor1|
 
 Backers
 -------
@@ -21,14 +21,11 @@ Thank you to all our backers!
 |ocbackerimage|
 
 .. |ocsponsor0| image:: https://opencollective.com/django-environ/sponsor/0/avatar.svg
-    :target: https://opencollective.com/django-environ/sponsor/0/website
-    :alt: Sponsor
-.. |ocsponsor1| image:: https://opencollective.com/django-environ/sponsor/1/avatar.svg
-    :target: https://opencollective.com/django-environ/sponsor/1/website
-    :alt: Sponsor
-.. |ocsponsor2| image:: https://opencollective.com/django-environ/sponsor/2/avatar.svg
-    :target: https://opencollective.com/django-environ/sponsor/2/website
+    :target: https://triplebyte.com/
     :alt: Sponsor
+.. |ocsponsor1| image:: https://images.opencollective.com/static/images/become_sponsor.svg
+    :target: https://opencollective.com/django-environ/contribute/sponsors-3474/checkout
+    :alt: Become a Sponsor
 .. |ocbackerimage| image:: https://opencollective.com/django-environ/backers.svg?width=890
     :target: https://opencollective.com/django-environ
     :alt: Backers on Open Collective

CHANGELOG.rst

@@ -1,197 +1,232 @@
 Changelog
 =========
+
 All notable changes to this project will be documented in this file.
+The format is inspired by `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>`_.
+
+`v0.7.0`_ - 11-September-2021
+------------------------------
+Added
++++++
+- Added support for negative float strings
+  `#160 <https://github.com/joke2k/django-environ/issues/160>`_.
+- Added Elasticsearch5 to search scheme
+  `#297 <https://github.com/joke2k/django-environ/pull/297>`_.
+- Added Elasticsearch7 to search scheme
+  `#314 <https://github.com/joke2k/django-environ/issues/314>`_.
+- Added the ability to use ``bytes`` or ``str`` as a default value for ``Env.bytes()``.
+
+Fixed
++++++
+- Fixed links in the documentation.
+- Use default option in ``Env.bytes()``
+  `#206 <https://github.com/joke2k/django-environ/pull/206>`_.
+- Safely evaluate a string containing an invalid Python literal
+  `#200 <https://github.com/joke2k/django-environ/issues/200>`_.
+
+Changed
++++++++
+- Added 'Funding' and 'Say Thanks!' project urls on pypi.
+- Stop raising ``UserWarning`` if ``.env`` file isn't found. Log a message with
+  ``INFO`` log level instead `#243 <https://github.com/joke2k/django-environ/issues/243>`_.
 
-The format is *inspired* by `Keep a Changelog <http://keepachangelog.com/en/1.0.0/>`_
-and this project adheres to `Semantic Versioning <http://semver.org/spec/v2.0.0.html>`_.
 
 `v0.6.0`_ - 4-September-2021
 ----------------------------
 Added
 +++++
-  - Python 3.9, 3.10 and pypy 3.7 are now supported
-  - Django 3.1 and 3.2 are now supported
-  - Added missed classifiers to ``setup.py``
-  - Accept Python 3.6 path-like objects for ``read_env``
+- Python 3.9, 3.10 and pypy 3.7 are now supported.
+- Django 3.1 and 3.2 are now supported.
+- Added missed classifiers to ``setup.py``.
+- Accept Python 3.6 path-like objects for ``read_env``
+  `#106 <https://github.com/joke2k/django-environ/issues/106>`_,
+  `#286 <https://github.com/joke2k/django-environ/issues/286>`_.
 
 Fixed
 +++++
-  - Fixed various code linting errors
-  - Fixed typos in the documentation
-  - Added missed files to the package contents
-  - Fixed ``db_url_config`` to work the same for all postgres-like schemes
+- Fixed various code linting errors.
+- Fixed typos in the documentation.
+- Added missed files to the package contents.
+- Fixed ``db_url_config`` to work the same for all postgres-like schemes
+  `#264 <https://github.com/joke2k/django-environ/issues/264>`_,
+  `#268 <https://github.com/joke2k/django-environ/issues/268>`_.
 
 Changed
 +++++++
-  - Refactor tests to use pytest and follow DRY
-  - Moved CI to GitHub Actions
-  - Restructuring of project documentation
-  - Build and test package documentation as a part of CI pipeline
-  - Build and test package distribution as a part of CI pipeline
-  - Check ``MANIFEST.in`` in a source package for completeness as a part of CI pipeline
-  - Added ``pytest`` and ``coverage[toml]`` to setuptools' ``extras_require``
+- Refactor tests to use pytest and follow DRY.
+- Moved CI to GitHub Actions.
+- Restructuring of project documentation.
+- Build and test package documentation as a part of CI pipeline.
+- Build and test package distribution as a part of CI pipeline.
+- Check ``MANIFEST.in`` in a source package for completeness as a part of CI
+  pipeline.
+- Added ``pytest`` and ``coverage[toml]`` to setuptools' ``extras_require``.
 
 
 `v0.5.0`_ - 30-August-2021
 --------------------------
 Added
 +++++
-  - Support for Django 2.1 & 2.2
-  - Added tox.ini targets
-  - Added secure redis backend URLs via ``rediss://``
-  - Add ``cast=str`` to ``str()`` method
+- Support for Django 2.1 & 2.2.
+- Added tox.ini targets.
+- Added secure redis backend URLs via ``rediss://``.
+- Add ``cast=str`` to ``str()`` method.
 
 Fixed
 +++++
-  - Fixed misspelling in the documentation
+- Fixed misspelling in the documentation.
 
 Changed
 +++++++
-  - Validate empty cache url and invalid cache schema
-  - Set ``long_description_content_type`` in setup
-  - Improved Django 1.11 database configuration support
+- Validate empty cache url and invalid cache schema.
+- Set ``long_description_content_type`` in setup.
+- Improved Django 1.11 database configuration support.
 
 
 `v0.4.5`_ - 25-June-2018
 ------------------------
 Added
 +++++
-  - Support for Django 2.0
-  - Support for smart casting
-  - Support PostgreSQL unix domain socket paths
-  - Tip: Multiple env files
+- Support for Django 2.0.
+- Support for smart casting.
+- Support PostgreSQL unix domain socket paths.
+- Tip: Multiple env files.
 
 Changed
 +++++++
-  - Fix parsing option values ``None``, ``True`` and ``False``
-  - Order of importance of engine configuration in ``db_url_config``
+- Fix parsing option values ``None``, ``True`` and ``False``.
+- Order of importance of engine configuration in ``db_url_config``.
 
 Removed
 +++++++
-  - Remove ``django`` and ``six`` dependencies
+- Remove ``django`` and ``six`` dependencies.
 
 
 `v0.4.4`_ - 21-August-2017
 --------------------------
 
 Added
 +++++
-  - Support for ``django-redis`` multiple locations (master/slave, shards)
-  - Support for Elasticsearch2
-  - Support for Mysql-connector
-  - Support for ``pyodbc``
-  - Add ``__contains__`` feature to Environ class
+- Support for ``django-redis`` multiple locations (master/slave, shards).
+- Support for Elasticsearch2.
+- Support for Mysql-connector.
+- Support for ``pyodbc``.
+- Add ``__contains__`` feature to Environ class.
 
 Fixed
 +++++
-  - Fix Path subtracting
+- Fix Path subtracting.
 
 
 `v0.4.3`_ - 21-August-2017
 --------------------------
 Changed
 +++++++
-  - Rollback the default Environ to ``os.environ``
+- Rollback the default Environ to ``os.environ``.
 
 `v0.4.2`_ - 13-April-2017
 -------------------------
 Added
 +++++
-  - Confirm support for Django 1.11.
-  - Support for Redshift database URL
+- Confirm support for Django 1.11.
+- Support for Redshift database URL.
 
 Changed
 +++++++
-  - Fix uwsgi settings reload problem (#55)
-  - Update support for ``django-redis`` urls (#109)
+- Fix uwsgi settings reload problem
+  `#55 <https://github.com/joke2k/django-environ/issues/55>`_.
+- Update support for ``django-redis`` urls
+  `#109 <https://github.com/joke2k/django-environ/pull/109>`_.
 
 `v0.4.1`_ - 13-November-2016
 ----------------------------
 Added
 +++++
-  - Add support for Django 1.10
+- Add support for Django 1.10.
 
 Changed
 +++++++
-  - Fix for unsafe characters into URLs
-  - Clarifying warning on missing or unreadable file. Thanks to @nickcatal
-  - Fix support for Oracle urls
-  - Fix support for ``django-redis``
+- Fix for unsafe characters into URLs.
+- Clarifying warning on missing or unreadable file.
+  Thanks to `@nickcatal <https://github.com/nickcatal>`_.
+- Fix support for Oracle urls.
+- Fix support for ``django-redis``.
 
 `v0.4`_ - 23-September-2015
 ---------------------------
 Added
 +++++
-  - New email schemes - ``smtp+ssl`` and ``smtp+tls`` (``smtps`` would be deprecated)
-  - Add tuple support. Thanks to @anonymouzz
-  - Add LDAP url support for database. Thanks to ``django-ldapdb``
+- New email schemes - ``smtp+ssl`` and ``smtp+tls`` (``smtps`` would be deprecated).
+- Add tuple support. Thanks to `@anonymouzz <https://github.com/anonymouzz>`_.
+- Add LDAP url support for database. Thanks to
+  `django-ldapdb/django-ldapdb <https://github.com/django-ldapdb/django-ldapdb>`_.
 
 Changed
 +++++++
-  - Fix non-ascii values (broken in Python 2.x)
-  - ``redis_cache`` replaced by ``django_redis``
-  - Fix psql/pgsql url
+- Fix non-ascii values (broken in Python 2.x).
+- ``redis_cache`` replaced by ``django_redis``.
+- Fix psql/pgsql url.
 
 
 `v0.3.1`_ - 19 Sep 2015
 -----------------------
 Added
 +++++
-  - Added ``email`` as alias for ``email_url``
-  - Django 1.7 is now supported
-  - Added LDAP scheme support for ``db_url_config``
+- Added ``email`` as alias for ``email_url``.
+- Django 1.7 is now supported.
+- Added LDAP scheme support for ``db_url_config``.
 
 Fixed
 +++++
-  - Fixed typos in the documentation
-  - Fixed ``environ.Path.__add__`` to correctly handle plus operator
-  - Fixed ``environ.Path.__contains__`` to correctly work on Windows
+- Fixed typos in the documentation.
+- Fixed ``environ.Path.__add__`` to correctly handle plus operator.
+- Fixed ``environ.Path.__contains__`` to correctly work on Windows.
 
 
 `v0.3`_ - 03-June-2014
 ----------------------
 Added
 +++++
-  - Add cache url support
-  - Add email url support
-  - Add search url support
+- Add cache url support.
+- Add email url support.
+- Add search url support.
 
 Changed
 +++++++
-  - Rewriting README.rst
+- Rewriting README.rst.
 
-v0.2.1 19-April-2013
---------------------
+v0.2.1 - 19-April-2013
+----------------------
 Changed
 +++++++
-  - ``Env.__call__`` now uses ``Env.get_value`` instance method
+- ``Env.__call__`` now uses ``Env.get_value`` instance method.
 
-v0.2 16-April-2013
-------------------
+v0.2 - 16-April-2013
+--------------------
 Added
 +++++
-  - Add advanced float parsing (comma and dot symbols to separate thousands and decimals)
+- Add advanced float parsing (comma and dot symbols to separate thousands and decimals).
 
 Fixed
 +++++
-  - Fixed typos in the documentation
+- Fixed typos in the documentation.
 
-v0.1 2-April-2013
------------------
+v0.1 - 2-April-2013
+-------------------
 Added
 +++++
-  - Initial release
+- Initial release.
 
 
+.. _v0.7.0: https://github.com/joke2k/django-environ/compare/v0.6.0...v0.7.0
 .. _v0.6.0: https://github.com/joke2k/django-environ/compare/v0.5.0...v0.6.0
 .. _v0.5.0: https://github.com/joke2k/django-environ/compare/v0.4.5...v0.5.0
 .. _v0.4.5: https://github.com/joke2k/django-environ/compare/v0.4.4...v0.4.5
 .. _v0.4.4: https://github.com/joke2k/django-environ/compare/v0.4.3...v0.4.4
 .. _v0.4.3: https://github.com/joke2k/django-environ/compare/v0.4.2...v0.4.3
 .. _v0.4.2: https://github.com/joke2k/django-environ/compare/v0.4.1...v0.4.2
-.. _v0.4.1: https://github.com/joke2k/django-environ/compare/v0.4.0...v0.4.1
+.. _v0.4.1: https://github.com/joke2k/django-environ/compare/v0.4...v0.4.1
 .. _v0.4: https://github.com/joke2k/django-environ/compare/v0.3.1...v0.4
 .. _v0.3.1: https://github.com/joke2k/django-environ/compare/v0.3...v0.3.1
 .. _v0.3: https://github.com/joke2k/django-environ/compare/v0.2.1...v0.3
-.. _`Keep a Changelog`: http://keepachangelog.com/en/1.0.0/
-.. _`Semantic Versioning`: http://semver.org/spec/v2.0.0.html