A Django content management system focused on flexibility and user experience
Find a file
Karl Hobley a175b4d0fb Improvements to type() PageQuerySet method
This commit makes the type PageQuerySet method include all concrete
models that descend from the specified model in the filter.

This makes this method useful for cases where you have many page types
descending from a single abstract model and want to search across all
these page types (which you can't do in Django normally).
2014-08-19 14:27:56 +01:00
.tx Finished string extraction for i18n 2014-02-21 17:57:00 +02:00
docs Improved example for 'subpage_urls' in RoutablePage documentation 2014-08-18 11:40:48 +01:00
scripts/install update url to uwsgi-init.d - fixes #522 2014-08-01 16:54:38 +01:00
wagtail Improvements to type() PageQuerySet method 2014-08-19 14:27:56 +01:00
.coveragerc Added 'return NotImplemented' to list of ignored lines in coverage 2014-02-23 17:31:04 +00:00
.gitignore Revert "Merge pull request #335 from mope/edit-handlers-unit-tests" 2014-06-24 12:53:34 +01:00
.travis.yml Set cache expire headers to two months on frontend image serve view 2014-07-18 14:58:34 +01:00
CHANGELOG.txt Changelog and release notes for #538 2014-08-18 09:18:15 +01:00
CONTRIBUTORS.rst changelog entry for #531 2014-08-12 17:17:21 +01: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 Text amendments. 2014-07-08 13:21:44 +01:00
requirements-dev.txt Set cache expire headers to two months on frontend image serve view 2014-07-18 14:58:34 +01:00
runtests.py Merge branch 'feature/test-db-settings' of https://github.com/takeflight/wagtail into takeflight-feature/test-db-settings 2014-07-28 12:07:34 +01:00
setup.py prepare for 0.5 release 2014-08-01 17:01:42 +01:00
tox.ini Set cache expire headers to two months on frontend image serve view 2014-07-18 14:58:34 +01: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&zxcv1
    :target: https://coveralls.io/r/torchbox/wagtail?branch=master

.. image:: https://pypip.in/v/wagtail/badge.png?zxcv
    :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
* A simple `form builder <http://docs.wagtail.io/en/latest/form_builder.html>`_
* Optional `static site generation <http://docs.wagtail.io/en/latest/static_site_generation.html>`_
* Excellent `test coverage <https://coveralls.io/r/torchbox/wagtail?branch=master>`_

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

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.
* We've also provided a skeletal django-template to get started on a blank site: https://github.com/torchbox/wagtail-template

Documentation
~~~~~~~~~~~~~
Available at `wagtail.readthedocs.org <http://wagtail.readthedocs.org/>`_ and always being updated.

Compatibility
~~~~~~~~~~~~~
Wagtail supports Django 1.6.2+ on Python 2.6, 2.7, 3.2, 3.3 and 3.4.

Django 1.7 support is in progress pending further release candidate testing.

Wagtail's dependencies are summarised at `requirements.io <https://requires.io/github/torchbox/wagtail/requirements>`_.

Contributing
~~~~~~~~~~~~
If you're a Python or Django developer, fork the repo and get stuck in!

We suggest you start by checking the `Help develop me! <https://github.com/torchbox/wagtail/issues?labels=Help+develop+me%21>`_ label and the `coding guidelines <http://wagtail.readthedocs.org/en/latest/contributing.html#coding-guidelines>`_.

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

We also welcome `translations <http://wagtail.readthedocs.org/en/latest/contributing.html#translations>`_ for Wagtail's interface.