https://github.com/divio/aldryn-wagtail

An opinionated Wagtail setup bundled as an Aldryn Addon.
https://github.com/divio/aldryn-wagtail

Last synced: 2 months ago
JSON representation

An opinionated Wagtail setup bundled as an Aldryn Addon.

• Host: GitHub
• URL: https://github.com/divio/aldryn-wagtail
• Owner: divio
• License: other
• Created: 2016-04-28T11:54:55.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-02-01T08:54:03.000Z (12 months ago)
• Last Synced: 2024-02-01T09:45:49.861Z (12 months ago)
• Language: Python
• Size: 97.7 KB
• Stars: 0
• Watchers: 12
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
==============

Aldryn Wagtail

==============

|build| |coverage|

An opinionated Wagtail setup bundled as a Divio Cloud Addon.

This package will auto configure Django, including admin and some other basic

packages. It also handles sane configuration of the database connection and

static and media files.

The goal is to keep the footprint inside the Django website project as small

as possible, so updating things usually just means bumping a version in

``requirements.txt`` and no other changes in the project.

This addon still uses the legacy "Aldryn" naming. You can read more about this in our

`support section `_.

Contributing

============

This is a an open-source project. We'll be delighted to receive your

feedback in the form of issues and pull requests. Before submitting your

pull request, please review our `contribution guidelines

`_.

We're grateful to all contributors who have helped create and maintain this package.

Contributors are listed at the `contributors `_

section.

Documentation

=============

See ``REQUIREMENTS`` in the `setup.py `_

file for additional dependencies:

|python| |wagtail|

Installation

------------

Nothing to do. ``aldryn-wagtail`` is part of the Divio Cloud platform.

Have a look at our `support article `_

on how to get started.

Configuration

-------------

* You can configure the ``WAGTAIL SITENAME`` in the addons configuration on Divio Cloud.

* Media and static paths are automatically configured through

  `Aldryn Django `_.

Support

-------

Divio does not offer support for Wagtail itself. Please check out

`wagtail.io `_ for help.

Running Tests

-------------

You can run tests by executing::

    virtualenv env

    source env/bin/activate

    pip install -r tests/requirements.txt

    python setup.py test

.. |build| image:: https://travis-ci.org/divio/aldryn-wagtail.svg?branch=master

    :target: https://travis-ci.org/divio/aldryn-wagtail

.. |coverage| image:: https://codecov.io/gh/divio/aldryn-wagtail/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/divio/aldryn-wagtail

.. |python| image:: https://img.shields.io/badge/python-3.5%20%7C%203.6%20%7C%C2%A03.7-blue.svg

    :target: https://pypi.org/project/aldryn-wagtail/

.. |wagtail| image:: https://img.shields.io/badge/wagtail-1.5-blue.svg

    :target: https://www.wagtail.io/