Merge pull request #394 from joke2k/develop

Release v0.9.0

Author: sergeyklay

.github/workflows/build.yml

@@ -27,17 +27,17 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2.3.5
+        uses: actions/checkout@v3.0.2
 
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2.2.2
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4.0.0
         with:
-          python-version: '3.9'
+          python-version: '3.10'
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip --use-feature=in-tree-build install tox tox-gh-actions
+          pip install tox tox-gh-actions
 
       - name: Check MANIFEST.in for completeness
         run: tox -e manifest
@@ -47,7 +47,7 @@ jobs:
 
       - name: Archive build artifacts
         if: success()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           # To ensure that jobs don't overwrite existing artifacts,
           # use a different name per job.
@@ -67,12 +67,12 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2.3.5
+        uses: actions/checkout@v3.0.2
 
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2.2.2
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4.0.0
         with:
-          python-version: '3.9'
+          python-version: '3.10'
 
       - name: Install in dev mode
         run: python -m pip install -e .

.github/workflows/ci.yml

@@ -51,18 +51,18 @@ jobs:
           - '3.7'
           - '3.8'
           - '3.9'
-          - '3.10.0-beta - 3.10'
+          - '3.10'
           - 'pypy-3.7'
         os: [ ubuntu-latest, macos-latest, windows-latest ]
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2.3.5
+        uses: actions/checkout@v3.0.2
         with:
           fetch-depth: 5
 
       - name: Set up Python ${{ matrix.python }}
-        uses: actions/setup-python@v2.2.2
+        uses: actions/setup-python@v4.0.0
         with:
           python-version: ${{ matrix.python }}
 

.github/workflows/cs.yml

@@ -21,12 +21,12 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2.3.5
+        uses: actions/checkout@v3.0.2
 
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2.2.2
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4.0.0
         with:
-          python-version: '3.9'
+          python-version: '3.10'
 
       - name: Install dependencies
         run: |

.github/workflows/docs.yml

@@ -21,12 +21,12 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2.3.5
+        uses: actions/checkout@v3.0.2
 
-      - name: Set up Python 3.8
-        uses: actions/setup-python@v2.2.2
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4.0.0
         with:
-          python-version: '3.8'
+          python-version: '3.10'
 
       - name: Install dependencies
         run: |
@@ -41,7 +41,7 @@ jobs:
 
       - name: Archive docs artifacts
         if: always()
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: docs
           path: docs

.readthedocs.yml

@@ -6,13 +6,20 @@
 # For the full copyright and license information, please view
 # the LICENSE.txt file that was distributed with this source code.
 
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
 ---
 version: 2
-python:
-  # Keep version in sync with tox.ini (testenv:docs) and
-  # docs.yml (GitHub Action Workflow).
-  version: '3.8'
 
+build:
+  os: ubuntu-20.04
+  tools:
+    # Keep version in sync with tox.ini (testenv:docs) and
+    # docs.yml (GitHub Action Workflow).
+    python: '3.10'
+
+python:
   install:
     - method: pip
       path: .

AUTHORS.rst

@@ -13,7 +13,7 @@ The existence of ``django-environ`` would have been impossible without these
 projects:
 
 - `rconradharris/envparse <https://github.com/rconradharris/envparse>`_
-- `jacobian/dj-database-url <https://github.com/jacobian/dj-database-url>`_
+- `jazzband/dj-database-url <https://github.com/jazzband/dj-database-url>`_
 - `migonzalvar/dj-email-url <https://github.com/migonzalvar/dj-email-url>`_
 - `ghickman/django-cache-url <https://github.com/ghickman/django-cache-url>`_
 - `dstufft/dj-search-url <https://github.com/dstufft/dj-search-url>`_

CHANGELOG.rst

@@ -5,8 +5,44 @@ 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.8.1`_ - 20-October-2021
+`v0.9.0`_ - 15-June-2022
+------------------------------
+Added
++++++
+- Added support for Postgresql cluster URI
+  `#355 <https://github.com/joke2k/django-environ/pull/355>`_.
+- Added support for Django 4.0
+  `#371 <https://github.com/joke2k/django-environ/issues/371>`_.
+- Added support for prefixed variables
+  `#362 <https://github.com/joke2k/django-environ/issues/362>`_.
+- Amended documentation.
+
+
+Deprecated
+++++++++++
+- ``Env.unicode()`` is deprecated and will be removed in the next
+  major release. Use ``Env.str()`` instead.
+
+
+Changed
++++++++
+- Attach cause to ``ImproperlyConfigured`` exception
+  `#360 <https://github.com/joke2k/django-environ/issues/360>`_.
+
 
+Fixed
++++++
+- Fixed ``_cast_urlstr`` unquoting
+  `#357 <https://github.com/joke2k/django-environ/issues/357>`_.
+- Fixed documentation regarding unsafe characters in URLs
+  `#220 <https://github.com/joke2k/django-environ/issues/220>`_.
+- Fixed ``environ.Path.__eq__()`` to compare paths correctly
+  `#86 <https://github.com/joke2k/django-environ/issues/86>`_,
+  `#197 <https://github.com/joke2k/django-environ/issues/197>`_.
+
+
+`v0.8.1`_ - 20-October-2021
+---------------------------
 Fixed
 +++++
 - Fixed "Invalid line" spam logs on blank lines in env file
