wagtailimporter 0.0.3

Wagtail module to load pages from Yaml

Wagtail Page Importer
=====================

Adds the ability to Wagtail to import/update pages from a Yaml file.

Installing
----------

INSTALLED_APPS = (
...
'wagtailimporter',
...
)

Usage
-----

./manage.py import_pages <page.yml> [<page.yml> [<page.yml> ... ] ...]

File format
-----------

Create a Yaml file/s for your pages.

url: /site
type: home.homepage

# Your fields go here
title: Welcome to my site!

---

url: /site/about-us
type: basic.basicpage

title: About Us
# This is a stream field
body:
- type: heading
value: About Us
- type: paragraph
value: |
<p>
Rich text block.
</p>

- type: linkbutton
# Yaml object to reference another page on the site
link: !page
url: /site/contact-us
text: Contact us

# This is rich text
tagline: |
<div>We are <em>super great!</em></div>

Foreign Object References
-------------------------

Instead of having to resolve foreign keys (yuck!) you can pass Yaml objects
to create references, e.g. `!page` takes arguments that are used to reference
a page (by path `url`).

Builtin reference types:

* `!page`

You can also create your own for your models:

import wagtailimporter.serializer

class Toplevel(wagtailimporter.serializer.GetOrCreateForeignObject
"""A reference to a toplevel"""
yaml_tag = '!toplevel'
model = TopLevel

License
-------

Copyright (c) 2016, Squareweave Pty Ltd

All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of the Squareweave nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL SQUAREWEAVE BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.