kp-forks · pull · Mar 31, 2024 · Mar 26, 2024 · Mar 27, 2024 · Mar 27, 2024
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -26,7 +26,7 @@ repos:
         args: ["--tab-width", "2"]
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.1
+    rev: v3.15.2
     hooks:
       - id: pyupgrade
         args: [--py312-plus]

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,33 @@ All enhancements and patches to Cookiecutter Django will be documented in this f
 
 <!-- GENERATOR_PLACEHOLDER -->
 
+## 2024.03.29
+
+
+### Documentation
+
+- Add instruction for adding a django app ([#4944](https://github.com/cookiecutter/cookiecutter-django/pull/4944))
+
+## 2024.03.27
+
+
+### Updated
+
+- Update pre-commit to 3.7.0 ([#4943](https://github.com/cookiecutter/cookiecutter-django/pull/4943))
+
+- Update djangorestframework to 3.15.1 ([#4941](https://github.com/cookiecutter/cookiecutter-django/pull/4941))
+
+- Update ruff to 0.3.4 ([#4936](https://github.com/cookiecutter/cookiecutter-django/pull/4936))
+
+- Auto-update pre-commit hooks ([#4937](https://github.com/cookiecutter/cookiecutter-django/pull/4937))
+
+## 2024.03.26
+
+
+### Documentation
+
+- Update mentions of psycopg in comments ([#4947](https://github.com/cookiecutter/cookiecutter-django/pull/4947))
+
 ## 2024.03.21
 
 

diff --git a/docs/developing-locally.rst b/docs/developing-locally.rst
@@ -96,6 +96,61 @@ First things first.
 .. _direnv: https://direnv.net/
 
 
+Creating Your First Django App
+-------------------------------
+
+After setting up your environment, you're ready to add your first app. This project uses the setup from "Two Scoops of Django" with a two-tier layout:
+
+- **Top Level Repository Root** has config files, documentation, `manage.py`, and more.
+- **Second Level Django Project Root** is where your Django apps live.
+- **Second Level Configuration Root** holds settings and URL configurations.
+
+The project layout looks something like this: ::
+
+    <repository_root>/
+    ├── config/
+    │   ├── settings/
+    │   │   ├── __init__.py
+    │   │   ├── base.py
+    │   │   ├── local.py
+    │   │   └── production.py
+    │   ├── urls.py
+    │   └── wsgi.py
+    ├── <django_project_root>/
+    │   ├── <name_of_the_app>/
+    │   │   ├── migrations/
+    │   │   ├── admin.py
+    │   │   ├── apps.py
+    │   │   ├── models.py
+    │   │   ├── tests.py
+    │   │   └── views.py
+    │   ├── __init__.py
+    │   └── ...
+    ├── requirements/
+    │   ├── base.txt
+    │   ├── local.txt
+    │   └── production.txt
+    ├── manage.py
+    ├── README.md
+    └── ...
+
+
+Following this structured approach, here's how to add a new app:
+
+#. **Create the app** using Django's ``startapp`` command, replacing ``<name-of-the-app>`` with your desired app name: ::
+
+    $ python manage.py startapp <name-of-the-app>
+
+#. **Move the app** to the Django Project Root, maintaining the project's two-tier structure: ::
+
+    $ mv <name-of-the-app> <django_project_root>/
+
+#. **Edit the app's apps.py** change ``name = '<name-of-the-app>'`` to ``name = '<django_project_root>.<name-of-the-app>'``.
+
+#. **Register the new app** by adding it to the ``LOCAL_APPS`` list in ``config/settings/base.py``, integrating it as an official component of your project.
+
+
+
 Setup Email Backend
 -------------------
 

diff --git a/requirements.txt b/requirements.txt
@@ -4,14 +4,14 @@ binaryornot==0.4.4
 
 # Code quality
 # ------------------------------------------------------------------------------
-ruff==0.3.3
+ruff==0.3.4
 django-upgrade==1.16.0
 djlint==1.34.1
-pre-commit==3.6.2
+pre-commit==3.7.0
 
 # Testing
 # ------------------------------------------------------------------------------
-tox==4.14.1
+tox==4.14.2
 pytest==8.1.1
 pytest-xdist==3.5.0
 pytest-cookies==0.7.0
@@ -20,7 +20,7 @@ pyyaml==6.0.1
 
 # Scripting
 # ------------------------------------------------------------------------------
-PyGithub==2.2.0
+PyGithub==2.3.0
 gitpython==3.1.42
 jinja2==3.1.3
 requests==2.31.0
diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
     from distutils.core import setup
 
 # We use calendar versioning
-version = "2024.03.21"
+version = "2024.03.29"
 
 with open("README.md") as readme_file:
     long_description = readme_file.read()

diff --git a/{{cookiecutter.project_slug}}/.pre-commit-config.yaml b/{{cookiecutter.project_slug}}/.pre-commit-config.yaml
@@ -35,7 +35,7 @@ repos:
 
   # Run the Ruff linter.
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.3
+    rev: v0.3.4
     hooks:
       # Linter
       - id: ruff

diff --git a/{{cookiecutter.project_slug}}/compose/local/django/Dockerfile b/{{cookiecutter.project_slug}}/compose/local/django/Dockerfile
@@ -10,7 +10,7 @@ ARG BUILD_ENVIRONMENT=local
 RUN apt-get update && apt-get install --no-install-recommends -y \
   # dependencies for building Python packages
   build-essential \
-  # psycopg2 dependencies
+  # psycopg dependencies
   libpq-dev
 
 # Requirements are installed here to ensure they will be cached.
@@ -47,7 +47,7 @@ RUN groupadd --gid 1000 dev-user \
 
 # Install required system dependencies
 RUN apt-get update && apt-get install --no-install-recommends -y \
-  # psycopg2 dependencies
+  # psycopg dependencies
   libpq-dev \
   # Translations dependencies
   gettext \

diff --git a/{{cookiecutter.project_slug}}/compose/local/docs/Dockerfile b/{{cookiecutter.project_slug}}/compose/local/docs/Dockerfile
@@ -10,7 +10,7 @@ ENV PYTHONDONTWRITEBYTECODE 1
 RUN apt-get update && apt-get install --no-install-recommends -y \
   # dependencies for building Python packages
   build-essential \
-  # psycopg2 dependencies
+  # psycopg dependencies
   libpq-dev \
   # cleaning up unused files
   && apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false \
@@ -35,7 +35,7 @@ ENV PYTHONDONTWRITEBYTECODE 1
 RUN apt-get update && apt-get install --no-install-recommends -y \
   # To run the Makefile
   make \
-  # psycopg2 dependencies
+  # psycopg dependencies
   libpq-dev \
   # Translations dependencies
   gettext \

diff --git a/{{cookiecutter.project_slug}}/compose/production/django/Dockerfile b/{{cookiecutter.project_slug}}/compose/production/django/Dockerfile
@@ -36,7 +36,7 @@ ARG BUILD_ENVIRONMENT=production
 RUN apt-get update && apt-get install --no-install-recommends -y \
   # dependencies for building Python packages
   build-essential \
-  # psycopg2 dependencies
+  # psycopg dependencies
   libpq-dev
 
 # Requirements are installed here to ensure they will be cached.
@@ -65,7 +65,7 @@ RUN addgroup --system django \
 
 # Install required system dependencies
 RUN apt-get update && apt-get install --no-install-recommends -y \
-  # psycopg2 dependencies
+  # psycopg dependencies
   libpq-dev \
   # Translations dependencies
   gettext \

diff --git a/{{cookiecutter.project_slug}}/requirements/base.txt b/{{cookiecutter.project_slug}}/requirements/base.txt
@@ -40,7 +40,7 @@ django-compressor==4.4  # https://github.com/django-compressor/django-compressor
 django-redis==5.4.0  # https://github.com/jazzband/django-redis
 {%- if cookiecutter.use_drf == 'y' %}
 # Django REST Framework
-djangorestframework==3.15.0  # https://github.com/encode/django-rest-framework
+djangorestframework==3.15.1  # https://github.com/encode/django-rest-framework
 django-cors-headers==4.3.1  # https://github.com/adamchainz/django-cors-headers
 # DRF-spectacular for api documentation
 drf-spectacular==0.27.1  # https://github.com/tfranzel/drf-spectacular

diff --git a/{{cookiecutter.project_slug}}/requirements/local.txt b/{{cookiecutter.project_slug}}/requirements/local.txt
@@ -28,10 +28,10 @@ sphinx-autobuild==2024.2.4 # https://github.com/GaretJax/sphinx-autobuild
 
 # Code quality
 # ------------------------------------------------------------------------------
-ruff==0.3.3  # https://github.com/astral-sh/ruff
+ruff==0.3.4  # https://github.com/astral-sh/ruff
 coverage==7.4.4  # https://github.com/nedbat/coveragepy
 djlint==1.34.1  # https://github.com/Riverside-Healthcare/djLint
-pre-commit==3.6.2  # https://github.com/pre-commit/pre-commit
+pre-commit==3.7.0  # https://github.com/pre-commit/pre-commit
 
 # Django
 # ------------------------------------------------------------------------------

diff --git a/{{cookiecutter.project_slug}}/utility/requirements-bionic.apt b/{{cookiecutter.project_slug}}/utility/requirements-bionic.apt
@@ -9,7 +9,7 @@ python3-dev
 ##Pillow, pylibmc
 zlib1g-dev
 
-##Postgresql and psycopg2 dependencies
+##Postgresql and psycopg dependencies
 libpq-dev
 
 ##Pillow dependencies

diff --git a/{{cookiecutter.project_slug}}/utility/requirements-bookworm.apt b/{{cookiecutter.project_slug}}/utility/requirements-bookworm.apt
@@ -9,7 +9,7 @@ python3-dev
 ##Pillow, pylibmc
 zlib1g-dev
 
-##Postgresql and psycopg2 dependencies
+##Postgresql and psycopg dependencies
 libpq-dev
 
 ##Pillow dependencies

diff --git a/{{cookiecutter.project_slug}}/utility/requirements-bullseye.apt b/{{cookiecutter.project_slug}}/utility/requirements-bullseye.apt
@@ -9,7 +9,7 @@ python3-dev
 ##Pillow, pylibmc
 zlib1g-dev
 
-##Postgresql and psycopg2 dependencies
+##Postgresql and psycopg dependencies
 libpq-dev
 
 ##Pillow dependencies

diff --git a/{{cookiecutter.project_slug}}/utility/requirements-buster.apt b/{{cookiecutter.project_slug}}/utility/requirements-buster.apt
@@ -9,7 +9,7 @@ python3-dev
 ##Pillow, pylibmc
 zlib1g-dev
 
-##Postgresql and psycopg2 dependencies
+##Postgresql and psycopg dependencies
 libpq-dev
 
 ##Pillow dependencies

diff --git a/{{cookiecutter.project_slug}}/utility/requirements-focal.apt b/{{cookiecutter.project_slug}}/utility/requirements-focal.apt
@@ -9,7 +9,7 @@ python3-dev
 ##Pillow, pylibmc
 zlib1g-dev
 
-##Postgresql and psycopg2 dependencies
+##Postgresql and psycopg dependencies
 libpq-dev
 
 ##Pillow dependencies

diff --git a/{{cookiecutter.project_slug}}/utility/requirements-jammy.apt b/{{cookiecutter.project_slug}}/utility/requirements-jammy.apt
@@ -9,7 +9,7 @@ python3-dev
 ##Pillow, pylibmc
 zlib1g-dev
 
-##Postgresql and psycopg2 dependencies
+##Postgresql and psycopg dependencies
 libpq-dev
 
 ##Pillow dependencies

diff --git a/{{cookiecutter.project_slug}}/utility/requirements-jessie.apt b/{{cookiecutter.project_slug}}/utility/requirements-jessie.apt
@@ -9,7 +9,7 @@ python3-dev
 ##Pillow, pylibmc
 zlib1g-dev
 
-##Postgresql and psycopg2 dependencies
+##Postgresql and psycopg dependencies
 libpq-dev
 
 ##Pillow dependencies

diff --git a/{{cookiecutter.project_slug}}/utility/requirements-stretch.apt b/{{cookiecutter.project_slug}}/utility/requirements-stretch.apt
@@ -9,7 +9,7 @@ python3-dev
 ##Pillow, pylibmc
 zlib1g-dev
 
-##Postgresql and psycopg2 dependencies
+##Postgresql and psycopg dependencies
 libpq-dev
 
 ##Pillow dependencies

diff --git a/{{cookiecutter.project_slug}}/utility/requirements-trusty.apt b/{{cookiecutter.project_slug}}/utility/requirements-trusty.apt
@@ -9,7 +9,7 @@ python3-dev
 ##Pillow, pylibmc
 zlib1g-dev
 
-##Postgresql and psycopg2 dependencies
+##Postgresql and psycopg dependencies
 libpq-dev
 
 ##Pillow dependencies

diff --git a/{{cookiecutter.project_slug}}/utility/requirements-xenial.apt b/{{cookiecutter.project_slug}}/utility/requirements-xenial.apt
@@ -9,7 +9,7 @@ python3-dev
 ##Pillow, pylibmc
 zlib1g-dev
 
-##Postgresql and psycopg2 dependencies
+##Postgresql and psycopg dependencies
 libpq-dev
 
 ##Pillow dependencies