Bump django / python versions to 4.0 / 3.8; Fix jazzmin bug; Setup in…

…structions update for manual deployment
open-risk · Jan 24, 2022 · 8466fda · 8466fda
1 parent ac45080
commit 8466fda
Show file tree

Hide file tree

Showing 58 changed files with 183 additions and 97 deletions.
diff --git a/createadmin.py b/createadmin.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/createcategories.py b/createcategories.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/createsectors.py b/createsectors.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/docs/source/setup.rst b/docs/source/setup.rst
@@ -72,8 +72,8 @@ The manual installation path is recommended if you want to dig into and inspect
 
 
 
-Manual installation procedure
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Manual installation procedure (Linux only)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Step 1. Download the github sources to your preferred directory:
 
@@ -88,45 +88,59 @@ Step 2. Create a virtualenv. It is advisable to install the platform in a virtua
     virtualenv -p python3 venv
     source venv/bin/activate
 
-Step 3. Install the required dependencies (The core dependency is Django and its own dependencies, in addition the Grappelli skin as the admin interface)
+Step 3. Install the required python dependencies (The core dependency is Django and its own dependencies, in addition the Jazzmin skin as the admin interface)
 
 .. code:: bash
 
     pip3 install -r requirements.txt
 
-Step 4. Make the required django migrations. The project is setup to use sqlite3 (spatialite). This step will ensure the database has the right tables.
+Step 4. Install the required system wide dependencies (to support geospatial data)
+
+.. code:: bash
+
+    sudo apt-get update && sudo apt-get install -y \
+    gdal-bin \
+    proj-bin \
+    libgdal-dev \
+    libproj-dev \
+    spatialite-bin\
+    libsqlite3-mod-spatialite
+
+Step 5. Make the required django migrations. The project is setup to use sqlite3 (spatialite). This step will ensure the database has the right tables.
 
 .. code:: bash
 
     cd equinox
     python manage.py makemigrations
     python manage.py migrate
 
-Step 5. Create a superuser. Suggestion: Use admin/admin as login/password as a reminder that this instance of equinox should NOT be used for sensitive!
+Step 6. Create a superuser. Suggestion: Use admin/admin as login/password as a reminder that this instance of equinox should NOT be used for sensitive!
 
 .. code:: bash
 
-    python3 manage.py createsuperuser
+    python3 createadmin
 
-Step 6. Collect static files (to ensure the interface will render properly)
+Step 7. Collect static files (to ensure the interface will render properly)
 
 .. code:: bash
 
     python3 manage.py collectstatic --no-input
 
-Step 7. Insert some dummy data (optional). Without this the database will be empty.
+Step 8. Insert some dummy data (optional). Without this the database will be completely empty.
 
 .. code:: bash
 
-    bash loadfixtures.sh
+    python createcategories.py
+    python createsectors.py
+    bash load_doc_fixtures.sh
 
-Step 8. Run the server. The default port is 8000 but if (by any chance) this port is already used in your computer there will be another assigned. Be sure to note the assigned port and use it instead.
+Step 9. Run the server. The default port is 8000 but if (by any chance) this port is already used in your computer there will be another assigned. Be sure to note the assigned port and use it instead.
 
 .. code:: bash
 
     python3 manage.py runserver
 
-Step 9. Login with your browser. Finally in your favorite browser (e.g. Firefox from Mozilla), enter the url ``http://localhost:8001`` and login with admin/admin credentials.
+Step 10. Login with your browser. Finally in your favorite browser (e.g. Firefox from Mozilla), enter the url ``http://localhost:8001`` and login with admin/admin credentials.
 
 .. note:: 8000 is the default port, if that is already in use, you can select an alternative one as follows:
 

