Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: joke2k/django-environ
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v0.11.1
Choose a base ref
...
head repository: joke2k/django-environ
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: main
Choose a head ref

Commits on Aug 30, 2023

  1. Bump version

    sergeyklay committed Aug 30, 2023
    Copy the full SHA
    54daf88 View commit details

Commits on Sep 1, 2023

  1. Revert "Add variable expansion (fix #421)"

    This reverts commit c61bfb0.
    sergeyklay committed Sep 1, 2023
    Copy the full SHA
    b343e05 View commit details
  2. Update change log

    sergeyklay committed Sep 1, 2023
    Copy the full SHA
    55ff0e3 View commit details
  3. Copy the full SHA
    5561b35 View commit details
  4. Copy the full SHA
    928a654 View commit details
  5. Bump version

    sergeyklay committed Sep 1, 2023
    Copy the full SHA
    18423bd View commit details
  6. Revert "Add variable expansion (fix #421)"

    This reverts commit c61bfb0.
    sergeyklay committed Sep 1, 2023
    Copy the full SHA
    a2848cd View commit details
  7. Update change log

    sergeyklay committed Sep 1, 2023
    Copy the full SHA
    66888f1 View commit details
  8. Copy the full SHA
    b3ab191 View commit details
  9. Copy the full SHA
    df301b6 View commit details

