Skip to content
No description, website, or topics provided.
Python HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Django-google-optimize

Lint Test Coverage Supported Python versions PyPI Version

Django-google-optimize is a reusable Django application designed to make running server side Google Optimize A/B test easy.

Installation

Install django-google-optimize with pip:

pip install django-google-optimize

Add the application to installed django applications:

DJANGO_APPS = [
    ...
    "django_google_optimize",
    ...
]

Add the middleware:

MIDDLEWARE = [
    ...
    "django_google_optimize.middleware.google_optimize",
    ...
]

Getting started

Add settings for the experiments:

  • id: Experiment ID required to identify variants for the experiment in templates
  • alias: Alias for the experiment ID, optional useful for clarity in templates when accessing experiment variants by key
  • variant_aliases: Aliases for each variant, each index represents a Optmize Experiment variant
# django-google-optimize
GOOGLE_OPTIMIZE_EXPERIMENTS = [
    {
        "id": "utSuKi3PRbmxeG08en8VNw",
        "alias": "redesign",
        "variant_aliases": {0: "old_design", 1: "new_design"},
    }
]

Now you can access the experiment in templates:

{% if request.google_optimize.redesign == "new_design" %}
{% include "jobs/jobposting_list_new.html" %}
{% else %}
{% include "jobs/jobposting_list_old.html" %}
{% endif %}

Or use it inline:

<nav class="navbar navbar-expand-lg navbar-dark
{% if request.google_optimize.redesign == "new_design" %} navbar-redesign{% endif %}">

Full documentation can be found here.

Documentation and Support

More documentation can be found in the docs directory or read online. Open a Github issue for support.

You can’t perform that action at this time.