Skip to main content

KDL Wagtail Base Models

Project description

=============================
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.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
* 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
* Custom settings
* Footer customisation
* Analytics integration

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 <YOURVIRTUALENV>/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




History
-------

0.5.0 (2019-02-05)
* Wagtail settings for footer text and analytics settings
* `kdl_wagtail_core` utils:
* `paginate`
* `kdl_wagtail_core` template tags:
* `get_page_children`
* `get_analytics_id`


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.

Source Distribution

django-kdl-wagtail-0.6.3.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

django_kdl_wagtail-0.6.3-py2.py3-none-any.whl (30.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-kdl-wagtail-0.6.3.tar.gz.

File metadata

  • Download URL: django-kdl-wagtail-0.6.3.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2

File hashes

Hashes for django-kdl-wagtail-0.6.3.tar.gz
Algorithm Hash digest
SHA256 7f2e918bf12a2a41ceb765c51f1a288fbe470605ec465b775781f2f32d11cdd7
MD5 bc4565cb374faf5095199d1f008dd6b8
BLAKE2b-256 7e128702babd282dab08f614d588787b012b29537c8018565c4c21f65fa01746

See more details on using hashes here.

File details

Details for the file django_kdl_wagtail-0.6.3-py2.py3-none-any.whl.

File metadata

  • Download URL: django_kdl_wagtail-0.6.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 30.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2

File hashes

Hashes for django_kdl_wagtail-0.6.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 80aa4ccbdd7e99332b0ef0eea8e8d855ac45985f993b6b1fc84f794af2693377
MD5 50866388e7ff9c169194b0a5a23acdf9
BLAKE2b-256 26962689113fe3db77374c261160d4491d71255fb2507de16116f1c203e9df94

See more details on using hashes here.

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