Skip to main content

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 = "FAKEoyCFYHEYHUoBLAHBLAHYbRqjBafhI3BlAh"
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

Metadata

Release files for wagtail-meeting-guide 1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for wagtail-meeting-guide 1.2.1
File Size Uploaded Provenance Actions
wagtail-meeting_guide-1.2.1.tar.gz 480.7 kB Without provenance Details for wagtail-meeting_guide-1.2.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for wagtail-meeting-guide 1.2.1
File Interpreter ABI Platform Actions
wagtail_meeting_guide-1.2.1-py3-none-any.whl Python 3 none any Details for wagtail_meeting_guide-1.2.1-py3-none-any.whl

Total release size: 972.4 kB

Release files / wagtail-meeting_guide-1.2.1.tar.gz

Download URL wagtail-meeting_guide-1.2.1.tar.gz
Size 480.7 kB
Tags Source
SHA-256 checksum
How to use checksums
06088c7dce3a27190d4d2c28e8947fdc64a3905ea23931a42b66e290f2013117
BLAKE2b-256 checksum
How to use checksums
66ca73ef519f658816645fc5b083fb291f8e53b966953b4f1ae51d2c26bae075
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.8.10

Release files / wagtail_meeting_guide-1.2.1-py3-none-any.whl

Download URL wagtail_meeting_guide-1.2.1-py3-none-any.whl
Size 491.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b27540b60d6fd51f9d8c21d1ae54dfa7bb6052f7a6418aaa75c383aab51616a7
BLAKE2b-256 checksum
How to use checksums
ed210e1a5b718b9b98d98ea0b98d0abc381bb08397de8bd586eaa60763a2cf63
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.8.10

Security for wagtail-meeting-guide 1.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.2.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page