diff --git a/equinox/asgi.py b/equinox/asgi.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/equinox/serializers.py b/equinox/serializers.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/equinox/settings.py b/equinox/settings.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -25,7 +25,7 @@
 """
 
 from pathlib import Path
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_lazy as _
 import os
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
@@ -40,7 +40,7 @@
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
 
-ALLOWED_HOSTS = ['www.equinoxpoint.org', 'localhost']
+ALLOWED_HOSTS = ['www.equinoxpoint.org', 'localhost', '127.0.0.1']
 
 # Application definition
 
@@ -84,10 +84,11 @@
 
 ROOT_URLCONF = 'equinox.urls'
 
-ROOT_VIEW = "http://localhost:8080"
+ROOT_VIEW = "http://localhost:8000"
 
 SITE_ID = 1
-SITE_URL = "http://equinoxpoint.org"
+# SITE_URL = "https://equinoxpoint.org"
+SITE_URL = "http://127.0.0.1:8000/"
 
 MEDIA_ROOT = os.path.join(BASE_DIR, 'uploads/')
 MEDIA_URL = '/uploads/'
@@ -185,6 +186,9 @@
     # Title on the brand, and login screen (19 chars max) (defaults to current_admin_site.site_header if absent or None)
     "site_header": "Equinox",
 
+    # Title on the brand, and login screen (19 chars max) (defaults to current_admin_site.site_header if absent or None)
+    "site_brand": "Equinox",
+
     # square logo to use for your site, must be present in static files, used for favicon and brand on top left
     "site_logo": "start/img/equinox.png",
 

diff --git a/equinox/urls.py b/equinox/urls.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/equinox/views.py b/equinox/views.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/equinox/wsgi.py b/equinox/wsgi.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/manage.py b/manage.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/model_server/apps.py b/model_server/apps.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/model_server/models.py b/model_server/models.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/model_server/openRiskScore/creditscore_library.py b/model_server/openRiskScore/creditscore_library.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/Asset.py b/portfolio/Asset.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/Contractor.py b/portfolio/Contractor.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/EmissionsSource.py b/portfolio/EmissionsSource.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/Loan.py b/portfolio/Loan.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -19,7 +19,7 @@
 # SOFTWARE.
 
 from django.db import models
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_lazy as _
 from portfolio.model_choices import *
 from portfolio.ghg_choices import *
 from django.urls import reverse

diff --git a/portfolio/Operator.py b/portfolio/Operator.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/PrimaryEffect.py b/portfolio/PrimaryEffect.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/Project.py b/portfolio/Project.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/ProjectActivity.py b/portfolio/ProjectActivity.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/ProjectCategory.py b/portfolio/ProjectCategory.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/ProjectCompany.py b/portfolio/ProjectCompany.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/Revenue.py b/portfolio/Revenue.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/SecondaryEffect.py b/portfolio/SecondaryEffect.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/Sponsor.py b/portfolio/Sponsor.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/Stakeholders.py b/portfolio/Stakeholders.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/Swap.py b/portfolio/Swap.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/admin.py b/portfolio/admin.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/apps.py b/portfolio/apps.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/ghg_choices.py b/portfolio/ghg_choices.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software'), to deal

diff --git a/portfolio/model_choices.py b/portfolio/model_choices.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software'), to deal

diff --git a/portfolio/models.py b/portfolio/models.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/tests.py b/portfolio/tests.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/portfolio/urls.py b/portfolio/urls.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -19,7 +19,7 @@
 # SOFTWARE.
 
 from django.urls import path, re_path
-from django.conf.urls import url
+
 from equinox import views
 from portfolio.views import AssetList
 from portfolio.views import AssetMapView

diff --git a/portfolio/views.py b/portfolio/views.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/reference/EmissionFactor.py b/reference/EmissionFactor.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/reference/GPCSector.py b/reference/GPCSector.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Open Risk (https://www.openriskmanagement.com)
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

diff --git a/reference/__init__.py b/reference/__init__.py
diff --git a/reference/apps.py b/reference/apps.py
@@ -1,3 +1,24 @@
+# Copyright (c) 2021 - 2022 Open Risk (https://www.openriskmanagement.com)
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+
 from django.apps import AppConfig
 
 """ Application for the management of reference data