me/breccia-mapper
1
0
Fork 0
mirror of https://github.com/Southampton-RSG/breccia-mapper.git synced 2026-03-03 03:17:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

[FEAT] Move a lot of content/settings to Constance

Browse Source 
They can now be changed in the Django admin interface
This commit is contained in:
Matthew Grove
2023-01-05 23:43:31 +00:00
parent c5dca62b0b
commit 0355392675
9 changed files with 149 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

113
breccia_mapper/settings.py
View File

@@ -16,18 +16,6 @@ https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/
Many configuration settings are input from `settings.ini`.
The most likely required settings are: SECRET_KEY, DEBUG, ALLOWED_HOSTS, DATABASE_URL, PROJECT_*_NAME, EMAIL_*
- PARENT_PROJECT_NAME
default: Parent Project Name
Displayed in templates where the name of the parent project should be used
- PROJECT_LONG_NAME
default: Project Long Name
Displayed in templates where the full name of the project should be used
- PROJECT_SHORT_NAME
default: shortname
Displayed in templates where a short identifier for the project should be used
- SECRET_KEY (REQUIRED)
Used to generate CSRF tokens - must never be made public
@@ -118,16 +106,9 @@ import dj_database_url
SETTINGS_EXPORT = [
'DEBUG',
'PARENT_PROJECT_NAME',
'PROJECT_LONG_NAME',
'PROJECT_SHORT_NAME',
'GOOGLE_MAPS_API_KEY',
]
PARENT_PROJECT_NAME = config('PARENT_PROJECT_NAME',
default='Parent Project Name')
PROJECT_LONG_NAME = config('PROJECT_LONG_NAME', default='Project Long Name')
PROJECT_SHORT_NAME = config('PROJECT_SHORT_NAME', default='shortname')
# Build paths inside the project like this: BASE_DIR.joinpath(...)
BASE_DIR = pathlib.Path(__file__).parent.parent
@@ -297,6 +278,10 @@ STATIC_ROOT = BASE_DIR.joinpath('static')
STATICFILES_DIRS = [BASE_DIR.joinpath('breccia_mapper', 'static')]
# Media uploads
MEDIA_ROOT = BASE_DIR.joinpath('breccia_mapper', 'static', 'media')
MEDIA_URL = "/static/media/"
# Logging - NB the logger name is empty to capture all output
LOGGING = {
@@ -340,6 +325,10 @@ logger = logging.getLogger(__name__) # pylint: disable=invalid-name
# Admin panel variables
CONSTANCE_ADDITIONAL_FIELDS = {
'image_field': ['django.forms.ImageField', {}]
}
CONSTANCE_CONFIG = {
'NOTICE_TEXT': (
'',
@@ -359,17 +348,95 @@ CONSTANCE_CONFIG = {
'RELATIONSHIP_FORM_HELP': (
'',
'Help text to display at the top of relationship forms.'),
'PARENT_PROJECT_NAME': (
'',
'Parent project name'),
'PROJECT_LONG_NAME': (
'Project Long Name',
'Project long name'),
'PROJECT_SHORT_NAME': (
'Short Name',
'Project short name'),
'PROJECT_LEAD': (
'John Doe',
'Project lead'),
'PROJECT_TAGLINE': (
'Here is your project\'s tagline.',
'Project tagline'),
'HOMEPAGE_HEADER_IMAGE': (
'800x500.png',
'Homepage header image',
'image_field'),
'HOMEPAGE_CARD_1_TITLE': (
'Step 1',
'Homepage card #1 title'),
'HOMEPAGE_CARD_1_DESCRIPTION': (
'Tell us about your position within the project',
'Homepage card #1 description'),
'HOMEPAGE_CARD_1_ICON': (
'building-user',
'Homepage card #1 icon'),
'HOMEPAGE_CARD_2_TITLE': (
'Step 2',
'Homepage card #2 title'),
'HOMEPAGE_CARD_2_DESCRIPTION': (
'Describe your relationships with other stakeholders',
'Homepage card #2 description'),
'HOMEPAGE_CARD_2_ICON': (
'handshake-simple',
'Homepage card #2 icon'),
'HOMEPAGE_CARD_3_TITLE': (
'Step 3',
'Homepage card #3 title'),
'HOMEPAGE_CARD_3_DESCRIPTION': (
'Use the network view to build new relationships',
'Homepage card #3 description'),
'HOMEPAGE_CARD_3_ICON': (
'diagram-project',
'Homepage card #3 icon'),
'HOMEPAGE_ABOUT_TITLE': (
'About Us',
'Homepage about section title'),
'HOMEPAGE_ABOUT_CONTENT': (
"""Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. In massa tempor nec feugiat nisl. Eget dolor morbi non arcu risus quis varius quam quisque. Nisl pretium fusce id velit ut tortor pretium viverra suspendisse. Vitae auctor eu augue ut lectus arcu. Tellus molestie nunc non blandit massa enim nec. At consectetur lorem donec massa sapien. Placerat orci nulla pellentesque dignissim enim sit. Sit amet mauris commodo quis imperdiet. Tellus at urna condimentum mattis pellentesque.<br/>In vitae turpis massa sed. Fermentum posuere urna nec tincidunt praesent semper feugiat nibh sed. Ut consequat semper viverra nam libero justo laoreet. Velit ut tortor pretium viverra suspendisse potenti nullam ac tortor. Nunc id cursus metus aliquam eleifend mi in nulla posuere. Aliquam eleifend mi in nulla posuere sollicitudin aliquam. Est ante in nibh mauris cursus mattis molestie a iaculis. Nunc id cursus metus aliquam. Auctor urna nunc id cursus metus aliquam. Porttitor lacus luctus accumsan tortor posuere ac ut consequat semper. Volutpat consequat mauris nunc congue nisi. Leo vel fringilla est ullamcorper eget. Vitae purus faucibus ornare suspendisse sed nisi lacus sed. Massa id neque aliquam vestibulum morbi blandit. Iaculis nunc sed augue lacus viverra vitae congue. Sodales neque sodales ut etiam.""",
'Homepage about section content'),
'HOMEPAGE_ABOUT_IMAGE': (
'400x400.png',
'Homepage about section image',
'image_field'),
} # yapf: disable
CONSTANCE_CONFIG_FIELDSETS = {
'Notice Banner': (
'Project options': (
'PARENT_PROJECT_NAME',
'PROJECT_LONG_NAME',
'PROJECT_SHORT_NAME',
'PROJECT_LEAD',
'PROJECT_TAGLINE',
),
'Homepage configuration': (
'HOMEPAGE_HEADER_IMAGE',
'HOMEPAGE_CARD_1_TITLE',
'HOMEPAGE_CARD_1_DESCRIPTION',
'HOMEPAGE_CARD_1_ICON',
'HOMEPAGE_CARD_2_TITLE',
'HOMEPAGE_CARD_2_DESCRIPTION',
'HOMEPAGE_CARD_2_ICON',
'HOMEPAGE_CARD_3_TITLE',
'HOMEPAGE_CARD_3_DESCRIPTION',
'HOMEPAGE_CARD_3_ICON',
'HOMEPAGE_ABOUT_TITLE',
'HOMEPAGE_ABOUT_CONTENT',
'HOMEPAGE_ABOUT_IMAGE',
),
'Notice banner': (
'NOTICE_TEXT',
'NOTICE_CLASS',
),
'Data Collection': (
'Data Ccollection': (
'CONSENT_TEXT',
),
'Help Text': (
'Help text': (
'PERSON_LIST_HELP',
'ORGANISATION_LIST_HELP',
'RELATIONSHIP_FORM_HELP',
@@ -396,7 +463,7 @@ BOOTSTRAP4 = {
EMAIL_HOST = config('EMAIL_HOST', default=None)
DEFAULT_FROM_EMAIL = config(
'DEFAULT_FROM_EMAIL',
default=f'{PROJECT_SHORT_NAME}@localhost.localdomain')
default=f'{CONSTANCE_CONFIG["PROJECT_SHORT_NAME"][0]}@localhost.localdomain')
SERVER_EMAIL = DEFAULT_FROM_EMAIL
if EMAIL_HOST is None:

BIN
breccia_mapper/static/media/400x400.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.3 KiB

BIN
breccia_mapper/static/media/800x500.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.7 KiB

6
breccia_mapper/templates/base.html
View File

@@ -10,7 +10,7 @@
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>{{ settings.PROJECT_LONG_NAME }}</title>
<title>{{ config.PROJECT_LONG_NAME }}</title>
<!-- Bootstrap CSS -->
{% bootstrap_css %}
@@ -58,7 +58,7 @@
<nav class="navbar navbar-expand-lg navbar-dark bg-dark">
<div class="container">
<a href="{% url 'index' %}" class="navbar-brand">
{{ settings.PROJECT_SHORT_NAME }}
{{ config.PROJECT_SHORT_NAME }}
</a>
<button type="button" class="navbar-toggler"
@@ -213,7 +213,7 @@
<footer class="footer bg-light">
<div class="container">
<span class="text-muted">{{ settings.PROJECT_LONG_NAME }}</span>
<span class="text-muted">{{ config.PROJECT_LONG_NAME }}</span>
</div>
</footer>

72
breccia_mapper/templates/index.html
View File

@@ -6,57 +6,84 @@
href="{% static 'css/masthead.css' %}">
{% endblock %}
{% block before_content %}
{% get_media_prefix as MEDIA_URL %}
<header class="container-fluid masthead text-white text-left"
style="background-image: url('https://via.placeholder.com/800x500')">
style="background-image: url('{{ MEDIA_URL }}{{ config.HOMEPAGE_HEADER_IMAGE }}')">
<div class="overlay"></div>
<div class="row">
<div class="ml-5 px-4 mt-3 pt-3 textbox-container">
<h1 class="display-1">{{ settings.PROJECT_LONG_NAME }}</h1>
<p class="lead">Snappy leader here...</p>
<h1 class="display-1">{{ config.PROJECT_LONG_NAME }}</h1>
<p class="lead">{{ config.PROJECT_LEAD }}</p>
</div>
</div>
</header>
<div class="bg-secondary py-3">
<div class="container text-white">
<h2>Snappy tagline here...</h2>
<h2>{{ config.PROJECT_TAGLINE }}</h2>
</div>
</div>
<div class="bg-light py-2 mb-4">
<div class="container">
<div class="row">
<div class="col-md-4">
{% if config.HOMEPAGE_CARD_1_TITLE %}
<div class="col-md-4 mx-auto">
<div class="card text-center">
<div class="card-body">
<h2 class="card-title">Do Feature 1</h2>
<h2 class="card-title">{{ config.HOMEPAGE_CARD_1_TITLE }}</h2>
<span class="fa-solid fa-5x fa-book-atlas"></span>
</div>
</div>
</div>
{% if config.HOMEPAGE_CARD_1_DESCRIPTION %}
<p>{{ config.HOMEPAGE_CARD_1_DESCRIPTION|safe }}</p>
{% endif %}
<div class="col-md-4">
{% if config.HOMEPAGE_CARD_1_ICON %}
<span class="fa-solid fa-5x fa-{{ config.HOMEPAGE_CARD_1_ICON }}"></span>
{% endif %}
</div>
</div>
</div>
{% endif %}
{% if config.HOMEPAGE_CARD_2_TITLE %}
<div class="col-md-4 mx-auto">
<div class="card text-center">
<div class="card-body">
<h2 class="card-title">Do Feature 2</h2>
<h2 class="card-title">{{ config.HOMEPAGE_CARD_2_TITLE }}</h2>
<span class="fa-solid fa-5x fa-book-atlas"></span>
</div>
</div>
</div>
{% if config.HOMEPAGE_CARD_2_DESCRIPTION %}
<p>{{ config.HOMEPAGE_CARD_2_DESCRIPTION|safe }}</p>
{% endif %}
<div class="col-md-4">
{% if config.HOMEPAGE_CARD_2_ICON %}
<span class="fa-solid fa-5x fa-{{ config.HOMEPAGE_CARD_2_ICON }}"></span>
{% endif %}
</div>
</div>
</div>
{% endif %}
{% if config.HOMEPAGE_CARD_3_TITLE %}
<div class="col-md-4 mx-auto">
<div class="card text-center">
<div class="card-body">
<h2 class="card-title">Do Feature 3</h2>
<h2 class="card-title">{{ config.HOMEPAGE_CARD_3_TITLE }}</h2>
<span class="fa-solid fa-5x fa-book-atlas"></span>
{% if config.HOMEPAGE_CARD_3_DESCRIPTION %}
<p>{{ config.HOMEPAGE_CARD_3_DESCRIPTION|safe }}</p>
{% endif %}
{% if config.HOMEPAGE_CARD_3_ICON %}
<span class="fa-solid fa-5x fa-{{ config.HOMEPAGE_CARD_3_ICON }}"></span>
{% endif %}
</div>
</div>
</div>
{% endif %}
</div>
</div>
</div>
@@ -65,15 +92,16 @@
{% block content %}
<div class="row align-items-center" style="min-height: 400px;">
<div class="col-sm-8">
<h2 class="pb-2">About {{ settings.PROJECT_LONG_NAME }}</h2>
<h2 class="pb-2">{{ config.HOMEPAGE_ABOUT_TITLE }}</h2>
<p>
{{ settings.PROJECT_LONG_NAME }} is...
{{ config.HOMEPAGE_ABOUT_CONTENT|safe }}
</p>
</div>
<div class="col-sm-4">
<img class="img-fluid py-3" src="https://via.placeholder.com/400x400">
{% get_media_prefix as MEDIA_URL %}
<img class="img-fluid py-3" src="{{ MEDIA_URL }}{{ config.HOMEPAGE_ABOUT_IMAGE }}">
</div>
</div>
{% endblock %}

2
breccia_mapper/urls.py
View File

@@ -14,7 +14,9 @@ Including another URLconf
2. Add a URL to urlpatterns: path('blog/', include('blog.urls'))
"""
from django.contrib import admin
from django.conf import settings
from django.urls import include, path
from django.conf.urls.static import static
from . import views

7
people/forms.py
View File

@@ -3,7 +3,8 @@
import typing
from django import forms
from django.conf import settings
from constance import config
from bootstrap_datepicker_plus.widgets import DatePickerInput
from django_select2.forms import ModelSelect2Widget, Select2Widget, Select2MultipleWidget
@@ -121,7 +122,7 @@ class OrganisationAnswerSetForm(forms.ModelForm, DynamicAnswerSetBase):
]
labels = {
'is_partner_organisation':
f'Is this organisation a {settings.PARENT_PROJECT_NAME} partner organisation?'
f'Is this organisation a {config.PARENT_PROJECT_NAME} partner organisation?'
}
widgets = {
'countries': Select2MultipleWidget(),
@@ -192,7 +193,7 @@ class PersonAnswerSetForm(forms.ModelForm, DynamicAnswerSetBase):
}
labels = {
'project_started_date':
f'Date started on the {settings.PARENT_PROJECT_NAME} project',
f'Date started on the {config.PARENT_PROJECT_NAME} project',
'external_organisations':
'Please list the main organisations external to BRECcIA work that you have been working with since 1st January 2019 that are involved in food/water security in African dryland regions'
}

9
people/views/organisation.py
View File

@@ -1,6 +1,7 @@
import typing
from django.conf import settings
from constance import config
from django.contrib.auth.mixins import LoginRequiredMixin
from django.core.exceptions import ObjectDoesNotExist
from django.utils import timezone
@@ -49,11 +50,11 @@ class OrganisationListView(LoginRequiredMixin, ListView):
orgs_sorted = {}
try_copy_by_key(orgs_by_country, orgs_sorted,
f'{settings.PARENT_PROJECT_NAME} partners')
f'{config.PARENT_PROJECT_NAME} partners')
try_copy_by_key(orgs_by_country, orgs_sorted, 'International')
special = {
f'{settings.PARENT_PROJECT_NAME} partners', 'International',
f'{config.PARENT_PROJECT_NAME} partners', 'International',
'Unknown'
}
for country in sorted(k for k in orgs_by_country.keys()
@@ -81,7 +82,7 @@ class OrganisationListView(LoginRequiredMixin, ListView):
country = 'International'
if answers.is_partner_organisation:
country = f'{settings.PARENT_PROJECT_NAME} partners'
country = f'{config.PARENT_PROJECT_NAME} partners'
except AttributeError:
# Organisation has no AnswerSet - country is 'Unknown'

1
requirements.txt
View File

@@ -43,3 +43,4 @@ soupsieve==2.3.2.post1
sqlparse==0.4.3
typed-ast
wrapt==1.14.1
Pillow==9.4.0