Merge pull request #25 from angloc/review/update-paths

Review/update paths

Author: sikanderakbarali

.devcontainer/Dockerfile

@@ -0,0 +1,21 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.224.2/containers/python-3/.devcontainer/base.Dockerfile
+
+# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster
+ARG VARIANT="3.10-bullseye"
+FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image.
+# COPY requirements.txt /tmp/pip-tmp/
+# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \
+#    && rm -rf /tmp/pip-tmp
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

.devcontainer/devcontainer.json

@@ -0,0 +1,62 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.224.2/containers/python-3
+{
+	"name": "Python 3",
+	"build": {
+		"dockerfile": "Dockerfile",
+		"context": "..",
+		"args": { 
+			// Update 'VARIANT' to pick a Python version: 3, 3.10, 3.9, 3.8, 3.7, 3.6
+			// Append -bullseye or -buster to pin to an OS version.
+			// Use -bullseye variants on local on arm64/Apple Silicon.
+			"VARIANT": "3.10-bullseye",
+			// Options
+			"NODE_VERSION": "lts/*"
+		}
+	},
+
+	// Set *default* container specific settings.json values on container create.
+	"settings": { 
+		"python.defaultInterpreterPath": "/usr/local/bin/python",
+		"python.linting.enabled": true,
+		"python.linting.pylintEnabled": true,
+		"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+		"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+		"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+		"python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+		"python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+		"python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+		"python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+		"python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+		"python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
+	},
+
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"ms-python.python",
+		"ms-python.vscode-pylance"
+	],
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "./scripts/install-hooks.sh",
+
+	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode",
+	"features": {
+		"docker-from-docker": "latest",
+		"git": "latest"
+	},
+	//"runArgs": ["--init"],
+	//"overrideCommand": false,
+	"remoteEnv": {
+		"LOCAL_WORKSPACE_FOLDER": "${localWorkspaceFolder}",
+		// Uncomment below if host is Windows/WSL (untested)
+		// per https://docs.docker.com/compose/reference/envvars/
+		// "COMPOSE_FORCE_WINDOWS_HOST": "true"
+	},
+
+
+}

Dockerfile

@@ -1,9 +1,9 @@
 # Docker configuration for backend development. Not created for production use.
 # It does not include front-end .
 # Main production build is done using Dockerfile in the root of the project
-FROM breneser/mssql-python-nodejs
+FROM python:3.10-bullseye
 
 WORKDIR /code
 ADD requirements.txt /code/
-RUN pip install -r requirements.txt
+RUN python -V && pip install --upgrade pip && pip install -r requirements.txt
 ADD . /code

README.md

@@ -15,6 +15,20 @@ INSTALLED_APPS = [
 ]
 ```
 
+Useful Imports
+--------------
+```python
+from django.db import models
+from django.db.models.signals import pre_save
+
+from wagtail.admin.edit_handlers import FieldPanel, TabbedInterface, ObjectList, PageChooserPanel
+from wagtail.core.models import Page
+
+from wagtailreacttaxonomy.models import TaxonomyMixin, PageTaxonomyPermissionsMixin,\
+    ModelTaxonomyPermissionsMixin, format_permissions_json
+from wagtailreacttaxonomy.edit_handlers import TaxonomyPanel, PermissionsPanel
+```
+
 How to use Taxonomy Term Component
 ----------------------------------
 
@@ -99,26 +113,50 @@ pre_save.connect(format_permissions_json, sender=TestModel)
 How to contribute
 -----------------
 
-### Requirements
+### Getting started
+
+#### With devcontainer and VSCode (recommended)
+
+* Open repository folder in container
+
+#### Build locally (old school)
+
+##### Requirements
 * Docker
 * docker-compose
-You'll get all this lot installed nicely with (https://docs.docker.com/docker-for-mac/install).
 
+You'll get all this lot installed nicely with https://docs.docker.com/docker-for-mac/install.
 
-### Setup locally
-Add git hook
+### Add git hook
 ```
 ./scripts/install-hooks.sh
 ```
-Build the image
+Now you are set
+
+### Build the containers
 ```
 docker-compose build
 ```
-Run the containers
+### Create super user
+```
+docker-compose run --rm web python manage.py createsuperuser
+```
+### Exercise the application
+
+#### Run the containers
 ```
 docker-compose up
 ```
-Create super user:
+
+#### Browse to http://localhost:8000/admin and make your changes with live reload
+
+1. Log in as superuser
+1. You will see a Taxonomy Terms entry in the admin menu
+1. Use this entry to upload and save the JSON text of your taxonomy
+1. Taxonomies are stored in your Django media folder (media in the test configuration)
+
+### Run tests as required
+
 ```
