Skip to content
A Django content management system focused on flexibility and user experience
Python HTML JavaScript CSS Shell Dockerfile
Branch: master
Clone or download

Latest commit

kaedroho Some cleanups in PostgreSQL search module (#5953)
* Separated logic for extracting indexable content

* Docs edits

* Readability improvements

* Simplify/deduplicate indexing code

* Simplify search code

Pulled in some code that will be included in a future Django release
(query.py)

* Reword a limitation

* Fix typo in docstring

* Raise a warning when Boost() is used in PostgreSQL search backend

* Add note mentioning that RawSearchQuery can be replaced in Django 3.1

* Add comment mentioning that we can replace query.py if Django PR merged
Latest commit 58f6aec May 18, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Replace gulp-sass with gulp-dart-sass May 17, 2020
.github Update links in documentation. (#5689) Nov 8, 2019
.tx Fetch new translations and update config for Chinese (#3668) Apr 8, 2019
client Replace gulp-sass with gulp-dart-sass May 17, 2020
docs Some cleanups in PostgreSQL search module (#5953) May 18, 2020
etc Update links in documentation. (#5689) Nov 8, 2019
gulpfile.js Replace gulp-sass with gulp-dart-sass May 17, 2020
scripts Update translator credits Apr 21, 2020
wagtail Some cleanups in PostgreSQL search module (#5953) May 18, 2020
.coveragerc Fixed some formatting in 'Customising IndexView' doc. (#4877) Oct 30, 2018
.editorconfig Fix whitespace errors in docs Nov 28, 2016
.eslintignore Remove unused React component generator Oct 10, 2018
.eslintrc Fix Redux DevTools deprecation warning (#5231). Fix #5214 Apr 23, 2019
.gitignore Add panel configuration checks (#5093) Feb 21, 2019
.nvmrc Upgrade to Gulp v4 & Node 10 May 1, 2020
.readthedocs.yml Drop support for Python 3.5 Apr 24, 2020
.squash.yml Upgrade to Gulp v4 & Node 10 May 1, 2020
.stylelintrc.yaml Remove explicit stylelint-scss requirement & upgrade config pkg to v0… May 20, 2019
.travis.yml Drop support for Python 3.5 Apr 24, 2020
CHANGELOG.txt Replace gulp-sass with gulp-dart-sass May 17, 2020
CODE_OF_CONDUCT.md Update links in documentation. (#5689) Nov 8, 2019
CONTRIBUTORS.rst Add 'add_redirect' static method to Redirect May 10, 2020
LICENSE Makes LICENSE recognized by GitHub. Jun 5, 2019
MANIFEST.in README rewrite (#4372) Jun 28, 2018
Makefile Configure jinjalint to enforce errors, while filtering-out false posi… May 10, 2019
README.md Drop support for Python 3.5 Apr 24, 2020
SECURITY.md Add SECURITY.md (#5536) Sep 3, 2019
SPONSORS.md Update links in documentation. (#5689) Nov 8, 2019
appveyor.yml Remove unsupported environments from appveyor config Oct 13, 2017
codecov.yml Disable codecov coverage checks on PRs Jan 30, 2019
conftest.py Use LocaleMiddleware's language as fallback language for user profile… Nov 22, 2018
package-lock.json Replace gulp-sass with gulp-dart-sass May 17, 2020
package.json Replace gulp-sass with gulp-dart-sass May 17, 2020
runtests.py Implements ES7 support (#5611) Oct 10, 2019
setup.cfg Unbundle the l18n library Oct 29, 2019
setup.py Drop support for Python 3.5 Apr 24, 2020
tox.ini Remove support for Django 2.1 (#5840) Feb 18, 2020

README.md

Wagtail

Wagtail is an open source content management system built on Django, with a strong community and commercial support. It's focused on user experience, and offers precise control for designers and developers.

Wagtail screenshot

Features

  • A fast, attractive interface for authors
  • Complete control over front-end design and structure
  • Scales to millions of pages and thousands of editors
  • Fast out of the box, cache-friendly when you need it
  • Content API for 'headless' sites with de-coupled front-end
  • Runs on a Raspberry Pi or a multi-datacenter cloud platform
  • StreamField encourages flexible content without compromising structure
  • Powerful, integrated search, using Elasticsearch or PostgreSQL
  • Excellent support for images and embedded content
  • Multi-site and multi-language ready
  • Embraces and extends Django

Find out more at wagtail.io.

Getting started

Wagtail works with Python 3, on any platform.

To get started with Wagtail, run the following in a virtual environment:

pip install wagtail
wagtail start mysite
cd mysite
pip install -r requirements.txt
python manage.py migrate
python manage.py createsuperuser
python manage.py runserver

For detailed installation and setup docs, see docs.wagtail.io.

Who’s using it?

Wagtail is used by NASA, Google, Oxfam, the NHS, Mozilla, MIT, the Red Cross, Salesforce, NBC, BMW, and the US and UK governments. Add your own Wagtail site to madewithwagtail.org.

Documentation

docs.wagtail.io is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap.

Compatibility

(If you are reading this on GitHub, the details here may not be indicative of the current released version - please see Compatible Django / Python versions in the Wagtail documentation.)

Wagtail supports:

  • Django 2.2.x and 3.0.x
  • Python 3.6, 3.7 and 3.8
  • PostgreSQL, MySQL and SQLite as database backends

Previous versions of Wagtail additionally supported Python 2.7 and Django 1.x.


Community Support

There is an active community of Wagtail users and developers responding to questions on Stack Overflow. When posting questions, please read Stack Overflow's advice on how to ask questions and remember to tag your question "wagtail".

For topics and discussions that do not fit Stack Overflow's question and answer format, we have a Slack workspace and a Wagtail Support mailing list. Please respect the time and effort of volunteers by not asking the same question in multiple places.

We maintain a curated list of third party packages, articles and other resources at Awesome Wagtail.

Commercial Support

Wagtail is sponsored by Torchbox. If you need help implementing or hosting Wagtail, please contact us: hello@torchbox.com. See also madewithwagtail.org/developers/ for expert Wagtail developers around the world.

Security

We take the security of Wagtail, and related packages we maintain, seriously. If you have found a security issue with any of our projects please email us at security@wagtail.io so we can work together to find and patch the issue. We appreciate responsible disclosure with any security related issues, so please contact us first before creating a Github issue.

If you want to send an encrypted email (optional), the public key ID for security@wagtail.io is 0x6ba1e1a86e0f8ce8, and this public key is available from most commonly-used keyservers.

Release schedule

Feature releases of Wagtail are released every three months. Selected releases are designated as Long Term Support (LTS) releases, and will receive maintenance updates for an extended period to address any security and data-loss related issues. For dates of past and upcoming releases and support periods, see Release Schedule.

Nightly releases

To try out the latest features before a release, we also create builds from master every night. You can find instructions on how to install the latest nightly release at https://releases.wagtail.io/nightly/index.html

Contributing

If you're a Python or Django developer, fork the repo and get stuck in! We have several developer focused channels on the Slack workspace.

You might like to start by reviewing the contributing guidelines and checking issues with the good first issue label.

We also welcome translations for Wagtail's interface. Translation work should be submitted through Transifex.

License

BSD

Thanks

We thank the following organisations for their services used in Wagtail's development:

Browserstack
BrowserStack provides the project with free access to their live web-based browser testing tool, and automated Selenium cloud testing.

squash.io
Squash provides the project with free test environments for reviewing pull requests.

Build Status License Version Coverage Total alerts Language grade: Python Language grade: JavaScript Slack

You can’t perform that action at this time.