Metadata-Version: 2.4
Name: wagtail-personalisation
Version: 0.16.0
Summary: A Wagtail add-on for showing personalized content
Home-page: https://labdigital.nl/
Author: Lab Digital BV and others
Author-email: opensource@labdigital.nl
License: MIT
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.2
Classifier: Framework :: Wagtail
Classifier: Framework :: Wagtail :: 6
Classifier: Framework :: Wagtail :: 7
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
License-File: LICENSE
Requires-Dist: wagtail>=4.1
Requires-Dist: user-agents>=1.1.0
Requires-Dist: wagtail-font-awesome-svg>=1.0.1
Requires-Dist: pycountry
Provides-Extra: docs
Requires-Dist: sphinx>=1.7.6; extra == "docs"
Requires-Dist: sphinx_rtd_theme>=0.4.0; extra == "docs"
Provides-Extra: test
Requires-Dist: factory_boy==3.2.1; extra == "test"
Requires-Dist: flake8-blind-except; extra == "test"
Requires-Dist: flake8-debugger; extra == "test"
Requires-Dist: flake8-isort; extra == "test"
Requires-Dist: flake8; extra == "test"
Requires-Dist: freezegun==1.2.1; extra == "test"
Requires-Dist: pytest-cov==3.0.0; extra == "test"
Requires-Dist: pytest-django==4.5.2; extra == "test"
Requires-Dist: pytest-pythonpath==0.7.4; extra == "test"
Requires-Dist: pytest-sugar==0.9.4; extra == "test"
Requires-Dist: pytest==6.2.5; extra == "test"
Requires-Dist: wagtail_factories==4.1.0; extra == "test"
Requires-Dist: pytest-mock==3.8.1; extra == "test"
Requires-Dist: wagtail_modeladmin>=1.0; extra == "test"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

.. image:: https://raw.githubusercontent.com/wagtail-nest/wagtail-personalisation/refs/heads/main/logo.png
   :height: 261
   :width: 300
   :scale: 50
   :alt: Prism logo
   :align: center

Wagtail Personalisation
=======================

Wagtail Personalisation is a fully-featured personalisation module for
`Wagtail CMS`_. It enables editors to create customised pages
- or parts of pages - based on segments whose rules are configured directly
in the admin interface.

.. _Wagtail CMS: https://wagtail.org/


.. image:: https://raw.githubusercontent.com/wagtail-nest/wagtail-personalisation/refs/heads/main/docs/_static/images/segment_dashboard_view.png
    :alt: The segment dashboard view


Instructions
------------
Wagtail Personalisation requires Wagtail 6.3+ and Django 4.2+

To install the package with pip:

.. code-block:: console

    pip install wagtail-personalisation

Next, include the ``wagtail_personalisation``, ``'wagtail_modeladmin'``
and ``wagtailfontawesomesvg`` apps in your project's ``INSTALLED_APPS``:

.. code-block:: python

    INSTALLED_APPS = [
        # ...
        'wagtail_modeladmin',          # if Wagtail >=5.1; Don't repeat if it's there already
        'wagtail.contrib.modeladmin',  # if Wagtail <5.1;  Don't repeat if it's there already
        'wagtail_personalisation',
        'wagtailfontawesomesvg',
        # ...
    ]

Make sure that ``django.contrib.sessions.middleware.SessionMiddleware`` has
been added in first, this is a prerequisite for this project.

.. code-block:: python

    MIDDLEWARE = [
        'django.contrib.sessions.middleware.SessionMiddleware',
        # ...
    ]


Documentation
-------------

You can find more information about installing, extending and using this module
on `Read the Docs`_.

.. _Read the Docs: http://wagtail-personalisation.readthedocs.io


Sandbox
-------

To experiment with the package you can use the sandbox provided in
this repository. To install this you will need to create and activate a
virtualenv and then run ``make sandbox``. This will start a fresh Wagtail
install, with the personalisation module enabled, on http://localhost:8000
and http://localhost:8000/cms/. The superuser credentials are
``superuser@example.com`` with the password ``testing``.
