Remove dependency on Azure storage and update documentation

Author: angloc

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
 ----------------------------------
 
@@ -110,34 +124,38 @@ How to contribute
 ##### Requirements
 * Docker
 * docker-compose
-You'll get all this lot installed nicely with (https://docs.docker.com/docker-for-mac/install).
 
-##### Add git hook
+You'll get all this lot installed nicely with https://docs.docker.com/docker-for-mac/install.
+
+### Add git hook
 ```
 ./scripts/install-hooks.sh
 ```
+Now you are set
 
-### Now you are set
-
-#### Build the containers
+### Build the containers
 ```
 docker-compose build
 ```
-#### Create super user
+### Create super user
 ```
 docker-compose run --rm web python manage.py createsuperuser
 ```
-#### Exercise the application
-
-##### Run the containers
+### Exercise the application
 
+#### Run the containers
 ```
 docker-compose up
 ```
 
-##### Browse to http://localhost:8000/admin and make your changes with live reload
+#### 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
+### Run tests as required
 
 ```
 docker-compose run --rm web python manage.py test

config/settings/base.py

@@ -183,12 +183,6 @@
 # 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)

requirements.txt

@@ -3,11 +3,7 @@ wagtail~=2.16
 psycopg2>=2.8,<2.9
 python-crontab>=2.5,<2.6
 django-cors-headers>=3.5,<3.6
-django-storages[azure]~=1.12
-azure-storage-common~=2.1
-azure-storage-file~=2.1
-azure-storage-blob~=12.9
-azure-core~=1.23
+django-storages~=1.12
 coverage>=5.2,<5.3
 gunicorn>=20.0,<20.1
 flake8>=3.8,<3.9

wagtailreacttaxonomy/models.py

@@ -2,11 +2,8 @@
 import logging
 from django.conf import settings
 
-from azure.storage.file import FileService
-from azure.common import AzureMissingResourceHttpError
-from azure.storage.file.models import File as AzureFile, Directory as AzureDirectory
-
-from azure.storage.blob import BlobServiceClient
+from django.core.files.base import ContentFile
+from django.core.files.storage import default_storage
 
 from django.db import models
 from django.db.models.signals import pre_save
@@ -30,12 +27,13 @@ def update_taxonomy_terms_on_blobstore(sender, instance, **kwargs):
         content['terms'] = terms_with_vocab
 
         blobPath = f'taxonomy/{instance.taxonomy_id}.json'
-        blob_service = BlobServiceClient(account_name=settings.AZURE_ACCOUNT_NAME, account_key=settings.AZURE_ACCOUNT_KEY)
-        blob_service.create_blob_from_text(settings.AZURE_CONTAINER, blobPath, to_json(content))
+        blobFile = ContentFile (to_json (content))
+        default_storage.save (blobPath, blobFile)
         logger.info('Successfully wrote taxonomy json to BlobStore %s', blobPath)
 
     except Exception as e:
         logger.info('Could not build taxonomy json and send to BlobStore %s', e)
+        raise
 
 def get_terms_from_terms_json(data):
     terms = dict()
@@ -105,5 +103,4 @@ def format_permissions_json(sender, instance, **kwargs):
         for action_key, vocs in groups.items():
             permissions_json_formatted[group_key].extend(['{0}.{1}'.format(action_key, voc) for voc in vocs])
     instance.permissions_json_formatted = permissions_json_formatted
-    print(permissions_json_formatted)
     return instance