@@ -16,7 +52,7 @@ Fixed
 
 
 `v0.8.0`_ - 17-October-2021
-------------------------------
+---------------------------
 Added
 +++++
 - Log invalid lines when parse .env file
@@ -108,7 +144,7 @@ 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.
+- Added ``cast=str`` to ``str()`` method.
 
 Fixed
 +++++
@@ -149,7 +185,7 @@ Added
 - Support for Elasticsearch2.
 - Support for Mysql-connector.
 - Support for ``pyodbc``.
-- Add ``__contains__`` feature to Environ class.
+- Added ``__contains__`` feature to Environ class.
 
 Fixed
 +++++
@@ -171,7 +207,7 @@ Added
 
 Changed
 +++++++
-- Fix uwsgi settings reload problem
+- Fixed 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>`_.
@@ -184,26 +220,26 @@ Added
 
 Changed
 +++++++
-- Fix for unsafe characters into URLs.
+- Fixed 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``.
+- Fixed support for Oracle urls.
+- Fixed 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 <https://github.com/anonymouzz>`_.
-- Add LDAP url support for database. Thanks to
+- Added tuple support. Thanks to `@anonymouzz <https://github.com/anonymouzz>`_.
+- Added 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).
+- Fixed non-ascii values (broken in Python 2.x).
 - ``redis_cache`` replaced by ``django_redis``.
-- Fix psql/pgsql url.
+- Fixed psql/pgsql url.
 
 
 `v0.3.1`_ - 19 Sep 2015
@@ -225,9 +261,9 @@ Fixed
 ----------------------
 Added
 +++++
-- Add cache url support.
-- Add email url support.
-- Add search url support.
+- Added cache url support.
+- Added email url support.
+- Added search url support.
 
 Changed
 +++++++
@@ -243,7 +279,7 @@ v0.2 - 16-April-2013
 --------------------
 Added
 +++++
-- Add advanced float parsing (comma and dot symbols to separate thousands and decimals).
+- Added advanced float parsing (comma and dot symbols to separate thousands and decimals).
 
 Fixed
 +++++
@@ -256,6 +292,7 @@ Added
 - Initial release.
 
 
+.. _v0.9.0: https://github.com/joke2k/django-environ/compare/v0.8.1...v0.9.0
 .. _v0.8.1: https://github.com/joke2k/django-environ/compare/v0.8.0...v0.8.1
 .. _v0.8.0: https://github.com/joke2k/django-environ/compare/v0.7.0...v0.8.0
 .. _v0.7.0: https://github.com/joke2k/django-environ/compare/v0.6.0...v0.7.0

README.rst

@@ -104,8 +104,8 @@ article.
 
 Using ``django-environ`` you can stop to make a lot of unversioned
 ``settings_*.py`` to configure your app.
-See `cookiecutter-django <https://github.com/pydanny/cookiecutter-django>`_ for
-a concrete example on using with a django project.
+See `cookiecutter-django <https://github.com/cookiecutter/cookiecutter-django>`_
+for a concrete example on using with a django project.
 
 **Feature Support**
 
@@ -127,7 +127,7 @@ the code on `GitHub <https://github.com/joke2k/django-environ>`_,
 and the latest release on `PyPI <https://pypi.org/project/django-environ/>`_.
 
 It’s rigorously tested on Python 3.5+, and officially supports
-Django 1.11, 2.2, 3.0, 3.1 and 3.2.
+Django 1.11, 2.2, 3.0, 3.1, 3.2 and 4.0.
 
 If you'd like to contribute to ``django-environ`` you're most welcome!
 

docs/Makefile

@@ -1,6 +1,6 @@
 # This file is part of the django-environ.
 #
-# Copyright (c) 2021, Serghei Iakovlev <[email protected]>
+# Copyright (c) 2021-2022, Serghei Iakovlev <[email protected]>
 # Copyright (c) 2013-2021, Daniele Faraglia <[email protected]>
 #
 # For the full copyright and license information, please view

docs/api.rst

@@ -0,0 +1,46 @@
+=============
+API Reference
+=============
+
+.. currentmodule:: environ
+
+
+The ``__init__`` module
+=======================
+
+.. automodule:: environ
+    :members:
+    :special-members:
+    :no-undoc-members:
+
+
+The ``compat`` module
+======================
+
+.. automodule:: environ.compat
+    :members:
+    :no-undoc-members:
+
+
+The ``environ`` module
+======================
+
+.. autoclass:: environ.Env
+    :members:
+    :no-undoc-members:
+
+.. autoclass:: environ.FileAwareEnv
+    :members:
+    :no-undoc-members:
+
+.. autoclass:: environ.Path
+    :members:
+    :no-undoc-members:
+
+
+The ``fileaware_mapping`` module
+================================
+
+.. autoclass:: environ.fileaware_mapping.FileAwareMapping
+    :members:
+    :no-undoc-members: