Update to Python 3.8 and Django 1.11

.gitignore

@@ -111,3 +111,6 @@ solr-webapp
 
 # Source for an editable project that pip installed
 src
+
+# MEDIA_ROOT for uploads
+uipa_org/uploads/

README.md

@@ -1,129 +1,34 @@
-[![Stories in Ready](https://badge.waffle.io/codeforhawaii/uipa_org.png?label=ready&title=Ready)](https://waffle.io/codeforhawaii/uipa_org)
-
 # UIPA.org - Uniform Information Practices Act portal
 
-This is a basic Django project with a theme app that plugs into
-[Froide](https://github.com/stefanw/froide). It's based on the [Froide Base
-Theme](https://github.com/okfde/froide-theme).
+> This branch is a departure from the main branch. It seeks to satisfy the goal
+> of upgrading UIPA.org to currently supported versions of Python and Django
+> without upgrading Froide to a newer upstream version.
+
+This started as a Django project forked from the [Froide
+Theme](https://github.com/okfde/froide-theme). This is a theme app that plugs
+into [Froide](https://github.com/stefanw/froide) and is the recommended way of
+creating a FOIA website by the Froide developers.
+
+It will be easier to upgrade and maintain the UIPA project by combining the
+Froide code into one Django project. This is due to the following problems:
+- Upgrading UIPA to currently supported versions of Django and Python requires
+lots of code changes to both UIPA and Froide.
+- To satisfy the requirements to request information from Hawaii State and Local
+government agencies (called public bodies in Froide), Froide was modified. This
+required a fork but it has not been sync'd with the upstream since that point.
+- The need to include Froide as an embeddable dependency due to the modified
+fork.
+- Maintaining a modified fork of an old Froide version (no version number
+available) means maintaining two repos.
+
+Going forward, the Froide code is no longer a dependency. It is included in the
+source code of this project.
 
 ## Get started easily
 
-Prerequisite libraries and programs:
-
- * libmagic (yum install libmagic, apt-get install libmagic, etc.)
- * Elasticsearch (download, unpack, and run with Java; https://www.elastic.co/downloads/elasticsearch)
-
-In a Python virtualenv, run:
-
-    pip install -r requirements.txt -e . --src=./src
-    python manage.py migrate  --noinput
-    python manage.py createsuperuser
-    python manage.py loaddata uipa_org/fixtures/*
-    python manage.py runserver
-
-At this point, visit http://127.0.0.1:8000/ in your browser and you should see
-the home page for uipa.org.
-
-Be sure to remember the password for the admin user you create so that you can
-log on to the admin interface at http://127.0.0.1:8000/uipa-admin/. You can
-create or modify flatpages there.
-
-### Searching for public agencies or requests
-
-Once you have a running UIPA server, you'll want to be able to search for
-public bodies or previously submitted requests for information. To so, you'll
-need to:
-
-* Dowload and install Elasticsearch
-* Run an Elasticsearch server
-* Build the indexes
-
-```
-python manage.py update_index
-```
-
-## Running UIPA on Heroku
-
-There is a complete guide of how to set up Froide on Heroku at
-http://froide.readthedocs.org/en/latest/herokudeployment/. For UIPA, you'll
-need to interpolate a bit.
-
-
-## Froide documentation
-
-http://froide.readthedocs.org/en/latest/gettingstarted/
-
-For details about working with Froide Themes see [Theming
-Froide](http://froide.readthedocs.org/en/latest/theming/).
-
-
-## Creating page content for the About, Help, Terms of Use, and Privacy Statement links
-
-Django Flat Pages are used to create these pages. They are "flat" HTML content
-stored in the database. For details, see [The flatpages
-app](https://docs.djangoproject.com/es/1.9/ref/contrib/flatpages/)
-documentation.
-
-To create these pages initially, we:
-
-* Create the pages using the Django administration interface at
-  http://127.0.0.1:8000/uipa-admin/. Click on the *Flat pages* link.
-* Dump the database in JSON format (see below).
-* Edit the dump file, `<db-dump>.json`.
-* Copy the section of JSON data for the model, `flatpages.flatpage` (see
-  below).
-* Put the JSON data in a file under the uipa_org/fixtures directory named
-  `flatpages.flatpage.json`.
-
-
-### Loading the page data
-
-Once the page data files have been created under the fixtures directory, they
-can be loaded whenever a new instance of uipa.org is created. This is done by
-loading the page data files using this command:
-
-```
-python manage.py loaddata <page>
-```
-where `<page>` is the name of the page data file without the `.json`
-extension. Multiple pages can be loaded at the same time.
-
-
-### Dumping the database
-
-Dumping the database in JSON format is done using the command:
-
-```
-python manage.py dumpdata --indent 4 > db-dump.json
-```
-
-
-### Page data in JSON format
-
-Here's an example of the page data in JSON format for the About page in the
-fixtures/about-page.json:
-
-```
-[
-    {
-        "fields": {
-            "content": "<p>UIPA.org is the place where you can request information from your State of Hawaii government.</p>\r\n\r\n<p>UIPA stands for Uniform Information Practices Act and is the law covered by HRS Chapter 92F. It requires open access to government records. More information about the law can be seen at the State of Hawaii Office of Information Practices (OIP) website at <a href=\"http://oip.hawaii.gov/laws-rules-opinions/uipa/\">http://oip.hawaii.gov/laws-rules-opinions/uipa/</a>.</p>\r\n<p>You'll probably want to start with the <a href=\"http://oip.hawaii.gov/basic-qa-on-access-to-government-records/\">Basic Q&A on Access to Government Records</a> page where you can find out:</p>\r\n<ul><li>What types of records are public,</li><li>Who can request a record,</li><li>What government records are restricted or closed by law</li></ul></p>",
-            "enable_comments": false,
-            "registration_required": false,
-            "sites": [
-                1
-            ],
-            "template_name": "help/page.html",
-            "title": "About UIPA.org",
-            "url": "/help/about/"
-        },
-        "model": "flatpages.flatpage",
-        "pk": 1
-    }
-]
-```
-
+For developers and others who wish to contribute to this project, see [Getting
+Started](docs/getting-started.md).
 
 ## License
 
-Froide Theme is licensed under the MIT License.
+Froide and the Froide Theme are licensed under the MIT License.

docker-compose.yml

@@ -0,0 +1,24 @@
+services:
+  db:
+    image: postgres:13
+    volumes:
+      - pg-data:/var/lib/postgresql/data/
+    environment:
+      POSTGRES_DB: uipa
+      POSTGRES_USER: uipa
+      POSTGRES_PASSWORD: uipa
+    ports:
+      - "127.0.0.1:5432:5432"
+  es:
+    build:
+      dockerfile: ./es.Dockerfile
+    volumes:
+      - es-data:/usr/share/elasticsearch/data
+      - es-logs:/usr/share/elasticsearch/log
+    ports:
+      - "127.0.0.1:9200:9200"
+
+volumes:
+  es-data: {}
+  es-logs: {}
+  pg-data: {}

docs/README.md

@@ -0,0 +1,10 @@
+# Docs
+
+This directory contains documentation for the UIPA.org project.
+
+## Table of Contents
+
+- [Getting Started](getting-started.md)
+- [Site map of UIPA.org](uipa-site-map.md)
+- [Roadmap for upgrade in-place](Roadmap.md)
+