Skip to content

Commit

Permalink
Merge pull request #545 from joke2k/develop
Browse files Browse the repository at this point in the history
Release v0.12.0
joke2k authored Jan 13, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
2 parents df301b6 + 993b36c commit 176e812
Showing 39 changed files with 393 additions and 121 deletions.
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:
40 changes: 37 additions & 3 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -5,8 +5,41 @@ 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
@@ -31,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
@@ -388,6 +421,7 @@ 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
@@ -405,4 +439,4 @@ Added
.. _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
.. _v0.3: https://github.com/joke2k/django-environ/compare/v0.2.1...v0.3
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
=========================
Loading

0 comments on commit 176e812

Please sign in to comment.