Skip to main content

Meeting Guide compatible Python package for Django's Wagtail CMS: meetings, locations, and API.

Project description

Wagtail Meeting Guide

A Python package compatible with the Meeting Guide App for the Wagtail CMS on the Django web framework.

Pre-Requisites

Using this package requires both the Wagtail CMS and Django. Wagtail and Django are fantastic for running your website, but require a developer. If you are new to Django, I would recommend going through both the Django and Wagtail tutorials before trying to use this package.

A Google Geocode API key and MapBox API key are also required. The Google API key is only used in the content management system (typically by administrators), so the free tier should be fine to use.

Installation to Your Django Project

  • Install with the command pip install wagtail-meeting-guide
  • Add meeting_guide, mptt, and wagtailgeowidget to your INSTALLED_APPS.
  • Add the following settings:
    • WAGTAIL_SITE_NAME (MyCity Intergroup): the name of your website, typically the intergroup.
    • BASE_URL (https://AAMyCity.org): the base URL or the website.
  • Run migrations: python manage.py migrate meeting_guide
  • Load Meeting Guide's meeting types: python manage.py loaddata meeting_guide_types.json

Configuration

  • Enter the Wagtail CMS, and go to Settings, Meeting Types.
  • Enter your Intergroup's code for each of the Meeting Guide Code Types
  • Go to Regions and enter your regions; regions can have a parent, so you can nest them. For example, you could have Philadelphia County as a region with no parent, and Center City as a sub-region with Philadelphia County as the parent.

Including the Meeting Guide in Your Django Template

The API end point for the locations and meetings you create in Wagtail has to be added to your site's root urls.py. Add a line like this:

urlpatterns = [
    ...
    path("meeting-guide/", include("meeting_guide.urls")),
    ...
]

You can include the Meeting Guide within any Django Template. Here is an example:

{% extends "base.html" %}

{% load meeting_guide %}

{% block content %}
    {% meeting_guide %}
{% endblock content %}

More Settings

Modify the MEETING_GUIDE setting in Django's settings to change the defaults from those in pass along values in https://github.com/code4recovery/tsml-ui#advanced-customization, for example:

# Google Maps, Used by the Wagtail Content Management System
GOOGLE_MAPS_V3_APIKEY = "AIzaSyCFYHEYHUoPMBJc2eO1YbRqjBafhI3Kr3g"
GOOGLE_MAPS_API_BOUNDS = "39.732679,-77.821655|41.553879,-73.896790"
GEO_WIDGET_DEFAULT_LOCATION = {"lat": 40.0024137, "lng": -75.258117}
GEO_WIDGET_ZOOM = 14

# Key for MapBox, used by the front end served to users.
MAPBOX_KEY = "YourMaxBoxKeyGoesHere"  # noqa

# Example of sending settings to tsml-ui
MEETING_GUIDE = {
    "flags": ["Men", "Women", "Wheelchair", "Temp Closed"],
    "map": {
        "key": MAPBOX_KEY,
    },
    "search": "or",
    "show": {
        "listButtons": True,
    },
    "strings": {
        "en": {
            "types": {
                "TC": "Temp Closed",
                "X": "Wheelchair",
            },
        },
    },
}

Downloading Meetings as a PDF

To download the meeting list as a PDF, you must have wkhtmltopdf installed on your system. The end point for the download is meeting-guide/download/.

You can change the print and style options in your Django settings. The options are a Python dictionary while the styles are a string containing CSS:

WAGTAIL_MEETING_GUIDE_PRINT_OPTIONS = {
    'page-width': '100mm',
    'page-height': '120mm',
    'margin-top': '10mm',
    'margin-right': '10mm',
    'margin-bottom': '10mm',
    'margin-left': '10mm',
    'header-left': '[section]: [subsection]',
    'encoding': "UTF-8",
    'no-outline': None
}

WAGTAIL_MEETING_GUIDE_PRINT_STYLES = """
html, td {
  font-family: Arial, Helvetica, sans-serif;
  font-size: 9px;
  -webkit-text-size-adjust:100%;
  -ms-text-size-adjust:100%;
  color: red;
}

body {
  margin:0;
}

h1, .h1 {
  font-size: 24px;
}
"""

Release Notes

https://github.com/code4recovery/wagtail-meeting-guide/releases/

Maintainer

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for wagtail-meeting-guide, version 1.2.0
Filename, size File type Python version Upload date Hashes
Filename, size wagtail_meeting_guide-1.2.0-py3-none-any.whl (517.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size wagtail-meeting_guide-1.2.0.tar.gz (480.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page