A Django content management system focused on flexibility and user experience
Find a file
Tim Heap 6947eab55b Add test helpers for Wagtail sites
`wagtail.tests.utils.WagtailPageTests` is a new `TestCase` subclass that
helps developers write tests for their Wagtail sites. It currently
includes three assert methods:

`assertCanCreateAt(parent_model, child_model)`, which asserts that a
child page of a certain type could be created underneath a parent page.
This is useful for making assertions around the business rules of your
site.

`assertCanNotCreateAt(parent_model, child_model)` is the inverse of the
above.

`assertCanCreate(parent, child_model, data)` asserts that a child page
can be added underneath the given parent page, by POSTing `data` at the
correct page in the Wagtail admin. This checks that the developer has
correctly configured their `content_panels` and related options.

These methods are just a start, and could be expanded further. More
methods could be added, asserting that Snippets can be created, for
example. The current methods could be extended further, to validate more
about the Wagtail admin page editor.
2015-12-15 15:48:36 +00:00
.tx Added transifex config for wagtailstyleguide 2015-08-26 15:07:39 +01:00
docs Release note for #2036 (and #2025) 2015-12-15 15:06:49 +00:00
etc etc: add sample uwsgi and nginx configuration files 2015-05-01 15:02:29 +01:00
gulpfile.js removed unnecessary whitelist of sass files to compile. sass knows not to compile partials, which leaves all the _other_ files which it should compile 2015-12-04 10:54:38 +00:00
scripts Added Drone Dockerfiles to /scripts 2015-12-01 10:56:23 +00:00
wagtail Add test helpers for Wagtail sites 2015-12-15 15:48:36 +00:00
.coveragerc Exclude south_migrations from test coverage 2014-08-28 10:33:42 +01:00
.gitignore Removed references to search picks 2015-12-15 12:58:24 +00:00
.jscsrc linted 2015-09-01 16:49:03 +01:00
.scss-lint.yml removed unnecessary whitelist of sass files to compile. sass knows not to compile partials, which leaves all the _other_ files which it should compile 2015-12-04 10:54:38 +00:00
.travis.yml feat(django 1.9): Added Django 1.9 to tox/travis 2015-12-09 11:40:35 +00:00
CHANGELOG.txt Release note for #2036 (and #2025) 2015-12-15 15:06:49 +00:00
CONTRIBUTORS.rst added success message after image update 2015-12-15 00:21:34 +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
package.json updated npm packages. ongoing linting of scss files 2015-11-23 21:39:54 +00:00
README.rst Advertise Python 3.5 support 2015-11-05 16:19:52 +00:00
requirements-dev.txt Make elasticsearch-py a dev requirement 2015-11-19 16:23:47 +00:00
runtests.py Added --elasticsearch argument to runtests.py 2015-11-09 12:13:07 +00:00
setup.cfg Use universal wheel files 2015-06-03 10:08:21 +01:00
setup.py Unpin html5lib version 2015-12-11 13:27:57 +00:00
tox.ini Unpin html5lib version 2015-12-11 13:27:57 +00:00

.. image:: https://api.travis-ci.org/torchbox/wagtail.svg?branch=master
    :target: https://travis-ci.org/torchbox/wagtail
.. image:: https://img.shields.io/pypi/l/wagtail.svg
    :target: https://pypi.python.org/pypi/wagtail/
.. image:: https://img.shields.io/pypi/v/wagtail.svg
    :target: https://crate.io/packages/wagtail/
.. image:: https://coveralls.io/repos/torchbox/wagtail/badge.svg?branch=master
    :target: https://coveralls.io/r/torchbox/wagtail?branch=master

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

Wagtail is a content management system built on Django. It's focused on user experience,
and offers precise control for designers and developers.

.. image:: http://i.imgur.com/U5MDa0l.jpg
   :width: 728 px

Features
~~~~~~~~

* A fast, attractive interface for authors and editors
* Complete control over design with standard Django templates
* Configure content types through standard Django models
* Fast out of the box. Cache-friendly if you need it
* Tightly integrated search
* Strong document and image management
* Wide support for embedded content
* Straightforward integration with existing Django apps
* Simple, configurable permissions
* Workflow support
* An extensible `form builder <http://docs.wagtail.io/en/latest/reference/contrib/forms.html>`_
* Multi-site and multi-language support
* Optional `static site generation <http://docs.wagtail.io/en/latest/reference/contrib/staticsitegen.html>`_
* Excellent `test coverage <https://coveralls.io/r/torchbox/wagtail?branch=master>`_

Find out more at `wagtail.io <http://wagtail.io/>`_.

Getting started
~~~~~~~~~~~~~~~
    .. code-block::

     pip install wagtail
     wagtail start mysite
     cd mysite
     python manage.py migrate
     python manage.py createsuperuser
     python manage.py runserver

then sign in at http://127.0.0.1:8000/admin/

For detailed installation and setup docs, see `docs.wagtail.io <http://docs.wagtail.io/>`_.

Who's using it?
~~~~~~~~~~~~~~~
`madewithwagtail.org <http://madewithwagtail.org>`_ lists some of the public Wagtail sites we know about; please `add your own <http://madewithwagtail.org/submit/>`_.

Documentation
~~~~~~~~~~~~~
`docs.wagtail.io <http://docs.wagtail.io/>`_ is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap.

Community Support
~~~~~~~~~~~~~~~~~
Ask your questions on our `Wagtail support group <https://groups.google.com/forum/#!forum/wagtail>`_.

Commercial Support
~~~~~~~~~~~~~~~~~~
Wagtail is sponsored by `Torchbox <https://torchbox.com/>`_. If you need help implementing or hosting Wagtail, please contact us: hello@torchbox.com.

Compatibility
~~~~~~~~~~~~~
Wagtail supports Django 1.7.1+ on Python 2.7, 3.3, 3.4 and 3.5. Supported database backends are PostgreSQL, MySQL and SQLite.

Contributing
~~~~~~~~~~~~
If you're a Python or Django developer, fork the repo and get stuck in! We run a separate group for developers of Wagtail itself at https://groups.google.com/forum/#!forum/wagtail-developers (please note that this is not for support requests).

You might like to start by reviewing the `coding guidelines <http://docs.wagtail.io/en/latest/contributing/developing.html#coding-guidelines>`_ and checking issues with the `Ready to develop <https://github.com/torchbox/wagtail/issues?q=is%3Aopen+is%3Aissue+label%3A%22Ready+to+develop%21%22>`_ label.

Send us a particularly useful pull request and we'll post you a `t-shirt <https://twitter.com/WagtailCMS/status/432166799464210432/photo/1>`_.

We also welcome translations for Wagtail's interface. Translation work should be submitted through `Transifex <https://www.transifex.com/projects/p/wagtail/>`_.