-docker-compose run --rm web python manage.py createsuperuser
+docker-compose run --rm web python manage.py test
 ```

config/settings/base.py

@@ -18,6 +18,7 @@
 PROJECT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 BASE_DIR = os.path.dirname(PROJECT_DIR)
 
+DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'
 
 # Quick-start development settings - unsuitable for production
 # See https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/
@@ -40,7 +41,7 @@
     'wagtail.images',
     'wagtail.search',
     'wagtail.admin',
-    'wagtail.core',
+    'wagtail',
     'wagtail.contrib.settings',
     'wagtail.api.v2',
     'wagtail.contrib.modeladmin',
@@ -72,7 +73,6 @@
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
     'django.middleware.security.SecurityMiddleware',
-    'wagtail.core.middleware.SiteMiddleware',
     'wagtail.contrib.redirects.middleware.RedirectMiddleware',
 ]
 
@@ -178,17 +178,11 @@
 
 # Base URL to use when referring to full URLs within the Wagtail admin backend -
 # e.g. in notification emails. Don't include '/admin' or a trailing slash
-BASE_URL = 'http://example.com'
+WAGTAILADMIN_BASE_URL = 'http://example.com'
 
 # WAGTAILIMAGES_IMAGE_MODEL = 'wagtailapiimagerendition.CustomImage'
 WAGTAIL_USAGE_COUNT_ENABLED = True
 
-# DEFAULT_FILE_STORAGE = 'storages.backends.azure_storage.AzureStorage'
-AZURE_ACCOUNT_NAME = os.environ.get('AZURE_ACCOUNT_NAME')    # eg. 'campaignstorage'
-AZURE_ACCOUNT_KEY = os.environ.get('AZURE_ACCOUNT_KEY')      # eg. '<secret key>'
-AZURE_CONTAINER = os.environ.get('AZURE_CONTAINER')          # eg. 'campaign-resource-centre'
-AZURE_FILE_SHARE = os.environ.get('AZURE_FILE_SHARE')
-
 ENV = os.environ.get('CMS_ENV', 'local')
 
 # INITIALIZER = os.environ.get('INITIALIZER', False)

docker-compose.yml

@@ -8,7 +8,7 @@ services:
     ports:
       - "5432:5432"
     volumes:
-      - ./db:/var/lib/postgresql/data
+      - ${LOCAL_WORKSPACE_FOLDER:-.}/db:/var/lib/postgresql/data
   web:
     environment:
       HAY_DEBUG: "True"
@@ -26,7 +26,7 @@ services:
     build: .
     command: bash -c "./scripts/wait-for-it.sh db:5432 -- python3 ./manage.py migrate && python3 manage.py load_test_data_fixtures && python3 ./manage.py runserver 0.0.0.0:8000"
     volumes:
-      - .:/code
+      - ${LOCAL_WORKSPACE_FOLDER:-.}:/code
     ports:
       - "8000:8000"
     depends_on:

requirements.txt

@@ -1,14 +1,13 @@
-Django>=3.1,<3.2
-wagtail>=2.10,<2.11
+Django~=4.0
+wagtail~=3.0
 psycopg2>=2.8,<2.9
 python-crontab>=2.5,<2.6
 django-cors-headers>=3.5,<3.6
-django-storages>=1.10,<1.11
-azure>=4,<5
+django-storages~=1.12
 coverage>=5.2,<5.3
 gunicorn>=20.0,<20.1
 flake8>=3.8,<3.9
-django-debug-toolbar>=2.2,<2.3
+django-debug-toolbar~=3.2
 factory-boy>=3.0,<3.1
-django_extensions>=3.0,<3.1
+django_extensions~=3.1
 safety

test_page/management/commands/load_test_data_fixtures.py

@@ -4,7 +4,7 @@
 from django.core.management import call_command
 from django.core.management.base import BaseCommand
 
-from wagtail.core.models import Page
+from wagtail.models import Page
 
 class Command(BaseCommand):
     """ Command """

test_page/models.py

@@ -1,8 +1,8 @@
 from django.db import models
 from django.db.models.signals import pre_save
 
-from wagtail.admin.edit_handlers import FieldPanel, TabbedInterface, ObjectList, PageChooserPanel
-from wagtail.core.models import Page
+from wagtail.admin.panels import FieldPanel, TabbedInterface, ObjectList, PageChooserPanel
+from wagtail.models import Page
 
 from wagtailreacttaxonomy.models import TaxonomyMixin, PageTaxonomyPermissionsMixin, ModelTaxonomyPermissionsMixin, format_permissions_json
 from wagtailreacttaxonomy.edit_handlers import TaxonomyPanel, PermissionsPanel

tests.py

@@ -1,4 +1,4 @@
-from wagtail.tests.utils import WagtailPageTests
+from wagtail.test.utils import WagtailPageTests
 
 
 class TestNameClassTests(WagtailPageTests):