Welcome to wagtail_managed404’s documentation!

wagtail_managed404

https://img.shields.io/pypi/v/wagtail_managed404.svg https://img.shields.io/travis/mwesterhof/wagtail_managed404.svg Documentation Status

Easily manage 404s from the wagtail admin

Features

  • Monitor 404 responses served by your wagtail project
  • Add permanent or non-permanent redirects, as needed

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install wagtail_managed404, run this command in your terminal:

$ pip install wagtail_managed404

This is the preferred method to install wagtail_managed404, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for wagtail_managed404 can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/mwesterhof/wagtail_managed404

Or download the tarball:

$ curl  -OL https://github.com/mwesterhof/wagtail_managed404/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use wagtail_managed404 in a project, simply add it to the INSTALLED_APPS:

INSTALLED_APPS = [
    ...

    'wagtail.contrib.modeladmin',
    'wagtailfontawesome',
    'wagtail_managed404',

wagtailfontawesome is required to render the admin icon. wagtail.contrib.modeladmin is used for the admin panel itself.

And make sure to use the supplied middleware:

MIDDLEWARE = [
    ...

    'wagtail_managed404.middleware.PageNotFoundRedirectMiddleware',
]

Run the migrations:

./manage.py migrate

Now, the system should automatically track 404 responses. These will show up in the admin:

_images/entry_list.png

And they can be edited to supply a redirect for future requests:

_images/entry_detail.png

Entries in this list will be added automatically, but this behavior can be customized with the following setting:

# default
IGNORED_404S = [
    r'^/static/',
    r'^/favicon.ico'
]

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/mwesterhof/wagtail_managed404/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

wagtail_managed404 could always use more documentation, whether as part of the official wagtail_managed404 docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/mwesterhof/wagtail_managed404/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up wagtail_managed404 for local development.

  1. Fork the wagtail_managed404 repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/wagtail_managed404.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv wagtail_managed404
$ cd wagtail_managed404/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 wagtail_managed404 tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check https://travis-ci.org/mwesterhof/wagtail_managed404/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_wagtail_managed404

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.1.2 (2018-10-02)

  • Don’t use parentalkey to refer to page from entry

0.1.1 (2018-08-27)

  • Fix configuration issue (add migrations to pip package)

0.1.0 (2018-08-27)

  • First release on PyPI.

Indices and tables