Skip to main content

KDL Wagtail Base Models

Project description

https://badge.fury.io/py/django-kdl-wagtail.svg https://travis-ci.org/kingsdigitallab/django-kdl-wagtail.svg?branch=master https://codecov.io/gh/kingsdigitallab/django-kdl-wagtail/branch/master/graph/badge.svg

KDL Wagtail Base Models

Documentation

The full documentation is at https://django-kdl-wagtail.readthedocs.io.

Quickstart

Install Django KDL Wagtail:

pip install django-kdl-wagtail

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'kdl_wagtail.core.apps.KdlWagtailCoreConfig',
    'kdl_wagtail.people.apps.KdlWagtailContribPeopleConfig',
    ...
)

Features

  • A Core Wagtail application, kdl_wagtail.core with:
    • An abstract BasePage that contains and introduction and image fields, which all the other class in this package extend
    • A RichTextPage with just a RichTextField (WYSIWYG)
    • A StreamPage with a StreamField body
    • An abstract BaseIndexPage, with functions to return the page’s live children, context, and a function to paginate the children
    • A set of reusable StreamField blocks
    • Simple default templates for the pages and blocks defined in the module
  • A public API based on Wagtail’s API https://docs.wagtail.io/en/latest/advanced_topics/api/v2/configuration.html
  • People application, kdl_wagtail_people with:
    • A Person snippet, this is accessible from the Wagtail menu bar
    • A PersonPage
    • A PeopleIndexPage

TODO

  • Make it installable via PyPi
  • generic front end search page (with filters for tags, page types, …)
  • generic/abstract wagtail form page
    • contact us page (could possibly inherit from wagtail form page)
  • FAQ page

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package:

History

0.1.0 (2019-01-22)

  • First release on PyPI.

Project details


Download files

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

Files for django-kdl-wagtail, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size django_kdl_wagtail-0.1.0-py2.py3-none-any.whl (24.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size django-kdl-wagtail-0.1.0.tar.gz (15.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page