Commits on Sep 6, 2023

  1. Bump actions/checkout from 3.6.0 to 4.0.0

    Bumps [actions/checkout](https://github.com/actions/checkout) from 3.6.0 to 4.0.0.
    - [Release notes](https://github.com/actions/checkout/releases)
    - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
    - [Commits](actions/checkout@v3.6.0...v4.0.0)
    
    ---
    updated-dependencies:
    - dependency-name: actions/checkout
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    dependabot[bot] authored and sergeyklay committed Sep 6, 2023
    Copy the full SHA
    7b5d7f9 View commit details

Commits on Sep 22, 2023

  1. Make inline comments handling optional and disabled by default

    Disabled inline comments handling (that was introduced in #475)
    by default due to potential side effects. While the feature itself is
    useful, the project's philosophy dictates that it should not be enabled
    by default for all users.
    
    This also fix the issue described in the #499.
    sergeyklay committed Sep 22, 2023
    Copy the full SHA
    e3e7fc9 View commit details

Commits on Oct 27, 2023

  1. Copy the full SHA
    b108444 View commit details
  2. Bump actions/checkout from 4.0.0 to 4.1.1

    Bumps [actions/checkout](https://github.com/actions/checkout) from 4.0.0 to 4.1.1.
    - [Release notes](https://github.com/actions/checkout/releases)
    - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
    - [Commits](actions/checkout@v4.0.0...v4.1.1)
    
    ---
    updated-dependencies:
    - dependency-name: actions/checkout
      dependency-type: direct:production
      update-type: version-update:semver-minor
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    dependabot[bot] authored and sergeyklay committed Oct 27, 2023
    Copy the full SHA
    de22b7e View commit details
  3. Bump actions/setup-python from 4.7.0 to 4.7.1

    Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4.7.0 to 4.7.1.
    - [Release notes](https://github.com/actions/setup-python/releases)
    - [Commits](actions/setup-python@v4.7.0...v4.7.1)
    
    ---
    updated-dependencies:
    - dependency-name: actions/setup-python
      dependency-type: direct:production
      update-type: version-update:semver-patch
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    dependabot[bot] authored and sergeyklay committed Oct 27, 2023
    Copy the full SHA
    46c035e View commit details

Commits on Oct 28, 2023

  1. Test on Django 5.0

    adamchainz authored and sergeyklay committed Oct 28, 2023
    2
    Copy the full SHA
    a1113e4 View commit details

Commits on Oct 25, 2024

  1. Bump github/codeql-action from 2 to 3

    Bumps [github/codeql-action](https://github.com/github/codeql-action) from 2 to 3.
    - [Release notes](https://github.com/github/codeql-action/releases)
    - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
    - [Commits](github/codeql-action@v2...v3)
    
    ---
    updated-dependencies:
    - dependency-name: github/codeql-action
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    dependabot[bot] authored and sergeyklay committed Oct 25, 2024
    Copy the full SHA
    7e9e32a View commit details
  2. Bump actions/setup-python from 4.7.1 to 5.0.0

    Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4.7.1 to 5.0.0.
    - [Release notes](https://github.com/actions/setup-python/releases)
    - [Commits](actions/setup-python@v4.7.1...v5.0.0)
    
    ---
    updated-dependencies:
    - dependency-name: actions/setup-python
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    dependabot[bot] authored and sergeyklay committed Oct 25, 2024
    Copy the full SHA
    bead9cc View commit details
  3. Copy the full SHA
    be3d746 View commit details
  4. Bump pypy version to 3.10

    sergeyklay committed Oct 25, 2024
    Copy the full SHA
    3a611db View commit details
  5. Copy the full SHA
    3af3921 View commit details
  6. Drop Django 1.x support

    sergeyklay committed Oct 25, 2024
    Copy the full SHA
    3a58838 View commit details
  7. Bump sphinx and furo

    sergeyklay committed Oct 25, 2024
    Copy the full SHA
    ac6c0d4 View commit details
  8. Copy the full SHA
    839b1f3 View commit details
  9. Copy the full SHA
    01cd8e0 View commit details
  10. Copy the full SHA
    6321605 View commit details
  11. Copy the full SHA
    04642ad View commit details
  12. Copy the full SHA
    7af0b84 View commit details
  13. Add support for Django 5.1

    sergeyklay committed Oct 25, 2024
    Copy the full SHA
    09ef21a View commit details
  14. Bump actions/upload-artifact from 3 to 4

    Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 3 to 4.
    - [Release notes](https://github.com/actions/upload-artifact/releases)
    - [Commits](actions/upload-artifact@v3...v4)
    
    ---
    updated-dependencies:
    - dependency-name: actions/upload-artifact
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    dependabot[bot] authored and sergeyklay committed Oct 25, 2024
    Copy the full SHA
    0ee9141 View commit details
  15. Copy the full SHA
    8968660 View commit details
  16. Bump version

    sergeyklay committed Oct 25, 2024
    Copy the full SHA
    023491a View commit details

Commits on Oct 29, 2024

  1. Bump actions/setup-python from 5.0.0 to 5.3.0

    Bumps [actions/setup-python](https://github.com/actions/setup-python) from 5.0.0 to 5.3.0.
    - [Release notes](https://github.com/actions/setup-python/releases)
    - [Commits](actions/setup-python@v5.0.0...v5.3.0)
    
    ---
    updated-dependencies:
    - dependency-name: actions/setup-python
      dependency-type: direct:production
      update-type: version-update:semver-minor
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    dependabot[bot] authored and sergeyklay committed Oct 29, 2024
    Copy the full SHA
    6c12976 View commit details
  2. Bump Vankka/pr-target-branch-action from 2 to 3

    Bumps [Vankka/pr-target-branch-action](https://github.com/vankka/pr-target-branch-action) from 2 to 3.
    - [Release notes](https://github.com/vankka/pr-target-branch-action/releases)
    - [Commits](Vankka/pr-target-branch-action@v2...v3)
    
    ---
    updated-dependencies:
    - dependency-name: Vankka/pr-target-branch-action
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    dependabot[bot] authored and sergeyklay committed Oct 29, 2024
    Copy the full SHA
    9fa66f2 View commit details
  3. Bump actions/checkout from 4.1.1 to 4.2.2

    Bumps [actions/checkout](https://github.com/actions/checkout) from 4.1.1 to 4.2.2.
    - [Release notes](https://github.com/actions/checkout/releases)
    - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
    - [Commits](actions/checkout@v4.1.1...v4.2.2)
    
    ---
    updated-dependencies:
    - dependency-name: actions/checkout
      dependency-type: direct:production
      update-type: version-update:semver-minor
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    dependabot[bot] authored and sergeyklay committed Oct 29, 2024
    Copy the full SHA
    f53b3f4 View commit details

Commits on Nov 3, 2024

  1. Add support for Django CockroachDB driver

    As per #509 adds support for Django CockroachDB
    stevewilliamsuk authored and sergeyklay committed Nov 3, 2024
    Copy the full SHA
    6f0a91b View commit details

Commits on Nov 4, 2024

  1. Update copyright notice

    sergeyklay committed Nov 4, 2024
    Copy the full SHA
    c8379ed View commit details
  2. Update change log

    sergeyklay committed Nov 4, 2024
    Copy the full SHA
    0f2e088 View commit details
  3. feat: Channels URL support

    lasuillard authored and sergeyklay committed Nov 4, 2024
    Copy the full SHA
    8729165 View commit details
  4. feat: Redis Pub/Sub

    lasuillard authored and sergeyklay committed Nov 4, 2024
    Copy the full SHA
    8b70d9f View commit details
  5. Copy the full SHA
    60164fd View commit details
  6. Update change log

    sergeyklay committed Nov 4, 2024
    Copy the full SHA
    d92e11b View commit details
  7. Copy the full SHA
    6abdb86 View commit details
  8. Correct code style

    sergeyklay committed Nov 4, 2024
    Copy the full SHA
    8e844ac View commit details

Commits on Nov 8, 2024

  1. Update change log

    sergeyklay committed Nov 8, 2024
    Copy the full SHA
    00c8203 View commit details
  2. Copy the full SHA
    993b36c View commit details

Commits on Jan 13, 2025

  1. Merge pull request #545 from joke2k/develop

    Release v0.12.0
    joke2k authored Jan 13, 2025
    Copy the full SHA
    176e812 View commit details
20 changes: 10 additions & 10 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -24,17 +24,17 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v3.6.0
uses: actions/checkout@v4.2.2

- name: Set up Python 3.10
uses: actions/setup-python@v4.7.0
- name: Set up Python 3.12
uses: actions/setup-python@v5.3.0
with:
python-version: '3.10'
python-version: '3.12'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install tox tox-gh-actions
pip install tox tox-gh-actions setuptools
- name: Check MANIFEST.in for completeness
run: tox -e manifest
@@ -44,7 +44,7 @@ jobs:

- name: Archive build artifacts
if: success()
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
# To ensure that jobs don't overwrite existing artifacts,
# use a different name per job.
@@ -64,12 +64,12 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v3.6.0
uses: actions/checkout@v4.2.2

- name: Set up Python 3.10
uses: actions/setup-python@v4.7.0
- name: Set up Python 3.12
uses: actions/setup-python@v5.3.0
with:
python-version: '3.10'
python-version: '3.12'

- name: Install in dev mode
run: python -m pip install -e .
2 changes: 1 addition & 1 deletion .github/workflows/change-pr-target.yml
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@ jobs:
check-branch:
runs-on: ubuntu-latest
steps:
- uses: Vankka/pr-target-branch-action@v2
- uses: Vankka/pr-target-branch-action@v3
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
21 changes: 6 additions & 15 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -47,38 +47,29 @@ jobs:

matrix:
python:
- '3.8'
- '3.9'
- '3.10'
- '3.11'
- 'pypy-3.7'
- '3.12'
- '3.13'
- 'pypy-3.10'
os: [ ubuntu-latest, macos-latest, windows-latest ]

# These versions are no longer supported by Python team, and may
# eventually be dropped from GitHub Actions. The support of these
# versions by django-environ will continue for as long as possible,
# and may be discontinued at any time.
include:
- python: '3.6'
os: ubuntu-20.04
- python: '3.7'
os: ubuntu-20.04

steps:
- name: Checkout code
uses: actions/checkout@v3.6.0
uses: actions/checkout@v4.2.2
with:
fetch-depth: 5

- name: Set up Python ${{ matrix.python }}
uses: actions/setup-python@v4.7.0
uses: actions/setup-python@v5.3.0
with:
python-version: ${{ matrix.python }}

- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install tox tox-gh-actions
python -m pip install tox tox-gh-actions setuptools
- name: Setuptools self-test
run: |
8 changes: 4 additions & 4 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -45,16 +45,16 @@ jobs:

steps:
- name: Checkout repository
uses: actions/checkout@v3.6.0
uses: actions/checkout@v4.2.2

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}

- name: Autobuild
uses: github/codeql-action/autobuild@v2
uses: github/codeql-action/autobuild@v3

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
uses: github/codeql-action/analyze@v3
10 changes: 5 additions & 5 deletions .github/workflows/cs.yml
Original file line number Diff line number Diff line change
@@ -25,17 +25,17 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v3.6.0
uses: actions/checkout@v4.2.2

- name: Set up Python 3.10
uses: actions/setup-python@v4.7.0
- name: Set up Python 3.12
uses: actions/setup-python@v5.3.0
with:
python-version: '3.10'
python-version: '3.12'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install tox tox-gh-actions
pip install tox tox-gh-actions setuptools
- name: Lint with tox
run: tox -e lint
12 changes: 6 additions & 6 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -26,17 +26,17 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v3.6.0
uses: actions/checkout@v4.2.2

- name: Set up Python 3.10
uses: actions/setup-python@v4.7.0
- name: Set up Python 3.12
uses: actions/setup-python@v5.3.0
with:
python-version: '3.10'
python-version: '3.12'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install tox tox-gh-actions
pip install tox tox-gh-actions setuptools
- name: Check external links in the package documentation
run: tox -e linkcheck
@@ -46,7 +46,7 @@ jobs:

- name: Archive docs artifacts
if: always()
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: docs
path: docs
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This file is part of the django-environ.
#
# Copyright (c) 2021, Serghei Iakovlev <egrep@protonmail.ch>
# Copyright (c) 2021-2024, Serghei Iakovlev <oss@serghei.pl>
# Copyright (c) 2013-2021, Daniele Faraglia <daniele.faraglia@gmail.com>
#
# For the full copyright and license information, please view
4 changes: 2 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This file is part of the django-environ.
#
# Copyright (c) 2021, Serghei Iakovlev <egrep@protonmail.ch>
# Copyright (c) 2021-2024, Serghei Iakovlev <oss@serghei.pl>
# Copyright (c) 2013-2021, Daniele Faraglia <daniele.faraglia@gmail.com>
#
# For the full copyright and license information, please view
@@ -17,7 +17,7 @@ build:
tools:
# Keep version in sync with tox.ini (testenv:docs) and
# docs.yml (GitHub Action Workflow).
python: '3.10'
python: '3.12'

python:
install:
45 changes: 44 additions & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -5,6 +5,47 @@ 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.12.0`_ - 8-November-2024
-----------------------------
Fixed
+++++
- Include prefix in the ``ImproperlyConfigured`` error message
`#513 <https://github.com/joke2k/django-environ/issues/513>`_.

Added
+++++
- Add support for Python 3.12 and 3.13
`#538 <https://github.com/joke2k/django-environ/issues/538>`_.
- Add support for Django 5.1
`#535 <https://github.com/joke2k/django-environ/issues/535>`_.
- Add support for Django CockroachDB driver
`#509 <https://github.com/joke2k/django-environ/issues/509>`_.
- Add support for Django Channels
`#266 <https://github.com/joke2k/django-environ/issues/266>`_.

Changed
+++++++
- Disabled inline comments handling by default due to potential side effects.
While the feature itself is useful, the project's philosophy dictates that
it should not be enabled by default for all users
`#499 <https://github.com/joke2k/django-environ/issues/499>`_.

Removed
+++++++
- Removed support of Python 3.6, 3.7 and 3.8
`#538 <https://github.com/joke2k/django-environ/issues/538>`_.
- Removed support of Django 1.x.
`#538 <https://github.com/joke2k/django-environ/issues/538>`_.


`v0.11.2`_ - 1-September-2023
-----------------------------
Fixed
+++++
- Revert "Add variable expansion." feature
due to `#490 <https://github.com/joke2k/django-environ/issues/490>`_.


`v0.11.1`_ - 30-August-2023
---------------------------
Fixed
@@ -23,7 +64,7 @@ Added
`#463 <https://github.com/joke2k/django-environ/pull/463>`_.
- Added variable expansion
`#468 <https://github.com/joke2k/django-environ/pull/468>`_.
- Added capability to handle comments after #, after quoted values,
- Added capability to handle comments after ``#``, after quoted values,
like ``KEY= 'part1 # part2' # comment``
`#475 <https://github.com/joke2k/django-environ/pull/475>`_.
- Added support for ``interpolate`` parameter
@@ -380,6 +421,8 @@ Added
- Initial release.


.. _v0.12.0: https://github.com/joke2k/django-environ/compare/v0.11.2...v0.12.0
.. _v0.11.2: https://github.com/joke2k/django-environ/compare/v0.11.1...v0.11.2
.. _v0.11.1: https://github.com/joke2k/django-environ/compare/v0.11.0...v0.11.1
.. _v0.11.0: https://github.com/joke2k/django-environ/compare/v0.10.0...v0.11.0
.. _v0.10.0: https://github.com/joke2k/django-environ/compare/v0.9.0...v0.10.0
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2021, Serghei Iakovlev <egrep@protonmail.ch>
Copyright (c) 2021-2024, Serghei Iakovlev <oss@serghei.pl>
Copyright (c) 2013-2021, Daniele Faraglia <daniele.faraglia@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This file is part of the django-environ.
#
# Copyright (c) 2021, Serghei Iakovlev <egrep@protonmail.ch>
# Copyright (c) 2021-2024, Serghei Iakovlev <oss@serghei.pl>
# Copyright (c) 2013-2021, Daniele Faraglia <daniele.faraglia@gmail.com>
#
# For the full copyright and license information, please view
7 changes: 4 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -97,7 +97,8 @@ approach, some connection strings are expressed as url, so this package can pars
it and return a ``urllib.parse.ParseResult``. These strings from ``os.environ``
are loaded from a ``.env`` file and filled in ``os.environ`` with ``setdefault``
method, to avoid to overwrite the real environ.
A similar approach is used in `Two Scoops of Django <https://www.feldroy.com/books/two-scoops-of-django-3-x>`_
A similar approach is used in
`Two Scoops of Django <https://web.archive.org/web/20240121133956/https://www.feldroy.com/books/two-scoops-of-django-3-x>`_
book and explained in `12factor-django <https://wellfire.co/learn/easier-12-factor-django>`_
article.

@@ -126,8 +127,8 @@ its documentation lives at `Read the Docs <https://django-environ.readthedocs.io
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.6+, and officially supports
Django 1.11, 2.2, 3.0, 3.1, 3.2, 4.0, 4.1 and 4.2.
It’s rigorously tested on Python 3.9+, and officially supports
Django 2.2, 3.0, 3.1, 3.2, 4.0, 4.1, 4.2, 5.0, and 5.1.

If you'd like to contribute to ``django-environ`` you're most welcome!

2 changes: 1 addition & 1 deletion SECURITY.rst
Original file line number Diff line number Diff line change
@@ -6,5 +6,5 @@ Reporting a Vulnerability
-------------------------

If you discover a security vulnerability within ``django-environ``, please
send an e-mail to Serghei Iakovlev via egrep@protonmail.ch. All security
send an e-mail to Serghei Iakovlev via oss@serghei.pl. All security
vulnerabilities will be promptly addressed.
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This file is part of the django-environ.
#
# Copyright (c) 2021-2022, Serghei Iakovlev <egrep@protonmail.ch>
# Copyright (c) 2021-2024, Serghei Iakovlev <oss@serghei.pl>
# Copyright (c) 2013-2021, Daniele Faraglia <daniele.faraglia@gmail.com>
#
# For the full copyright and license information, please view
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This file is part of the django-environ.
#
# Copyright (c) 2021-2023, Serghei Iakovlev <egrep@protonmail.ch>
# Copyright (c) 2021-2024, Serghei Iakovlev <oss@serghei.pl>
# Copyright (c) 2013-2021, Daniele Faraglia <daniele.faraglia@gmail.com>
#
# For the full copyright and license information, please view
2 changes: 1 addition & 1 deletion docs/docutils.conf
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This file is part of the django-environ.
#
# Copyright (c) 2021-2022, Serghei Iakovlev <egrep@protonmail.ch>
# Copyright (c) 2021-2024, Serghei Iakovlev <oss@serghei.pl>
# Copyright (c) 2013-2021, Daniele Faraglia <daniele.faraglia@gmail.com>
#
# For the full copyright and license information, please view
4 changes: 2 additions & 2 deletions docs/install.rst
Original file line number Diff line number Diff line change
@@ -6,8 +6,8 @@ Installation
Requirements
============

* `Django <https://www.djangoproject.com/>`_ >= 1.11
* `Python <https://www.python.org/>`_ >= 3.5
* `Django <https://www.djangoproject.com/>`_ >= 2.2
* `Python <https://www.python.org/>`_ >= 3.9

Installing django-environ
=========================
22 changes: 0 additions & 22 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
@@ -23,28 +23,6 @@ And use it with ``settings.py`` as follows:
:start-after: -code-begin-
:end-before: -overview-

Variables can contain references to another variables: ``$VAR`` or ``${VAR}``.
Referenced variables are searched in the environment and within all definitions
in the ``.env`` file. References are checked for recursion (self-reference).
Exception is thrown if any reference results in infinite loop on any level
of recursion. Variable values are substituted similar to shell parameter
expansion. Example:

.. code-block:: shell
# shell
export POSTGRES_USERNAME='user' POSTGRES_PASSWORD='SECRET'
.. code-block:: shell
# .env
POSTGRES_HOSTNAME='example.com'
POSTGRES_DB='database'
DATABASE_URL="postgres://${POSTGRES_USERNAME}:${POSTGRES_PASSWORD}@${POSTGRES_HOSTNAME}:5432/${POSTGRES_DB}"
The value of ``DATABASE_URL`` variable will become
``postgres://user:SECRET@example.com:5432/database``.

The ``.env`` file should be specific to the environment and not checked into
version control, it is best practice documenting the ``.env`` file with an example.
For example, you can also add ``.env.dist`` with a template of your variables to
Loading