Skip to main content

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

Project description

Wagtail Meeting Guide

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

This is pre-alpha software, in active development!

Wagtail Meeting Guide requires both Wagtail 2.0 and Django 2.0.

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, I would recommend going through both the Django and Wagtail tutorials before trying to use this package.

A Google Geocode API key is also required.

Installation to Your Django Project

  • Install with the command pip install wagtail-meeting-guide

  • Add meeting_guide and wagtailgmaps to your INSTALLED_APPS.

  • Add the following settings, including your Google Geocode API key:

  • 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 %}

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

0.1

Maintainer

Project details


Download files

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

Source Distribution

wagtail-meeting_guide-0.1.dev6.tar.gz (279.4 kB view details)

Uploaded Source

Built Distribution

wagtail_meeting_guide-0.1.dev6-py3-none-any.whl (288.5 kB view details)

Uploaded Python 3

File details

Details for the file wagtail-meeting_guide-0.1.dev6.tar.gz.

File metadata

  • Download URL: wagtail-meeting_guide-0.1.dev6.tar.gz
  • Upload date:
  • Size: 279.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for wagtail-meeting_guide-0.1.dev6.tar.gz
Algorithm Hash digest
SHA256 ca5671dbc4b556e14982ef87611f2f114170e4b7eb9294200a1fc34ae147a075
MD5 6a2747133d496b37898154a0ee5ccc07
BLAKE2b-256 a9ff8f8639fcbec6cafdf8123a6bacd6c825db3a9a9ba75842e37c3e16703547

See more details on using hashes here.

Provenance

File details

Details for the file wagtail_meeting_guide-0.1.dev6-py3-none-any.whl.

File metadata

  • Download URL: wagtail_meeting_guide-0.1.dev6-py3-none-any.whl
  • Upload date:
  • Size: 288.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for wagtail_meeting_guide-0.1.dev6-py3-none-any.whl
Algorithm Hash digest
SHA256 44a8e40bb494d515a35fb584e579336668cd8d1b4f4437b3fea55e0c1baf600b
MD5 66b5a75ff0b253e1009658a205275ea1
BLAKE2b-256 e5b51cdd70fa8894de20a244cdf324faf20ba09f65c5292e5a03a22765f7a9ac

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page