From d61027fa3e153daf0e89a13db6f8802e02ce9081 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Z=C3=BClke?= Date: Wed, 28 Aug 2024 18:05:32 -0400 Subject: [PATCH 01/31] Add viewport meta tag to HTML head (#234) Much better page dimensions and scaling on mobile devices; this tag is standard practice for HTML these days. Also see https://github.com/heroku/php-getting-started/pull/74 --- hello/templates/base.html | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/hello/templates/base.html b/hello/templates/base.html index 97ec07386..73977e0b2 100644 --- a/hello/templates/base.html +++ b/hello/templates/base.html @@ -1,7 +1,8 @@ -Python Getting Started on Heroku + Python Getting Started on Heroku + From 1da36000e9a38658396d111139d6953a10eec05b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 2 Sep 2024 08:49:44 +0100 Subject: [PATCH 02/31] Update gunicorn requirement from <23,>=22 to >=23,<24 (#235) * Update gunicorn requirement from <23,>=22 to >=22,<24 Updates the requirements on [gunicorn](https://github.com/benoitc/gunicorn) to permit the latest version. - [Release notes](https://github.com/benoitc/gunicorn/releases) - [Commits](https://github.com/benoitc/gunicorn/compare/22.0.0...23.0.0) --- updated-dependencies: - dependency-name: gunicorn dependency-type: direct:production ... Signed-off-by: dependabot[bot] * Bump lower bound --------- Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ed Morley <501702+edmorley@users.noreply.github.com> --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index e80db5cab..c420fa54c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ django>=5.1,<5.2 -gunicorn>=22,<23 +gunicorn>=23,<24 dj-database-url>=2,<3 whitenoise[brotli]>=6,<7 From 295f6efb4be6a0c472cb24ab80f8264298438b18 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Sat, 7 Sep 2024 11:26:20 +0000 Subject: [PATCH 03/31] Update to Python 3.12.6 (#236) https://docs.python.org/release/3.12.6/whatsnew/changelog.html#python-3-12-6-final GUS-W-16690292. --- runtime.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/runtime.txt b/runtime.txt index 8a7cba521..32bcba665 100644 --- a/runtime.txt +++ b/runtime.txt @@ -1 +1 @@ -python-3.12.5 +python-3.12.6 From 60d9aa2cf600edaa7d801e7f6784463ade9811d5 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Tue, 1 Oct 2024 06:31:44 +0000 Subject: [PATCH 04/31] Update to Python 3.12.7 (#237) https://www.python.org/downloads/release/python-3127/ GUS-W-16867262. --- runtime.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/runtime.txt b/runtime.txt index 32bcba665..32905d6e0 100644 --- a/runtime.txt +++ b/runtime.txt @@ -1 +1 @@ -python-3.12.6 +python-3.12.7 From 4d9fb79404f61312c39de4cc4815cf115fe017d8 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Thu, 10 Oct 2024 20:59:22 +0000 Subject: [PATCH 05/31] Update to Python 3.13.0 (#238) Release announcement: https://blog.python.org/2024/10/python-3130-final-released.html https://www.python.org/downloads/release/python-3130/ What's new in Python 3.13: https://docs.python.org/3.13/whatsnew/3.13.html GUS-W-14846869. --- runtime.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/runtime.txt b/runtime.txt index 32905d6e0..dae7fec92 100644 --- a/runtime.txt +++ b/runtime.txt @@ -1 +1 @@ -python-3.12.7 +python-3.13.0 From c9a165d7f7fa08dedcefd76ff83dcc782514198b Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Mon, 14 Oct 2024 18:24:58 +0000 Subject: [PATCH 06/31] Switch from `runtime.txt` to `.python-version` (#239) Since use of the `runtime.txt` file is now deprecated in favour of the `.python-version` file (since the latter is more widely supported in the Python ecosystem). This also switches to specifying only the major Python version (which automatically uses the latest patch release), in order to: 1. Save us from having to bump the version in this repo every time a new Python patch version is released. 2. Ensure that anyone who closes this repo and uses it as the basis for their app is then always using an up to date patch version if they don't know/remember to bump the version themselves. GUS-W-16971647. --- .python-version | 1 + runtime.txt | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) create mode 100644 .python-version delete mode 100644 runtime.txt diff --git a/.python-version b/.python-version new file mode 100644 index 000000000..24ee5b1be --- /dev/null +++ b/.python-version @@ -0,0 +1 @@ +3.13 diff --git a/runtime.txt b/runtime.txt deleted file mode 100644 index dae7fec92..000000000 --- a/runtime.txt +++ /dev/null @@ -1 +0,0 @@ -python-3.13.0 From 0c83b7c202ab0108e50fe95428dd9780424c0653 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Wed, 20 Nov 2024 09:52:03 +0000 Subject: [PATCH 07/31] Disable unused Django features (#240) The example app isn't currently using the admin, auth, sessions and messages features. The config has been commented out rather than removed, to make it easier for users to re-enable if needed. (Particularly since some of the config is order dependant, such as `MIDDLEWARE`.) --- gettingstarted/settings.py | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/gettingstarted/settings.py b/gettingstarted/settings.py index c722f202c..80043c60f 100644 --- a/gettingstarted/settings.py +++ b/gettingstarted/settings.py @@ -58,16 +58,22 @@ # Application definition +# Several optional Django features that are present in the default `startproject` template have +# been disabled since they are not used by this example app. To use them, uncomment the relevant +# entries in `INSTALLED_APPS`, `MIDDLEWARE`, `TEMPLATES` and `urls.py`. See: +# https://docs.djangoproject.com/en/5.1/ref/contrib/admin/ +# https://docs.djangoproject.com/en/5.1/topics/auth/ +# https://docs.djangoproject.com/en/5.1/ref/contrib/contenttypes/ +# https://docs.djangoproject.com/en/5.1/topics/http/sessions/ +# https://docs.djangoproject.com/en/5.1/ref/contrib/messages/ INSTALLED_APPS = [ # Use WhiteNoise's runserver implementation instead of the Django default, for dev-prod parity. "whitenoise.runserver_nostatic", - # Uncomment this and the entry in `urls.py` if you wish to use the Django admin feature: - # https://docs.djangoproject.com/en/5.1/ref/contrib/admin/ # "django.contrib.admin", - "django.contrib.auth", - "django.contrib.contenttypes", - "django.contrib.sessions", - "django.contrib.messages", + # "django.contrib.auth", + # "django.contrib.contenttypes", + # "django.contrib.sessions", + # "django.contrib.messages", "django.contrib.staticfiles", "hello", ] @@ -79,11 +85,11 @@ # after Django's `SecurityMiddleware` so that security redirects are still performed. # See: https://whitenoise.readthedocs.io "whitenoise.middleware.WhiteNoiseMiddleware", - "django.contrib.sessions.middleware.SessionMiddleware", + # "django.contrib.sessions.middleware.SessionMiddleware", "django.middleware.common.CommonMiddleware", "django.middleware.csrf.CsrfViewMiddleware", - "django.contrib.auth.middleware.AuthenticationMiddleware", - "django.contrib.messages.middleware.MessageMiddleware", + # "django.contrib.auth.middleware.AuthenticationMiddleware", + # "django.contrib.messages.middleware.MessageMiddleware", "django.middleware.clickjacking.XFrameOptionsMiddleware", ] @@ -98,8 +104,8 @@ "context_processors": [ "django.template.context_processors.debug", "django.template.context_processors.request", - "django.contrib.auth.context_processors.auth", - "django.contrib.messages.context_processors.messages", + # "django.contrib.auth.context_processors.auth", + # "django.contrib.messages.context_processors.messages", ], }, }, From 962e79875f43b5c32a9109b416a827023d6f87cd Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Wed, 20 Nov 2024 17:54:27 +0000 Subject: [PATCH 08/31] Configure gunicorn to bind to the IPv6 interface (#241) By default when the `PORT` env var is set, gunicorn binds to the IPv4 interface `0.0.0.0:$PORT`: https://docs.gunicorn.org/en/stable/settings.html#bind Now, we configure it to bind to the IPv6 interface `[::]:$PORT` instead, allowing the app to work in IPv6-only environments. We don't have it bind to both the IPv4 and IPv6 interfaces, since otherwise on Linux by default gunicorn would fail to boot with: ``` [ERROR] connection to ('::', 5006) failed: [Errno 98] Address already in use ``` ...and when binding to the IPv6 interface IPv4 connections will still work (so long as `IPV6_V6ONLY` hasn't been enabled). If this strategy causes issues, we could always start using the `reuse_port` option, however, that makes the DX worse for the local development use-case (it's then possible to leave a stale gunicorn process running, which will serve requests and give the impression code changes aren't taking effect). I've added a `gunicorn.conf.py` config file rather than passing CLI args to the `gunicorn` command, since it allows for more flexibility with the configuration (and there are other settings we'll be adding soon). See: https://docs.gunicorn.org/en/stable/configure.html GUS-W-17280180. --- Procfile | 2 +- gettingstarted/settings.py | 2 +- gunicorn.conf.py | 16 ++++++++++++++++ 3 files changed, 18 insertions(+), 2 deletions(-) create mode 100644 gunicorn.conf.py diff --git a/Procfile b/Procfile index 470556bd9..c4512ab32 100644 --- a/Procfile +++ b/Procfile @@ -1,4 +1,4 @@ -web: gunicorn gettingstarted.wsgi +web: gunicorn --config gunicorn.conf.py gettingstarted.wsgi # Uncomment this `release` process if you are using a database, so that Django's model # migrations are run as part of app deployment, using Heroku's Release Phase feature: diff --git a/gettingstarted/settings.py b/gettingstarted/settings.py index 80043c60f..087b3a776 100644 --- a/gettingstarted/settings.py +++ b/gettingstarted/settings.py @@ -53,7 +53,7 @@ if IS_HEROKU_APP: ALLOWED_HOSTS = ["*"] else: - ALLOWED_HOSTS = [".localhost", "127.0.0.1", "[::1]", "0.0.0.0"] + ALLOWED_HOSTS = [".localhost", "127.0.0.1", "[::1]", "0.0.0.0", "[::]"] # Application definition diff --git a/gunicorn.conf.py b/gunicorn.conf.py new file mode 100644 index 000000000..1db1755e0 --- /dev/null +++ b/gunicorn.conf.py @@ -0,0 +1,16 @@ +# Gunicorn configuration file: +# https://docs.gunicorn.org/en/stable/configure.html +# https://docs.gunicorn.org/en/stable/settings.html +# Note: The classic Python buildpack currently sets a few gunicorn settings automatically via +# the `GUNICORN_CMD_ARGS` env var (which take priority over the settings in this file): +# https://github.com/heroku/heroku-buildpack-python/blob/main/vendor/python.gunicorn.sh + +import os + +# The `PORT` env var is set automatically for web dynos and when using `heroku local`: +# https://devcenter.heroku.com/articles/dyno-startup-behavior#port-binding-of-web-dynos +# https://devcenter.heroku.com/articles/heroku-local +_port = os.environ.get("PORT", 5006) +# Bind to the IPv6 interface instead of the gunicorn default of IPv4, so the app works in IPv6-only +# environments. IPv4 connections will still work so long as `IPV6_V6ONLY` hasn't been enabled. +bind = [f"[::]:{_port}"] From a538e3c0c0ad3f0dab8784fc6abd37dbf0d18034 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Thu, 21 Nov 2024 00:57:10 +0000 Subject: [PATCH 09/31] Switch to gunicorn's `gthread` worker type (#242) gunicorn's default worker type is the `sync` worker, which is more suited to CPU/network-bandwidth bound workloads. As such this switches to the thread-based `gthread` worker for improved request throughput performance for blocking I/O workloads - given that it's common for Heroku apps to make blocking requests to external APIs/datastores etc. The threads count of 5 is somewhat arbitrary, but seemed to work well enough with rough benchmarking against a few different dyno sizes (where the process count will vary according to `WEB_CONCURRENCY`) and simulated workload types. The `preload_app` option has also been enabled, which makes gunicorn load the app before the worker processes are forked, to reduce memory usage and boot times. See: https://docs.gunicorn.org/en/stable/design.html#server-model https://docs.gunicorn.org/en/stable/settings.html#worker-class GUS-W-17236632. --- gunicorn.conf.py | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/gunicorn.conf.py b/gunicorn.conf.py index 1db1755e0..22a2fab6c 100644 --- a/gunicorn.conf.py +++ b/gunicorn.conf.py @@ -14,3 +14,37 @@ # Bind to the IPv6 interface instead of the gunicorn default of IPv4, so the app works in IPv6-only # environments. IPv4 connections will still work so long as `IPV6_V6ONLY` hasn't been enabled. bind = [f"[::]:{_port}"] + +# The default `sync` worker is more suited to CPU/network-bandwidth bound workloads, so we +# instead use the thread based worker type for improved support of blocking I/O workloads: +# https://docs.gunicorn.org/en/stable/design.html#server-model +# +# If you need to further improve the performance of blocking I/O workloads, you may want to +# try the `gevent` worker type, though you will need to disable `preload_app`, enable DB +# connecting pooling, and be aware that gevent's monkey patching can break some packages. +# +# Note: When changing the number of dynos/workers/threads you will want to make sure you +# do not exceed the maximum number of connections to external services such as DBs: +# https://devcenter.heroku.com/articles/python-concurrency-and-database-connections +worker_class = "gthread" + +# gunicorn will start this many worker processes. The Python buildpack automatically sets a +# default for WEB_CONCURRENCY at dyno boot, based on the number of CPUs and available RAM: +# https://devcenter.heroku.com/articles/python-concurrency +workers = os.environ.get("WEB_CONCURRENCY", 1) + +# Each `gthread` worker process will use a pool of this many threads. +threads = 5 + +# Load the app before the worker processes are forked, to reduce memory usage and boot times. +preload_app = True + +# Workers silent for more than this many seconds are killed and restarted. +# Note: This only affects the maximum request time when using the `sync` worker. +# For all other worker types it acts only as a worker heartbeat timeout. +timeout = 20 + +# After receiving a restart signal, workers have this much time to finish serving requests. +# This should be set to a value less than the 30 second Heroku dyno shutdown timeout: +# https://devcenter.heroku.com/articles/dyno-shutdown-behavior +graceful_timeout = 20 From 4795062876a634b260fdc69aab907a66267b0112 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Thu, 21 Nov 2024 16:08:23 +0000 Subject: [PATCH 10/31] Update app.json metadata (#243) * Remove the `image` field, since the `heroku.yml` languages feature was sunset some time ago, and the language docker images no longer exist. * Add the `website` field so the Heroku Button deploy form links to the Getting started guide. See: https://devcenter.heroku.com/articles/heroku-button https://devcenter.heroku.com/articles/app-json-schema --- app.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app.json b/app.json index 42c60c66b..c093460de 100644 --- a/app.json +++ b/app.json @@ -1,8 +1,8 @@ { "name": "Start on Heroku: Python", "description": "A barebones Python app, which can easily be deployed to Heroku.", - "image": "heroku/python", "repository": "https://github.com/heroku/python-getting-started", + "website": "https://devcenter.heroku.com/articles/getting-started-with-python", "keywords": ["python", "django"], "env": { "DJANGO_SECRET_KEY": { From 3d141db2535d117c0021e5fc04448d5de1523986 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Wed, 27 Nov 2024 15:17:24 +0000 Subject: [PATCH 11/31] Clean up the gunicorn `bind` config (#244) So that it's on one line and easier to include via the rundoc template for the getting started guide. --- gunicorn.conf.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/gunicorn.conf.py b/gunicorn.conf.py index 22a2fab6c..9332468fd 100644 --- a/gunicorn.conf.py +++ b/gunicorn.conf.py @@ -7,13 +7,15 @@ import os -# The `PORT` env var is set automatically for web dynos and when using `heroku local`: +# On Heroku, web dynos must bind to the port number specified via the `PORT` env var. This +# env var is set automatically for web dynos and also when using `heroku local` locally: # https://devcenter.heroku.com/articles/dyno-startup-behavior#port-binding-of-web-dynos # https://devcenter.heroku.com/articles/heroku-local -_port = os.environ.get("PORT", 5006) -# Bind to the IPv6 interface instead of the gunicorn default of IPv4, so the app works in IPv6-only -# environments. IPv4 connections will still work so long as `IPV6_V6ONLY` hasn't been enabled. -bind = [f"[::]:{_port}"] +# Gunicorn will automatically use the `PORT` env var, however, by default it will bind to the +# port using the IPv4 interface (`0.0.0.0`). We configure the binding manually to make it bind +# to the IPv6 interface (`::`) instead, so that the app works in IPv6-only environments too. +# (IPv4 connections will still work so long as `IPV6_V6ONLY` hasn't been enabled.) +bind = ["[::]:{}".format(os.environ.get("PORT", 5006))] # The default `sync` worker is more suited to CPU/network-bandwidth bound workloads, so we # instead use the thread based worker type for improved support of blocking I/O workloads: From 65c908c6ac36428a0be3643a1edb3ce638df51ac Mon Sep 17 00:00:00 2001 From: Richard Schneeman Date: Sun, 8 Dec 2024 08:11:30 -0600 Subject: [PATCH 12/31] Update for Fir (#245) Update the README and app's templates for the release of Fir. Co-authored-by: Ed Morley <501702+edmorley@users.noreply.github.com> --- README.md | 36 +++++++++++++++++++++++++------ hello/templates/base.html | 36 +++++++++++++++++++++++-------- hello/templates/index.html | 44 ++++++++++++++++++++------------------ 3 files changed, 80 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 0eab837d0..0806f3220 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,44 @@ -# Python: Getting Started +# Python Getting Started A barebones Django app, which can easily be deployed to Heroku. +This application supports the tutorials for both the [Cedar and Fir generations](https://devcenter.heroku.com/articles/generations) of the Heroku platform. You can check them out here: + +- [Getting Started on Heroku with Python](https://devcenter.heroku.com/articles/getting-started-with-python) +- [Getting Started on Heroku Fir with Python](https://devcenter.heroku.com/articles/getting-started-with-python-fir) + ## Deploying to Heroku Using resources for this example app counts towards your usage. [Delete your app](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-apps-destroy) and [database](https://devcenter.heroku.com/articles/heroku-postgresql#removing-the-add-on) as soon as you are done experimenting to control costs. +### Deploy on Heroku [Cedar](https://devcenter.heroku.com/articles/generations#cedar) + By default, apps use Eco dynos if you are subscribed to Eco. Otherwise, it defaults to Basic dynos. The Eco dynos plan is shared across all Eco dynos in your account and is recommended if you plan on deploying many small apps to Heroku. Learn more about our low-cost plans [here](https://blog.heroku.com/new-low-cost-plans). Eligible students can apply for platform credits through our new [Heroku for GitHub Students program](https://blog.heroku.com/github-student-developer-program). -This application supports the [Getting Started with Python on Heroku](https://devcenter.heroku.com/articles/getting-started-with-python) article - check it out for instructions on how to deploy this app to Heroku and also run it locally. - -Alternatively, you can deploy it using this Heroku Button: - -[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://www.heroku.com/deploy?template=https://github.com/heroku/python-getting-started) +```term +$ git clone https://github.com/heroku/python-getting-started +$ cd python-getting-started +$ heroku create +$ git push heroku main +$ heroku open +``` + +### Deploy on Heroku [Fir](https://devcenter.heroku.com/articles/generations#fir) + +By default, apps on [Fir](https://devcenter.heroku.com/articles/generations#fir) use 1X-Classic dynos. To create an app on [Fir](https://devcenter.heroku.com/articles/generations#fir) you'll need to +[create a private space](https://devcenter.heroku.com/articles/working-with-private-spaces#create-a-private-space) +first. + +```term +$ git clone https://github.com/heroku/python-getting-started +$ cd python-getting-started +$ heroku create --space +$ git push heroku main +$ heroku ps:wait +$ heroku open +``` For more information about using Python on Heroku, see these Dev Center articles: diff --git a/hello/templates/base.html b/hello/templates/base.html index 73977e0b2..4a9450c99 100644 --- a/hello/templates/base.html +++ b/hello/templates/base.html @@ -55,20 +55,38 @@ How Heroku Works
  • - +
    • +
  • + + +
    • diff --git a/hello/templates/index.html b/hello/templates/index.html index 55951ccc2..b4f60e59b 100644 --- a/hello/templates/index.html +++ b/hello/templates/index.html @@ -10,49 +10,51 @@

      Getting Started with Python on Heroku

      This is a sample Python application deployed to Heroku. It's a reasonably simple app - but a good foundation for understanding how to get the most out of the Heroku platform.

      - Getting Started with Python + Getting Started on Heroku with Python + Getting Started on Heroku Fir with Python Source on GitHub
      - {% endblock %} From d580c39a40522256c8c5845a396d9dee8370cb6f Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Sun, 8 Dec 2024 16:48:20 +0000 Subject: [PATCH 13/31] Configure gunicorn access log (#246) * Explicitly enable the access log (since currently it's only enabled when using the classic Python buildpack, and not locally or when using the Python CNB). * Customise the gunicorn access log format to make it use the Heroku logfmt style, and to improve which fields are included. Before: ``` 2024-12-08T16:23:33.457957+00:00 app[web.1]: ::ffff:10.1.50.245 - - [08/Dec/2024:16:23:33 +0000] "GET / HTTP/1.1" 200 9585 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:134.0) Gecko/20100101 Firefox/134.0" ``` After: ``` 2024-12-08T16:32:47.618296+00:00 app[web.1]: gunicorn method=GET path="/" status=200 duration=14ms request_id=e45f9c86-d6d8-4b79-937e-18c0b6bf859e fwd="123.456.789.0" user_agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:134.0) Gecko/20100101 Firefox/134.0" ``` Ref heroku/buildpacks-python#4. GUS-W-17316745. --- gunicorn.conf.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/gunicorn.conf.py b/gunicorn.conf.py index 9332468fd..0cd46ed3c 100644 --- a/gunicorn.conf.py +++ b/gunicorn.conf.py @@ -50,3 +50,11 @@ # This should be set to a value less than the 30 second Heroku dyno shutdown timeout: # https://devcenter.heroku.com/articles/dyno-shutdown-behavior graceful_timeout = 20 + +# Enable logging of incoming requests to stdout. +accesslog = "-" + +# Adjust which fields are included in the access log, and make it use the Heroku logfmt +# style. The `X-Request-Id` and `X-Forwarded-For` headers are set by the Heroku Router: +# https://devcenter.heroku.com/articles/http-routing#heroku-headers +access_log_format = 'gunicorn method=%(m)s path="%(U)s" status=%(s)s duration=%(M)sms request_id=%({x-request-id}i)s fwd="%({x-forwarded-for}i)s" user_agent="%(a)s"' From b0034b28a9fb0325bedc2e0a1af40dea5ff68853 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Thu, 16 Jan 2025 13:16:54 +0000 Subject: [PATCH 14/31] Enable automatic gunicorn reloading in development (#247) This saves having to manually restart gunicorn after making changes to the app in development when using `heroku local`. See: https://docs.gunicorn.org/en/stable/settings.html#reload GUS-W-17614098. --- .env | 4 ++++ gunicorn.conf.py | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/.env b/.env index fbb3c134e..78da5a556 100644 --- a/.env +++ b/.env @@ -3,4 +3,8 @@ # running on Heroku - to set env vars for those, see: # https://devcenter.heroku.com/articles/config-vars +# This is used in gunicorn.conf.py to set appropriate settings for development vs production. +ENVIRONMENT="development" + +# An example env var used in the tutorial. TIMES=2 diff --git a/gunicorn.conf.py b/gunicorn.conf.py index 0cd46ed3c..aa4ac21d7 100644 --- a/gunicorn.conf.py +++ b/gunicorn.conf.py @@ -58,3 +58,7 @@ # style. The `X-Request-Id` and `X-Forwarded-For` headers are set by the Heroku Router: # https://devcenter.heroku.com/articles/http-routing#heroku-headers access_log_format = 'gunicorn method=%(m)s path="%(U)s" status=%(s)s duration=%(M)sms request_id=%({x-request-id}i)s fwd="%({x-forwarded-for}i)s" user_agent="%(a)s"' + +if os.environ.get("ENVIRONMENT") == "development": + # Automatically restart gunicorn when the app source changes in development. + reload = True From 6d6040046d666300150e894515f2cb6ddfb36c53 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Thu, 16 Jan 2025 14:11:12 +0000 Subject: [PATCH 15/31] Enable gunicorn's `reuse_port` in production (#248) This causes gunicorn to set `SO_REUSEPORT` on the listening socket, which helps ensure better request distribution between gunicorn workers and thus better performance. We don't enable this in development, since it makes it harder to notice when duplicate gunicorn processes have accidentally been launched (eg in different terminals), since the "address already in use" error no longer occurs. See: https://docs.gunicorn.org/en/stable/settings.html#reuse-port https://github.com/benoitc/gunicorn/pull/2938 https://lwn.net/Articles/542629/ GUS-W-17614363. --- gunicorn.conf.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/gunicorn.conf.py b/gunicorn.conf.py index aa4ac21d7..b4a74620d 100644 --- a/gunicorn.conf.py +++ b/gunicorn.conf.py @@ -62,3 +62,10 @@ if os.environ.get("ENVIRONMENT") == "development": # Automatically restart gunicorn when the app source changes in development. reload = True +else: + # Use `SO_REUSEPORT` on the listening socket, which allows for more even request + # distribution between workers. See: https://lwn.net/Articles/542629/ + # We don't enable this in development, since it makes it harder to notice when + # duplicate gunicorn processes have accidentally been launched (eg in different + # terminals), since the "address already in use" error no longer occurs. + reuse_port = True From c639ff4a5be0d24407e9e9bc4d1385c786c868f6 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Thu, 16 Jan 2025 21:58:12 +0000 Subject: [PATCH 16/31] Don't enable gunicorn's `preload_app` in development (#249) Since otherwise it interferes with `reload = True`. See: https://docs.gunicorn.org/en/stable/settings.html#reload GUS-W-17614098. --- gunicorn.conf.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/gunicorn.conf.py b/gunicorn.conf.py index b4a74620d..f17967105 100644 --- a/gunicorn.conf.py +++ b/gunicorn.conf.py @@ -38,9 +38,6 @@ # Each `gthread` worker process will use a pool of this many threads. threads = 5 -# Load the app before the worker processes are forked, to reduce memory usage and boot times. -preload_app = True - # Workers silent for more than this many seconds are killed and restarted. # Note: This only affects the maximum request time when using the `sync` worker. # For all other worker types it acts only as a worker heartbeat timeout. @@ -63,6 +60,10 @@ # Automatically restart gunicorn when the app source changes in development. reload = True else: + # Load the app before the worker processes are forked, to reduce memory usage and boot times. + # We don't enable this in development, since it's incompatible with `reload = True`. + preload_app = True + # Use `SO_REUSEPORT` on the listening socket, which allows for more even request # distribution between workers. See: https://lwn.net/Articles/542629/ # We don't enable this in development, since it makes it harder to notice when From e0a409bce9d7822907dba3453daaa20f57446c21 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Thu, 16 Jan 2025 23:24:34 +0000 Subject: [PATCH 17/31] Add a custom Django `LOGGING` configuration (#250) Since by default full Django logs are only emitted when `DEBUG=True` (which otherwise makes diagnosing errors much harder in production): https://docs.djangoproject.com/en/5.1/ref/logging/#default-logging-configuration https://docs.djangoproject.com/en/5.1/howto/logging/ GUS-W-17618372. --- gettingstarted/settings.py | 39 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/gettingstarted/settings.py b/gettingstarted/settings.py index 087b3a776..9303c63cb 100644 --- a/gettingstarted/settings.py +++ b/gettingstarted/settings.py @@ -196,3 +196,42 @@ # https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField" + +# Customise the default logging config, since by default full Django logs are only emitted when +# `DEBUG=True` (which otherwise makes diagnosing errors much harder in production): +# https://docs.djangoproject.com/en/5.1/ref/logging/#default-logging-configuration +# For more advanced logging you may want to try: https://django-structlog.readthedocs.io +LOGGING = { + "version": 1, + "disable_existing_loggers": False, + "formatters": { + "simple": { + "format": "[{levelname}] {message}", + "style": "{", + }, + }, + "handlers": { + "console": { + "class": "logging.StreamHandler", + "formatter": "simple", + }, + }, + # Fallback for anything not configured via `loggers`. + "root": { + "handlers": ["console"], + "level": "INFO", + }, + "loggers": { + "django": { + "handlers": ["console"], + "level": "INFO", + # Prevent double logging due to the root logger. + "propagate": False, + }, + "django.request": { + # Suppress the WARNINGS from any HTTP 4xx responses (in particular for 404s caused by + # web crawlers), but still show any ERRORs from HTTP 5xx responses/exceptions. + "level": "ERROR", + }, + }, +} From 42fd0c5824e01a6ce0d3e586eafe6215569a3fe5 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Fri, 17 Jan 2025 15:18:08 +0000 Subject: [PATCH 18/31] Enable Django `DEBUG` in fewer scenarios (#251) Previously `DEBUG` would be enabled in any environment that wasn't a Heroku app, including an OCI image built using the Python CNB. Instead we would rather such an image act closer to how the app will on Heroku. (We also want as few Heroku-specific conditionals as possible.) GUS-W-17623845. --- .env | 3 ++- gettingstarted/settings.py | 17 +++++++++++------ 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/.env b/.env index 78da5a556..f101ae13b 100644 --- a/.env +++ b/.env @@ -3,7 +3,8 @@ # running on Heroku - to set env vars for those, see: # https://devcenter.heroku.com/articles/config-vars -# This is used in gunicorn.conf.py to set appropriate settings for development vs production. +# This is used by gunicorn.conf.py and Django's settings.py to set appropriate +# configuration for development vs production. ENVIRONMENT="development" # An example env var used in the tutorial. diff --git a/gettingstarted/settings.py b/gettingstarted/settings.py index 9303c63cb..6ed26f4fa 100644 --- a/gettingstarted/settings.py +++ b/gettingstarted/settings.py @@ -31,22 +31,27 @@ # Make sure to use a long unique value, like you would for a password. See: # https://docs.djangoproject.com/en/5.1/ref/settings/#std-setting-SECRET_KEY # https://devcenter.heroku.com/articles/config-vars -# SECURITY WARNING: keep the secret key used in production secret! +# SECURITY WARNING: Keep the secret key used in production secret! SECRET_KEY = os.environ.get( "DJANGO_SECRET_KEY", default=secrets.token_urlsafe(nbytes=64), ) +# Django has a debug mode which shows more detailed error messages and also means static assets +# can be served without having to run the production `collectstatic` command. However, this +# debug mode *must only be enabled in development* for security and performance reasons: +# https://docs.djangoproject.com/en/5.1/ref/settings/#std-setting-DEBUG +# Debug mode will be automatically enabled when the project is run via `heroku local` (which +# loads the environment variables set in the `.env` file, where `ENVIRONMENT=development`). +# SECURITY WARNING: Don't run with debug turned on in production! +DEBUG = os.environ.get("ENVIRONMENT") == "development" + # The `DYNO` env var is set on Heroku CI, but it's not a real Heroku app, so we have to # also explicitly exclude CI: # https://devcenter.heroku.com/articles/heroku-ci#immutable-environment-variables IS_HEROKU_APP = "DYNO" in os.environ and not "CI" in os.environ -# SECURITY WARNING: don't run with debug turned on in production! -if not IS_HEROKU_APP: - DEBUG = True - -# On Heroku, it's safe to use a wildcard for `ALLOWED_HOSTS``, since the Heroku router performs +# On Heroku, it's safe to use a wildcard for `ALLOWED_HOSTS`, since the Heroku router performs # validation of the Host header in the incoming HTTP request. On other platforms you may need to # list the expected hostnames explicitly in production to prevent HTTP Host header attacks. See: # https://docs.djangoproject.com/en/5.1/ref/settings/#std-setting-ALLOWED_HOSTS From a288ab16d4b8b6bd6bcbe50d3f3d5104b4b42f70 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Fri, 17 Jan 2025 15:29:03 +0000 Subject: [PATCH 19/31] Set `PYTHONUNBUFFERED=1` locally (#252) Since otherwise when Django management commands like `manage.py runserver` are run via `heroku local`, the log buffering causes the server startup logs to not appear immediately. --- .env | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.env b/.env index f101ae13b..72dc04c1b 100644 --- a/.env +++ b/.env @@ -7,5 +7,8 @@ # configuration for development vs production. ENVIRONMENT="development" +# Prevent log buffering when using using `heroku local` with Django management commands. +PYTHONUNBUFFERED=1 + # An example env var used in the tutorial. TIMES=2 From a75e1c513b7f54bf32f03874fbe9369790ecfd0b Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Tue, 21 Jan 2025 23:06:36 +0000 Subject: [PATCH 20/31] Enable redirection of HTTP requests to HTTPS (#253) Using Django's `SECURE_SSL_REDIRECT`: https://docs.djangoproject.com/en/5.1/ref/settings/#std-setting-SECURE_SSL_REDIRECT Also configures gunicorn's `forwarded_allow_ips` setting to `"*"` so that gunicorn trusts the `X-Forwarded-Proto` header set by the Heroku Router during TLS termination, to ensure that HTTPS requests are correctly marked as secure in the WSGI metadata passed to the WSGI app (in this case, Django). See: https://docs.gunicorn.org/en/stable/settings.html#forwarded-allow-ips https://devcenter.heroku.com/articles/http-routing#heroku-headers (Whilst the classic Python buildpack already configures this by setting the env var `FORWARDED_ALLOW_IPS`, the Python CNB doesn't yet do so, and it's clearer to have the config explicitly set in the app source.) GUS-W-17482732. --- gettingstarted/settings.py | 22 +++++++++++++++++----- gunicorn.conf.py | 7 +++++++ 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/gettingstarted/settings.py b/gettingstarted/settings.py index 6ed26f4fa..e5228022f 100644 --- a/gettingstarted/settings.py +++ b/gettingstarted/settings.py @@ -49,14 +49,26 @@ # The `DYNO` env var is set on Heroku CI, but it's not a real Heroku app, so we have to # also explicitly exclude CI: # https://devcenter.heroku.com/articles/heroku-ci#immutable-environment-variables -IS_HEROKU_APP = "DYNO" in os.environ and not "CI" in os.environ +IS_HEROKU_APP = "DYNO" in os.environ and "CI" not in os.environ -# On Heroku, it's safe to use a wildcard for `ALLOWED_HOSTS`, since the Heroku router performs -# validation of the Host header in the incoming HTTP request. On other platforms you may need to -# list the expected hostnames explicitly in production to prevent HTTP Host header attacks. See: -# https://docs.djangoproject.com/en/5.1/ref/settings/#std-setting-ALLOWED_HOSTS if IS_HEROKU_APP: + # On Heroku, it's safe to use a wildcard for `ALLOWED_HOSTS`, since the Heroku router performs + # validation of the Host header in the incoming HTTP request. On other platforms you may need to + # list the expected hostnames explicitly in production to prevent HTTP Host header attacks. See: + # https://docs.djangoproject.com/en/5.1/ref/settings/#std-setting-ALLOWED_HOSTS ALLOWED_HOSTS = ["*"] + + # Redirect all non-HTTPS requests to HTTPS. This requires that: + # 1. Your app has a TLS/SSL certificate, which all `*.herokuapp.com` domains do by default. + # When using a custom domain, you must configure one. See: + # https://devcenter.heroku.com/articles/automated-certificate-management + # 2. Your app's WSGI web server is configured to use the `X-Forwarded-Proto` headers set by + # the Heroku Router (otherwise you may encounter infinite HTTP 301 redirects). See this + # app's `gunicorn.conf.py` for how this is done when using gunicorn. + # + # For maximum security, consider enabling HTTP Strict Transport Security (HSTS) headers too: + # https://docs.djangoproject.com/en/5.1/ref/middleware/#http-strict-transport-security + SECURE_SSL_REDIRECT = True else: ALLOWED_HOSTS = [".localhost", "127.0.0.1", "[::1]", "0.0.0.0", "[::]"] diff --git a/gunicorn.conf.py b/gunicorn.conf.py index f17967105..09e78a5d6 100644 --- a/gunicorn.conf.py +++ b/gunicorn.conf.py @@ -1,6 +1,7 @@ # Gunicorn configuration file: # https://docs.gunicorn.org/en/stable/configure.html # https://docs.gunicorn.org/en/stable/settings.html +# # Note: The classic Python buildpack currently sets a few gunicorn settings automatically via # the `GUNICORN_CMD_ARGS` env var (which take priority over the settings in this file): # https://github.com/heroku/heroku-buildpack-python/blob/main/vendor/python.gunicorn.sh @@ -70,3 +71,9 @@ # duplicate gunicorn processes have accidentally been launched (eg in different # terminals), since the "address already in use" error no longer occurs. reuse_port = True + + # Trust the `X-Forwarded-Proto` header set by the Heroku Router during TLS termination, + # (https://devcenter.heroku.com/articles/http-routing#heroku-headers) so that HTTPS requests + # are correctly marked as secure. This allows the WSGI app (in our case, Django) to distinguish + # between HTTP and HTTPS requests for features like HTTP->HTTPS URL redirection. + forwarded_allow_ips = "*" From 60e2737053f0de24c0f09165af3d116163d37fe7 Mon Sep 17 00:00:00 2001 From: Pablo Temporini Date: Thu, 3 Apr 2025 14:22:49 -0300 Subject: [PATCH 21/31] Update repo metadata (#255) Signed-off-by: Pablo Temporini --- .github/CODEOWNERS | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 55ffb44be..a139d887f 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,6 +1,8 @@ # Note: Delete this file if you are copying the code in this repository into your own project. # Default to requesting pull request reviews from the Heroku Languages team. +#ECCN:Open Source +#GUSINFO:Languages,Heroku Python Platform * @heroku/languages # However, request review from the Heroku language owner for files that are updated From 461f1ac1e7fc8667deb5a7bf8ffa2be022dc7158 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Sun, 6 Apr 2025 16:30:11 +0100 Subject: [PATCH 22/31] Update to Django 5.2 (#256) See: https://www.djangoproject.com/weblog/2025/apr/02/django-52-released/ https://docs.djangoproject.com/en/5.2/releases/5.2/ GUS-W-17606277. --- Procfile | 2 +- gettingstarted/asgi.py | 2 +- gettingstarted/settings.py | 39 ++++++++++++++++---------------- gettingstarted/urls.py | 4 ++-- gettingstarted/wsgi.py | 2 +- hello/migrations/0001_initial.py | 2 +- requirements.txt | 2 +- 7 files changed, 26 insertions(+), 27 deletions(-) diff --git a/Procfile b/Procfile index c4512ab32..2dc630d1d 100644 --- a/Procfile +++ b/Procfile @@ -2,6 +2,6 @@ web: gunicorn --config gunicorn.conf.py gettingstarted.wsgi # Uncomment this `release` process if you are using a database, so that Django's model # migrations are run as part of app deployment, using Heroku's Release Phase feature: -# https://docs.djangoproject.com/en/5.1/topics/migrations/ +# https://docs.djangoproject.com/en/5.2/topics/migrations/ # https://devcenter.heroku.com/articles/release-phase #release: ./manage.py migrate --no-input diff --git a/gettingstarted/asgi.py b/gettingstarted/asgi.py index 09246d692..010368f87 100644 --- a/gettingstarted/asgi.py +++ b/gettingstarted/asgi.py @@ -4,7 +4,7 @@ It exposes the ASGI callable as a module-level variable named ``application``. For more information on this file, see -https://docs.djangoproject.com/en/5.1/howto/deployment/asgi/ +https://docs.djangoproject.com/en/5.2/howto/deployment/asgi/ """ import os diff --git a/gettingstarted/settings.py b/gettingstarted/settings.py index e5228022f..55566786f 100644 --- a/gettingstarted/settings.py +++ b/gettingstarted/settings.py @@ -1,13 +1,13 @@ """ Django settings for gettingstarted project. -Generated by 'django-admin startproject' using Django 5.1. +Generated by 'django-admin startproject' using Django 5.2. For more information on this file, see -https://docs.djangoproject.com/en/5.1/topics/settings/ +https://docs.djangoproject.com/en/5.2/topics/settings/ For the full list of settings and their values, see -https://docs.djangoproject.com/en/5.1/ref/settings/ +https://docs.djangoproject.com/en/5.2/ref/settings/ """ import os @@ -21,7 +21,7 @@ # Before using your Heroku app in production, make sure to review Django's deployment checklist: -# See https://docs.djangoproject.com/en/5.1/howto/deployment/checklist/ +# See https://docs.djangoproject.com/en/5.2/howto/deployment/checklist/ # Django requires a unique secret key for each Django app, that is used by several of its # security features. To simplify initial setup (without hardcoding the secret in the source @@ -29,7 +29,7 @@ # Django features break whenever an app restarts (for example, sessions will be logged out). # In your production Heroku apps you should set the `DJANGO_SECRET_KEY` config var explicitly. # Make sure to use a long unique value, like you would for a password. See: -# https://docs.djangoproject.com/en/5.1/ref/settings/#std-setting-SECRET_KEY +# https://docs.djangoproject.com/en/5.2/ref/settings/#std-setting-SECRET_KEY # https://devcenter.heroku.com/articles/config-vars # SECURITY WARNING: Keep the secret key used in production secret! SECRET_KEY = os.environ.get( @@ -40,7 +40,7 @@ # Django has a debug mode which shows more detailed error messages and also means static assets # can be served without having to run the production `collectstatic` command. However, this # debug mode *must only be enabled in development* for security and performance reasons: -# https://docs.djangoproject.com/en/5.1/ref/settings/#std-setting-DEBUG +# https://docs.djangoproject.com/en/5.2/ref/settings/#std-setting-DEBUG # Debug mode will be automatically enabled when the project is run via `heroku local` (which # loads the environment variables set in the `.env` file, where `ENVIRONMENT=development`). # SECURITY WARNING: Don't run with debug turned on in production! @@ -55,7 +55,7 @@ # On Heroku, it's safe to use a wildcard for `ALLOWED_HOSTS`, since the Heroku router performs # validation of the Host header in the incoming HTTP request. On other platforms you may need to # list the expected hostnames explicitly in production to prevent HTTP Host header attacks. See: - # https://docs.djangoproject.com/en/5.1/ref/settings/#std-setting-ALLOWED_HOSTS + # https://docs.djangoproject.com/en/5.2/ref/settings/#std-setting-ALLOWED_HOSTS ALLOWED_HOSTS = ["*"] # Redirect all non-HTTPS requests to HTTPS. This requires that: @@ -67,7 +67,7 @@ # app's `gunicorn.conf.py` for how this is done when using gunicorn. # # For maximum security, consider enabling HTTP Strict Transport Security (HSTS) headers too: - # https://docs.djangoproject.com/en/5.1/ref/middleware/#http-strict-transport-security + # https://docs.djangoproject.com/en/5.2/ref/middleware/#http-strict-transport-security SECURE_SSL_REDIRECT = True else: ALLOWED_HOSTS = [".localhost", "127.0.0.1", "[::1]", "0.0.0.0", "[::]"] @@ -78,11 +78,11 @@ # Several optional Django features that are present in the default `startproject` template have # been disabled since they are not used by this example app. To use them, uncomment the relevant # entries in `INSTALLED_APPS`, `MIDDLEWARE`, `TEMPLATES` and `urls.py`. See: -# https://docs.djangoproject.com/en/5.1/ref/contrib/admin/ -# https://docs.djangoproject.com/en/5.1/topics/auth/ -# https://docs.djangoproject.com/en/5.1/ref/contrib/contenttypes/ -# https://docs.djangoproject.com/en/5.1/topics/http/sessions/ -# https://docs.djangoproject.com/en/5.1/ref/contrib/messages/ +# https://docs.djangoproject.com/en/5.2/ref/contrib/admin/ +# https://docs.djangoproject.com/en/5.2/topics/auth/ +# https://docs.djangoproject.com/en/5.2/ref/contrib/contenttypes/ +# https://docs.djangoproject.com/en/5.2/topics/http/sessions/ +# https://docs.djangoproject.com/en/5.2/ref/contrib/messages/ INSTALLED_APPS = [ # Use WhiteNoise's runserver implementation instead of the Django default, for dev-prod parity. "whitenoise.runserver_nostatic", @@ -119,7 +119,6 @@ "APP_DIRS": True, "OPTIONS": { "context_processors": [ - "django.template.context_processors.debug", "django.template.context_processors.request", # "django.contrib.auth.context_processors.auth", # "django.contrib.messages.context_processors.messages", @@ -132,7 +131,7 @@ # Database -# https://docs.djangoproject.com/en/5.1/ref/settings/#databases +# https://docs.djangoproject.com/en/5.2/ref/settings/#databases if IS_HEROKU_APP: # In production on Heroku the database configuration is derived from the `DATABASE_URL` @@ -160,7 +159,7 @@ # Password validation -# https://docs.djangoproject.com/en/5.1/ref/settings/#auth-password-validators +# https://docs.djangoproject.com/en/5.2/ref/settings/#auth-password-validators AUTH_PASSWORD_VALIDATORS = [ { @@ -179,7 +178,7 @@ # Internationalization -# https://docs.djangoproject.com/en/5.1/topics/i18n/ +# https://docs.djangoproject.com/en/5.2/topics/i18n/ LANGUAGE_CODE = "en-us" @@ -191,7 +190,7 @@ # Static files (CSS, JavaScript, Images) -# https://docs.djangoproject.com/en/5.1/howto/static-files/ +# https://docs.djangoproject.com/en/5.2/howto/static-files/ STATIC_ROOT = BASE_DIR / "staticfiles" STATIC_URL = "static/" @@ -210,13 +209,13 @@ # Default primary key field type -# https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field +# https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField" # Customise the default logging config, since by default full Django logs are only emitted when # `DEBUG=True` (which otherwise makes diagnosing errors much harder in production): -# https://docs.djangoproject.com/en/5.1/ref/logging/#default-logging-configuration +# https://docs.djangoproject.com/en/5.2/ref/logging/#default-logging-configuration # For more advanced logging you may want to try: https://django-structlog.readthedocs.io LOGGING = { "version": 1, diff --git a/gettingstarted/urls.py b/gettingstarted/urls.py index 741113540..b35f43dbb 100644 --- a/gettingstarted/urls.py +++ b/gettingstarted/urls.py @@ -2,7 +2,7 @@ URL configuration for gettingstarted project. The `urlpatterns` list routes URLs to views. For more information please see: - https://docs.djangoproject.com/en/5.1/topics/http/urls/ + https://docs.djangoproject.com/en/5.2/topics/http/urls/ Examples: Function views 1. Add an import: from my_app import views @@ -24,6 +24,6 @@ path("", hello.views.index, name="index"), path("db/", hello.views.db, name="db"), # Uncomment this and the entry in `INSTALLED_APPS` if you wish to use the Django admin feature: - # https://docs.djangoproject.com/en/5.1/ref/contrib/admin/ + # https://docs.djangoproject.com/en/5.2/ref/contrib/admin/ # path("admin/", admin.site.urls), ] diff --git a/gettingstarted/wsgi.py b/gettingstarted/wsgi.py index 9d8da75b1..ed57f4404 100644 --- a/gettingstarted/wsgi.py +++ b/gettingstarted/wsgi.py @@ -4,7 +4,7 @@ It exposes the WSGI callable as a module-level variable named ``application``. For more information on this file, see -https://docs.djangoproject.com/en/5.1/howto/deployment/wsgi/ +https://docs.djangoproject.com/en/5.2/howto/deployment/wsgi/ """ import os diff --git a/hello/migrations/0001_initial.py b/hello/migrations/0001_initial.py index 5d0aedd71..d24f6de46 100644 --- a/hello/migrations/0001_initial.py +++ b/hello/migrations/0001_initial.py @@ -1,4 +1,4 @@ -# Generated by Django 5.1 on 2024-08-09 09:38 +# Generated by Django 5.2 on 2025-04-06 14:54 from django.db import migrations, models diff --git a/requirements.txt b/requirements.txt index c420fa54c..7ce9e89f3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -django>=5.1,<5.2 +django>=5.2,<5.3 gunicorn>=23,<24 dj-database-url>=2,<3 whitenoise[brotli]>=6,<7 From 2a0d7609e68bfc3eed16d1b9c368837807f33a0c Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Tue, 17 Jun 2025 10:42:47 +0100 Subject: [PATCH 23/31] Exclude unnecessary files from local Pack CLI builds (#258) Exclude unnecessary files from images when building locally with `pack build`, where `.gitignore` doesn't apply. See: - https://buildpacks.io/docs/for-app-developers/how-to/build-inputs/use-project-toml/ - https://buildpacks.io/docs/reference/config/project-descriptor/#iobuildpacks-table-optional - https://github.com/buildpacks/spec/blob/main/extensions/project-descriptor.md#iobuildpacksinclude-optional-and-iobuildpacksexclude-optional Note: We have to omit trailing slashes from entries that are directories due to this upstream bug: https://github.com/buildpacks/pack/issues/2402 GUS-W-18705417. --- project.toml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 project.toml diff --git a/project.toml b/project.toml new file mode 100644 index 000000000..ec4f08cbd --- /dev/null +++ b/project.toml @@ -0,0 +1,19 @@ +[_] +schema-version = "0.2" + +[io.buildpacks] +# Exclude files from local Pack CLI builds, where .gitignore doesn't apply. +# TODO: Add trailing slash to entries that are directories, once this issue is fixed: +# https://github.com/buildpacks/pack/issues/2402 +exclude = [ + "__pycache__", + ".git", + ".gitignore", + ".github", + ".venv", + ".DS_Store", + ".env", + "staticfiles", + "db.sqlite3", + "venv", +] From aa8ad154840fdbbfe42b6d20bf14663b18ef9e6d Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Tue, 17 Jun 2025 13:36:02 +0100 Subject: [PATCH 24/31] Remove Brotli dependency (#259) Since the Brotli dependency adds ~7-8MB (depending on arch) to the app image (along with having to download/install the wheel during the build), and isn't currently used by the Getting Started guide, since it doesn't have any static assets that are compressible. ``` $ ls -alh /layers/heroku_python/venv/lib/python3.13/site-packages/ ... -rwxr-xr-x 1 heroku heroku 7.2M Jan 1 1980 _brotli.cpython-313-aarch64-linux-gnu.so ``` ``` $ ls -al /workspace/staticfiles/ total 16 drwxr-xr-x 2 heroku heroku 4096 Jan 1 1980 . drwxrwxrwx 5 heroku heroku 4096 Jan 1 1980 .. -rw-r--r-- 1 heroku heroku 2217 Jan 1 1980 lang-logo.019c8743b7cf.png -rw-r--r-- 1 heroku heroku 100 Jan 1 1980 staticfiles.json ``` See: https://whitenoise.readthedocs.io/en/latest/django.html#brotli-compression GUS-W-18705397. --- gettingstarted/settings.py | 2 +- requirements.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/gettingstarted/settings.py b/gettingstarted/settings.py index 55566786f..d6df80f99 100644 --- a/gettingstarted/settings.py +++ b/gettingstarted/settings.py @@ -196,7 +196,7 @@ STATIC_URL = "static/" STORAGES = { - # Enable WhiteNoise's GZip and Brotli compression of static assets: + # Enable WhiteNoise's GZip (and Brotli, if installed) compression of static assets: # https://whitenoise.readthedocs.io/en/latest/django.html#add-compression-and-caching-support "staticfiles": { "BACKEND": "whitenoise.storage.CompressedManifestStaticFilesStorage", diff --git a/requirements.txt b/requirements.txt index 7ce9e89f3..f8c3df4f4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,7 @@ django>=5.2,<5.3 gunicorn>=23,<24 dj-database-url>=2,<3 -whitenoise[brotli]>=6,<7 +whitenoise>=6,<7 # Uncomment these lines to use a Postgres database. Both are needed, since in production # (which uses Linux) we want to install from source, so that security updates from the From d992ff5fdea3f5b4ac696117129fa678938e40f7 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 1 Jul 2025 14:33:30 +0100 Subject: [PATCH 25/31] Update dj-database-url requirement from <3,>=2 to >=3,<4 (#260) * Update dj-database-url requirement from <3,>=2 to >=2,<4 Updates the requirements on [dj-database-url](https://github.com/jazzband/dj-database-url) to permit the latest version. - [Release notes](https://github.com/jazzband/dj-database-url/releases) - [Changelog](https://github.com/jazzband/dj-database-url/blob/master/CHANGELOG.md) - [Commits](https://github.com/jazzband/dj-database-url/compare/v2.0.0...v3.0.0) --- updated-dependencies: - dependency-name: dj-database-url dependency-version: 3.0.0 dependency-type: direct:production ... Signed-off-by: dependabot[bot] * Update requirements.txt Signed-off-by: Ed Morley <501702+edmorley@users.noreply.github.com> --------- Signed-off-by: dependabot[bot] Signed-off-by: Ed Morley <501702+edmorley@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ed Morley <501702+edmorley@users.noreply.github.com> --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index f8c3df4f4..a94fc0bba 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,6 @@ django>=5.2,<5.3 gunicorn>=23,<24 -dj-database-url>=2,<3 +dj-database-url>=3,<4 whitenoise>=6,<7 # Uncomment these lines to use a Postgres database. Both are needed, since in production From 3ca0fad7c3f19aa7261d5669973df0ce6b1e073f Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Wed, 30 Jul 2025 11:55:22 +0100 Subject: [PATCH 26/31] Raise the Keep-Alive idle timeout to 100 seconds (#261) Heroku's Router 2.0 now supports Keep-Alive connections: https://www.heroku.com/blog/tips-tricks-router-2dot0-migration/#keepalives-always-on https://devcenter.heroku.com/articles/http-routing#legacy-router-and-router-2-0 Gunicorn supports Keep-Alive connections, and so now if an app is using Router 2.0 connections between the router instances and the app will be kept alive. However, gunicorn's default `keepalive` idle timeout setting is only 5 seconds: https://docs.gunicorn.org/en/stable/settings.html#keepalive This is shorter than the 90 second Router 2.0 keep-alive timeout: https://devcenter.heroku.com/articles/http-routing#keepalives As such: (a) This causes connections to be closed sooner than they need to be (as noted in the gunicorn docs, the default 5 seconds is more suited for cases where many clients are connecting directly to gunicorn, rather than gunicorn being behind a load balancer). (b) there is a possibility of a race condition whereby gunicorn starts initiating the closing of an idle Keep-Alive connection just at the moment that the Heroku Router sends a new request to it. If this occurred, that new request could fail. This race condition isn't unique to Heroku or gunicorn, but applies to any load balancer/app server combination that supports Keep-Alive. For example, see AWS' explanation about this in their ELB docs: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/edit-load-balancer-attributes.html#connection-idle-timeout Therefore, the gunicorn idle timeout has been raised from 5 seconds to 100 seconds, so it is greater than the Router's idle timeout - ensuring that the router is always the one initiating connection closing (and the router will know to not send new requests to a connection it's in the middle of closing). GUS-W-18319007. --- gunicorn.conf.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/gunicorn.conf.py b/gunicorn.conf.py index 09e78a5d6..f908c3a68 100644 --- a/gunicorn.conf.py +++ b/gunicorn.conf.py @@ -49,6 +49,13 @@ # https://devcenter.heroku.com/articles/dyno-shutdown-behavior graceful_timeout = 20 +# The number of seconds an idle Keep-Alive connection is kept open. This should be greater than +# the Heroku Router's Keep-Alive idle timeout of 90 seconds, to ensure that the closing of idle +# connections is always initiated by the router and not gunicorn, to prevent a race condition +# if the router sends a request to the app just as gunicorn is closing the connection: +# https://devcenter.heroku.com/articles/http-routing#keepalives +keepalive = 100 + # Enable logging of incoming requests to stdout. accesslog = "-" From 5d9261188f60c80a40e50d2a49ad26f0ae457880 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Sat, 2 Aug 2025 11:03:00 +0100 Subject: [PATCH 27/31] Use `psycopg[binary]` on all platforms (#262) Since: - the binary wheel package is much faster to install than the compiled from source sdist, which is beneficial in an interactive tutorial scenario - the platform conditionals result in a more complicated requirements file (and confusing pip output about ignoring the `psycopg` package) which isn't ideal for beginners following the tutorial - it results in more deterministic app/dependencies (since the libpq version is now bundled with the package rather than being dynamically linked), and whilst this is a trade-off, it's more in keeping with the modern app approach of pinning dependencies using lockfiles etc GUS-W-19240129. --- requirements.txt | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/requirements.txt b/requirements.txt index a94fc0bba..d07820d18 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,10 +3,5 @@ gunicorn>=23,<24 dj-database-url>=3,<4 whitenoise>=6,<7 -# Uncomment these lines to use a Postgres database. Both are needed, since in production -# (which uses Linux) we want to install from source, so that security updates from the -# underlying Heroku stack image are picked up automatically, thanks to dynamic linking. -# On other platforms/in development, the precompiled binary package is used instead, to -# speed up installation and avoid errors from missing libraries/headers. -#psycopg[c]; sys_platform == "linux" -#psycopg[binary]; sys_platform != "linux" +# Uncomment to use a Postgres database. +#psycopg[binary] From be752c2a6714eaf312464e5dec5ab1a7a09e48b0 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Sun, 3 Aug 2025 11:10:34 +0100 Subject: [PATCH 28/31] Change the Keep-Alive idle timeout to 95 seconds (#263) For consistency with the timeout chosen by other languages since #261 landed: - https://github.com/heroku/heroku-buildpack-php/pull/823 - https://github.com/heroku/ruby-getting-started/pull/190 GUS-W-18319007. Signed-off-by: Ed Morley <501702+edmorley@users.noreply.github.com> --- gunicorn.conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gunicorn.conf.py b/gunicorn.conf.py index f908c3a68..c20e84407 100644 --- a/gunicorn.conf.py +++ b/gunicorn.conf.py @@ -54,7 +54,7 @@ # connections is always initiated by the router and not gunicorn, to prevent a race condition # if the router sends a request to the app just as gunicorn is closing the connection: # https://devcenter.heroku.com/articles/http-routing#keepalives -keepalive = 100 +keepalive = 95 # Enable logging of incoming requests to stdout. accesslog = "-" From f9ca3b88a2c821b8ae4216366408153b3f6dc46f Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Fri, 10 Oct 2025 11:26:47 +0100 Subject: [PATCH 29/31] Update to Python 3.14 (#264) https://blog.python.org/2025/10/python-3140-final-is-here.html https://devcenter.heroku.com/changelog-items/3419 GUS-W-17595780. --- .python-version | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.python-version b/.python-version index 24ee5b1be..a45d8a607 100644 --- a/.python-version +++ b/.python-version @@ -1 +1,2 @@ -3.13 +# The Python version to use for the project. +3.14 From 757dd9a19be4040fbd75558e6958cdc54a279f56 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Mon, 8 Dec 2025 13:29:10 +0000 Subject: [PATCH 30/31] Update to Django 6.0 (#267) See: https://www.djangoproject.com/weblog/2025/dec/03/django-60-released/ https://docs.djangoproject.com/en/6.0/releases/6.0/ The project was synced with Django's project scaffold via: ``` uvx --from django django-admin startproject gettingstarted && cd $_ uvx --from django django-admin startapp hello // copy files from new template into existing guide and revert changes where needed uv venv uv pip install -r requirements.txt uv run ./manage.py makemigrations uvx ruff format --preview // update Django version numbers in any stray docs URLs ``` GUS-W-17606286. --- Procfile | 2 +- gettingstarted/asgi.py | 2 +- gettingstarted/settings.py | 42 ++++++++++++++------------------ gettingstarted/urls.py | 4 +-- gettingstarted/wsgi.py | 2 +- hello/migrations/0001_initial.py | 2 +- requirements.txt | 2 +- 7 files changed, 25 insertions(+), 31 deletions(-) diff --git a/Procfile b/Procfile index 2dc630d1d..62e39fbe0 100644 --- a/Procfile +++ b/Procfile @@ -2,6 +2,6 @@ web: gunicorn --config gunicorn.conf.py gettingstarted.wsgi # Uncomment this `release` process if you are using a database, so that Django's model # migrations are run as part of app deployment, using Heroku's Release Phase feature: -# https://docs.djangoproject.com/en/5.2/topics/migrations/ +# https://docs.djangoproject.com/en/6.0/topics/migrations/ # https://devcenter.heroku.com/articles/release-phase #release: ./manage.py migrate --no-input diff --git a/gettingstarted/asgi.py b/gettingstarted/asgi.py index 010368f87..4c319693f 100644 --- a/gettingstarted/asgi.py +++ b/gettingstarted/asgi.py @@ -4,7 +4,7 @@ It exposes the ASGI callable as a module-level variable named ``application``. For more information on this file, see -https://docs.djangoproject.com/en/5.2/howto/deployment/asgi/ +https://docs.djangoproject.com/en/6.0/howto/deployment/asgi/ """ import os diff --git a/gettingstarted/settings.py b/gettingstarted/settings.py index d6df80f99..a4d5cf55b 100644 --- a/gettingstarted/settings.py +++ b/gettingstarted/settings.py @@ -1,13 +1,13 @@ """ Django settings for gettingstarted project. -Generated by 'django-admin startproject' using Django 5.2. +Generated by 'django-admin startproject' using Django 6.0. For more information on this file, see -https://docs.djangoproject.com/en/5.2/topics/settings/ +https://docs.djangoproject.com/en/6.0/topics/settings/ For the full list of settings and their values, see -https://docs.djangoproject.com/en/5.2/ref/settings/ +https://docs.djangoproject.com/en/6.0/ref/settings/ """ import os @@ -21,7 +21,7 @@ # Before using your Heroku app in production, make sure to review Django's deployment checklist: -# See https://docs.djangoproject.com/en/5.2/howto/deployment/checklist/ +# See https://docs.djangoproject.com/en/6.0/howto/deployment/checklist/ # Django requires a unique secret key for each Django app, that is used by several of its # security features. To simplify initial setup (without hardcoding the secret in the source @@ -29,7 +29,7 @@ # Django features break whenever an app restarts (for example, sessions will be logged out). # In your production Heroku apps you should set the `DJANGO_SECRET_KEY` config var explicitly. # Make sure to use a long unique value, like you would for a password. See: -# https://docs.djangoproject.com/en/5.2/ref/settings/#std-setting-SECRET_KEY +# https://docs.djangoproject.com/en/6.0/ref/settings/#std-setting-SECRET_KEY # https://devcenter.heroku.com/articles/config-vars # SECURITY WARNING: Keep the secret key used in production secret! SECRET_KEY = os.environ.get( @@ -40,7 +40,7 @@ # Django has a debug mode which shows more detailed error messages and also means static assets # can be served without having to run the production `collectstatic` command. However, this # debug mode *must only be enabled in development* for security and performance reasons: -# https://docs.djangoproject.com/en/5.2/ref/settings/#std-setting-DEBUG +# https://docs.djangoproject.com/en/6.0/ref/settings/#std-setting-DEBUG # Debug mode will be automatically enabled when the project is run via `heroku local` (which # loads the environment variables set in the `.env` file, where `ENVIRONMENT=development`). # SECURITY WARNING: Don't run with debug turned on in production! @@ -55,7 +55,7 @@ # On Heroku, it's safe to use a wildcard for `ALLOWED_HOSTS`, since the Heroku router performs # validation of the Host header in the incoming HTTP request. On other platforms you may need to # list the expected hostnames explicitly in production to prevent HTTP Host header attacks. See: - # https://docs.djangoproject.com/en/5.2/ref/settings/#std-setting-ALLOWED_HOSTS + # https://docs.djangoproject.com/en/6.0/ref/settings/#std-setting-ALLOWED_HOSTS ALLOWED_HOSTS = ["*"] # Redirect all non-HTTPS requests to HTTPS. This requires that: @@ -67,7 +67,7 @@ # app's `gunicorn.conf.py` for how this is done when using gunicorn. # # For maximum security, consider enabling HTTP Strict Transport Security (HSTS) headers too: - # https://docs.djangoproject.com/en/5.2/ref/middleware/#http-strict-transport-security + # https://docs.djangoproject.com/en/6.0/ref/middleware/#http-strict-transport-security SECURE_SSL_REDIRECT = True else: ALLOWED_HOSTS = [".localhost", "127.0.0.1", "[::1]", "0.0.0.0", "[::]"] @@ -78,11 +78,11 @@ # Several optional Django features that are present in the default `startproject` template have # been disabled since they are not used by this example app. To use them, uncomment the relevant # entries in `INSTALLED_APPS`, `MIDDLEWARE`, `TEMPLATES` and `urls.py`. See: -# https://docs.djangoproject.com/en/5.2/ref/contrib/admin/ -# https://docs.djangoproject.com/en/5.2/topics/auth/ -# https://docs.djangoproject.com/en/5.2/ref/contrib/contenttypes/ -# https://docs.djangoproject.com/en/5.2/topics/http/sessions/ -# https://docs.djangoproject.com/en/5.2/ref/contrib/messages/ +# https://docs.djangoproject.com/en/6.0/ref/contrib/admin/ +# https://docs.djangoproject.com/en/6.0/topics/auth/ +# https://docs.djangoproject.com/en/6.0/ref/contrib/contenttypes/ +# https://docs.djangoproject.com/en/6.0/topics/http/sessions/ +# https://docs.djangoproject.com/en/6.0/ref/contrib/messages/ INSTALLED_APPS = [ # Use WhiteNoise's runserver implementation instead of the Django default, for dev-prod parity. "whitenoise.runserver_nostatic", @@ -131,7 +131,7 @@ # Database -# https://docs.djangoproject.com/en/5.2/ref/settings/#databases +# https://docs.djangoproject.com/en/6.0/ref/settings/#databases if IS_HEROKU_APP: # In production on Heroku the database configuration is derived from the `DATABASE_URL` @@ -159,7 +159,7 @@ # Password validation -# https://docs.djangoproject.com/en/5.2/ref/settings/#auth-password-validators +# https://docs.djangoproject.com/en/6.0/ref/settings/#auth-password-validators AUTH_PASSWORD_VALIDATORS = [ { @@ -178,7 +178,7 @@ # Internationalization -# https://docs.djangoproject.com/en/5.2/topics/i18n/ +# https://docs.djangoproject.com/en/6.0/topics/i18n/ LANGUAGE_CODE = "en-us" @@ -190,7 +190,7 @@ # Static files (CSS, JavaScript, Images) -# https://docs.djangoproject.com/en/5.2/howto/static-files/ +# https://docs.djangoproject.com/en/6.0/howto/static-files/ STATIC_ROOT = BASE_DIR / "staticfiles" STATIC_URL = "static/" @@ -207,15 +207,9 @@ # https://whitenoise.readthedocs.io/en/latest/django.html#WHITENOISE_KEEP_ONLY_HASHED_FILES WHITENOISE_KEEP_ONLY_HASHED_FILES = True - -# Default primary key field type -# https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field - -DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField" - # Customise the default logging config, since by default full Django logs are only emitted when # `DEBUG=True` (which otherwise makes diagnosing errors much harder in production): -# https://docs.djangoproject.com/en/5.2/ref/logging/#default-logging-configuration +# https://docs.djangoproject.com/en/6.0/ref/logging/#default-logging-configuration # For more advanced logging you may want to try: https://django-structlog.readthedocs.io LOGGING = { "version": 1, diff --git a/gettingstarted/urls.py b/gettingstarted/urls.py index b35f43dbb..f1f285138 100644 --- a/gettingstarted/urls.py +++ b/gettingstarted/urls.py @@ -2,7 +2,7 @@ URL configuration for gettingstarted project. The `urlpatterns` list routes URLs to views. For more information please see: - https://docs.djangoproject.com/en/5.2/topics/http/urls/ + https://docs.djangoproject.com/en/6.0/topics/http/urls/ Examples: Function views 1. Add an import: from my_app import views @@ -24,6 +24,6 @@ path("", hello.views.index, name="index"), path("db/", hello.views.db, name="db"), # Uncomment this and the entry in `INSTALLED_APPS` if you wish to use the Django admin feature: - # https://docs.djangoproject.com/en/5.2/ref/contrib/admin/ + # https://docs.djangoproject.com/en/6.0/ref/contrib/admin/ # path("admin/", admin.site.urls), ] diff --git a/gettingstarted/wsgi.py b/gettingstarted/wsgi.py index ed57f4404..f3eaa28d8 100644 --- a/gettingstarted/wsgi.py +++ b/gettingstarted/wsgi.py @@ -4,7 +4,7 @@ It exposes the WSGI callable as a module-level variable named ``application``. For more information on this file, see -https://docs.djangoproject.com/en/5.2/howto/deployment/wsgi/ +https://docs.djangoproject.com/en/6.0/howto/deployment/wsgi/ """ import os diff --git a/hello/migrations/0001_initial.py b/hello/migrations/0001_initial.py index d24f6de46..a502ed715 100644 --- a/hello/migrations/0001_initial.py +++ b/hello/migrations/0001_initial.py @@ -1,4 +1,4 @@ -# Generated by Django 5.2 on 2025-04-06 14:54 +# Generated by Django 6.0 on 2025-12-08 13:11 from django.db import migrations, models diff --git a/requirements.txt b/requirements.txt index d07820d18..7194eee9a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -django>=5.2,<5.3 +django>=6.0,<6.1 gunicorn>=23,<24 dj-database-url>=3,<4 whitenoise>=6,<7 From 3ca39e09242fe94a7ab012843a3436905e769152 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 4 Feb 2026 12:42:29 +0000 Subject: [PATCH 31/31] Update gunicorn requirement from <24,>=23 to >=25,<26 (#270) * Update gunicorn requirement from <24,>=23 to >=23,<26 Updates the requirements on [gunicorn](https://github.com/benoitc/gunicorn) to permit the latest version. - [Release notes](https://github.com/benoitc/gunicorn/releases) - [Commits](https://github.com/benoitc/gunicorn/compare/23.0.0...25.0.1) --- updated-dependencies: - dependency-name: gunicorn dependency-version: 25.0.1 dependency-type: direct:production ... Signed-off-by: dependabot[bot] * Increase requirement version lower bound --------- Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ed Morley <501702+edmorley@users.noreply.github.com> --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 7194eee9a..613c33924 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ django>=6.0,<6.1 -gunicorn>=23,<24 +gunicorn>=25,<26 dj-database-url>=3,<4 whitenoise>=6,<7