https://github.com/kingsdigitallab/django-kdl-wagtail

A collection of Wagtail components used across several KDL projects
https://github.com/kingsdigitallab/django-kdl-wagtail

reusable wagtail

Last synced: about 1 month ago
JSON representation

A collection of Wagtail components used across several KDL projects

• Host: GitHub
• URL: https://github.com/kingsdigitallab/django-kdl-wagtail
• Owner: kingsdigitallab
• License: mit
• Created: 2019-01-29T10:27:05.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-26T20:39:02.000Z (over 2 years ago)
• Last Synced: 2025-03-17T07:46:46.254Z (about 2 months ago)
• Topics: reusable, wagtail
• Language: Python
• Homepage:
• Size: 175 KB
• Stars: 4
• Watchers: 5
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
==================

Django KDL Wagtail

==================

.. image:: https://badge.fury.io/py/django-kdl-wagtail.svg

    :target: https://badge.fury.io/py/django-kdl-wagtail

.. image:: https://travis-ci.org/kingsdigitallab/django-kdl-wagtail.svg?branch=master

    :target: https://travis-ci.org/kingsdigitallab/django-kdl-wagtail

.. image:: https://codecov.io/gh/kingsdigitallab/django-kdl-wagtail/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/kingsdigitallab/django-kdl-wagtail

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`:

.. code-block:: python

    INSTALLED_APPS = (

        ...

        'wagtail.contrib.settings',

        ...

        'kdl_wagtail.core',

        'kdl_wagtail.people',

        ...

    )

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

    * An IndexPage

    * 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

* Zotero application, `kdl_wagtail_zotero`:

    * A Bibliography model to store entried harvested from a Zotero collection

    * A management command, `zotero_import`, to import entries from a Zotero collection

    * A BibliographyIndexPage, to display all the bibliography entries

    * The Zotero based Bibliography is available from the Wagtail menu bar

* Custom settings

    * Footer customisation

    * Analytics integration

* ProxyPage: a new page type to support shortcuts and external links in menus

TODO

----

* 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 /bin/activate

    (myenv) $ pip install tox

    (myenv) $ tox

Credits

-------

Tools used in rendering this package:

*  Cookiecutter_

*  `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage