ci: Move to Django CMS 4.1rc3 (#41)

* Update readme

* Update to django CMS 4.1rc3

Author: fsbraun

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.10
+FROM python:3.11
 WORKDIR /app
 COPY . /app
 RUN pip install -r requirements.txt

README.md

@@ -0,0 +1,105 @@
+|pythonapp|
+
+#####################
+django CMS quickstart
+#####################
+
+A Dockerised django CMS project, ready to deploy on `Divio <https://www.divio.com/>`_ or another Docker-based cloud platform, and run locally in Docker on your own machine.
+
+This version uses Python 3.10 running and the most up-to-date versions of Django 3.2, and django CMS 4.1.0rc1
+
+This project is endorsed by the `django CMS Association <https://www.django-cms.org/en/about-us/>`_. That means that it is officially accepted by the dCA as being in line with our roadmap vision and development/plugin policy. Join us on `Slack <https://www.django-cms.org/slack/>`_ for more information or questions.
+
+The documentation for version 4.1 is still work in progress and - for the time being - can be found here: https://django-cms-docs.readthedocs.io/en/latest/
+
+Installation
+############
+
+You need to have docker installed on your system to run this project.
+
+- `Install Docker <https://docs.docker.com/engine/install/>`_ here.
+- If you have not used docker in the past, please read this `introduction on docker <https://docs.docker.com/get-started/>`_  here.
+
+Try it
+######
+
+.. inclusion-marker-do-not-remove
+
+.. code-block:: bash
+
+  git clone git@github.com:django-cms/django-cms-quickstart.git
+  cd django-cms-quickstart
+  git switch -t origin/support/cms-4.1.x
+  docker compose build web
+  docker compose up -d database_default
+  docker compose run web python manage.py migrate
+  docker compose run web python manage.py createsuperuser
+  docker compose up -d
+
+Then open http://django-cms-quickstart.127.0.0.1.nip.io:8000 (or just http://127.0.0.1:8000) in your browser.
+
+Note: Since Compose V2, ``docker-compose`` is now included inside docker. For more information, checkout the `Compose V2 <https://docs.docker.com/compose/cli-command/>`_ Documentation.
+
+.. inclusion-end-marker-do-not-remove
+
+Customising the project
+#######################
+
+This project is ready-to-go without making any changes at all, but also gives you some options.
+
+As-is, it will include a number of useful django CMS plugins and Bootstrap 4 for the frontend. You don't have to use
+these; they're optional. If you don't want to use them, read through the ``settings.py`` and ``requirements.txt`` files to
+see sections that can be removed - in each case, the section is noted with a comment containing the word 'optional'.
+
+Options are also available for using Postgres/MySQL, uWSGI/Gunicorn/Guvicorn, etc.
+
+Updating requirements
+=====================
+
+The project uses a 2 step approach, freezing all dependencies with pip-tools. Read more about how to handle it here: https://blog.typodrive.com/2020/02/04/always-freeze-requirements-with-pip-compile-to-avoid-unpleasant-surprises/
+
+Features
+########
+
+Static Files with Whitenoise
+============================
+
+This quickstart demo has a cloud-ready static files setup via django-whitenoise.
+
+In the containerized cloud the application is not served by a web server like nginx but directly through uwsgi. django-whitenoise is the glue that's needed to serve static files in your application directly through uwsgi.
+
+See the django-whitenoise settings in settings.py and the ``quickstart/templates/whitenoise-static-files-demo.html`` demo page template that serves a static file.
+
+Contribution
+############
+
+Here is the official django CMS repository: `https://github.com/django-cms/django-cms-quickstart/ <https://github.com/django-cms/django-cms-quickstart/>`_.
+
+
+Deployment
+##########
+
+Note that this is just a demo project to get you started. If you want a full production ready site with all the bells and whistles we recommend you have a look at https://github.com/django-cms/djangocms-template instead.
+
+Env variables
+=============
+
+- to deploy this project in testing mode (recommended) set the environment variable ``DEBUG`` to ``True`` in your hosting environment.
+- For production environment (if ``DEBUG`` is false) django requires you to whitelist the domain. Set the env var ``DOMAIN`` to the host, i.e. ``www.domain.com`` or ``*.domain.com``.
+- If you want the media hosted on S3 set the ``DEFAULT_FILE_STORAGE`` variable accordingly.
+
+Deployment Commands
+===================
+
+Configure your hosting environment to run the following commands on every deployment:
+
+- ``./manage.py migrate``
+
+
+Divio Deployment
+================
+
+divio.com is a cloud hosting platform optimized for django web applications. It's the quickest way to deploy this project. Here is a `video tutorial <https://www.youtube.com/watch?v=O2g5Wfoyp7Q>`_ and a `description of the deployment steps <https://github.com/django-cms/djangocms-template/blob/mco-standalone/docs/deployment-divio.md#divio-project-setup>`_ that are mostly applicable for this quickstart project.
+
+
+.. |pythonapp| image:: https://github.com/django-cms/django-cms-quickstart/workflows/Python%20application/badge.svg?branch=support/cms-4.1.x

README.rst

@@ -60,9 +60,7 @@
     # the default CKEditor - optional, but used in most projects
     'djangocms_text_ckeditor',
 
-    'djangocms_picture',
-
-    # optional django CMS Bootstrap 4 modules
+    # optional django CMS frontend modules
     'djangocms_frontend',
     'djangocms_frontend.contrib.accordion',
     'djangocms_frontend.contrib.alert',
@@ -76,6 +74,7 @@
     'djangocms_frontend.contrib.link',
     'djangocms_frontend.contrib.listgroup',
     'djangocms_frontend.contrib.media',
+    'djangocms_frontend.contrib.icon',
     'djangocms_frontend.contrib.image',
     'djangocms_frontend.contrib.tabs',
     'djangocms_frontend.contrib.utilities',
@@ -221,3 +220,4 @@
 DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'
 
 CMS_CONFIRM_VERSION4 = True
+DJANGOCMS_VERSIONING_ALLOW_DELETING_VERSIONS = True

backend/settings.py

@@ -12,10 +12,9 @@ whitenoise
 easy-thumbnails
 
 # key requirements for django CMS
-django-cms==4.1.0rc1
-https://github.com/divio/djangocms-versioning/tarball/master#egg=djangocms-versioning
-https://github.com/divio/djangocms-alias/tarball/master#egg=djangocms-alias
-djangocms-picture
+django-cms>=4.1.0rc3
+https://github.com/django-cms/djangocms-versioning/tarball/master#egg=djangocms-versioning
+https://github.com/django-cms/djangocms-alias/tarball/master#egg=djangocms-alias
 
 # optional, but used in most projects
 djangocms-admin-style>=3.2.2