A Django content management system focused on flexibility and user experience
Find a file
Serafeim Papastefanos 9557bc6605 Add first version of send form data to email
This has been added in a generic way to allow defining form processing
backends. Sending the form data to an email is one of these backends -
others may include for instance call a web service with the form data (for
instance in a customer complains form we'd need to start a customer
complains workflow).

In any case, if the AbstractForm has a 'form_processing_backend'
attribute which should be a class, a new object of that class will be
generated and its process method will be called. The process method needs
two argumetns: The Page to pass any needed paramaters and the form to
actually pass the form data.

The form processing backends should inherit from the BaseFormProcessor
class (however probably this will be refactored to just use duck-typing
since I don't think that a base class offers anything here) and implement
the process method. Also, another useful method would be the
validate_usage to be called from the Form that uses the backend and
actually check that the form defines the correct fields - an example is
that for the email processor we need to define an email_to field in the
form. The validate_usage would need to raise an ImproperlyConfigured
exception if it has not been configured yet, however it has not been yet
implemented.
2014-03-21 23:53:22 +02:00
.tx Finished string extraction for i18n 2014-02-21 17:57:00 +02:00
docs Add basic Docker instructions to docs 2014-03-13 21:14:40 +00:00
scripts/install Ubuntu install now works on 13.04 2014-03-06 15:50:05 +00:00
wagtail Add first version of send form data to email 2014-03-21 23:53:22 +02:00
.coveragerc Added 'return NotImplemented' to list of ignored lines in coverage 2014-02-23 17:31:04 +00:00
.gitignore First pass at Sphinx docs 2014-02-18 17:45:31 +00:00
.travis.yml Back to pip wand 2014-03-12 10:17:40 +00:00
CHANGELOG.txt prepare to release 0.2 2014-03-11 16:40:04 +00:00
CONTRIBUTORS.rst Add rfosterslo as contributor 2014-03-11 13:06:26 +00:00
LICENSE Add an initially empty django-wagtail package 2014-01-22 12:27:23 +00:00
Makefile add a general test runner for wagtail, accessible by running './runtests.py' or 'make test' from the wagtail repo, or 'manage.py test wagtail' from a django project such as wagtaildemo 2014-02-13 12:44:49 +00:00
MANIFEST.in include new top-level text files in manifest 2014-02-07 15:57:54 +00:00
README.rst Updated Getting Started 2014-03-13 10:21:56 +00:00
requirements-dev.txt typo 2014-02-07 15:56:49 +00:00
runtests.py Add page permission tests (and fix the ever-so-subtle bug in preventing moves into a descendant page) 2014-03-04 15:47:16 +00:00
setup.py prepare to release 0.2 2014-03-11 16:40:04 +00:00

.. image:: https://travis-ci.org/torchbox/wagtail.png?branch=master
    :target: https://travis-ci.org/torchbox/wagtail

.. image:: https://coveralls.io/repos/torchbox/wagtail/badge.png?branch=master
    :target: https://coveralls.io/r/torchbox/wagtail?branch=master 

.. image:: https://pypip.in/v/wagtail/badge.png?asdf
    :target: https://crate.io/packages/wagtail/

Wagtail CMS
===========

.. image:: http://i.imgur.com/4pbWQ35.png

Wagtail is a Django content management system built originally for the `Royal College of Art <http://www.rca.ac.uk/>`_ and focused on flexibility and user experience. Its features include:

* A fast, attractive editor interface
* Complete control over design with standard Django templates
* Configure content types through standard Django models
* Tightly integrated search (with an `Elasticsearch <http://www.elasticsearch.org/>`_ backend for production)
* Strong document and image management
* Wide support for embedded content
* Simple, configurable permissions
* Support for tree-based content organisation
* Optional preview->submit->approve workflow
* Fast out of the box. `Varnish <https://www.varnish-cache.org/>`_-friendly if you need it
* Tests! But not enough; we're working hard to improve this

Find out more at `wagtail.io <http://wagtail.io/>`_. Documentation is at `wagtail.readthedocs.org <http://wagtail.readthedocs.org/>`_.

Got a question? Ask it on our `Google Group <https://groups.google.com/forum/#!forum/wagtail>`_.

Getting started
~~~~~~~~~~~~~~~
* To get you up and running quickly, we've provided a demonstration site with all the configuration in place, at `github.com/torchbox/wagtaildemo <https://github.com/torchbox/wagtaildemo/>`_; see the `README <https://github.com/torchbox/wagtaildemo/blob/master/README.md>`_ for installation instructions.
* See the `Getting Started <http://wagtail.readthedocs.org/en/latest/gettingstarted.html#getting-started>`_ docs for installation (with the demo app) on a fresh Debian/Ubuntu box with production-ready dependencies, on OS X and on a Vagrant box.
* `Serafeim Papastefanos <https://github.com/spapas>`_ has written a `tutorial <http://spapas.github.io/2014/02/13/wagtail-tutorial/>`_ with all the steps to build a simple Wagtail site from scratch.

Contributing
~~~~~~~~~~~~
If you're a Python or Django developer, fork the repo and get stuck in! Send us a useful pull request and we'll post you a `t-shirt <https://twitter.com/WagtailCMS/status/432166799464210432/photo/1>`_. Our immediate priorities are better docs, more tests, internationalisation and localisation.