django-offermaker

django-offermaker library is a solution for Django applications, which allows to create multi variant offers and use them on your site.

Multi variant offer is a structure which defines dependencies between values for given set of fields.

Eg. for the fields credit contribution and number of instalments we have the following dependencies:

for 0% credit contribution, it is required to have maximum 12 instalments,

for 10%+ contribution, it is allowed to have 12-24 instalments,

and for 20%+ contribution, it is allowed to have 12-36 instalments.

Functions of django-offermaker

Create and edit multi variant offer by using Offermaker Admin Editor.

Display multi variant offer in tabular way by using Offermaker Template Tag.

Display form which dynamically adjusts to user filled values based on multi variant offer by using OfferMakerFormView Generic View.

Make decision which variant of multi variant offer is suitable for given parameters by using decide helper.

Changelog

0.9.8
- Selenium test for offermaker admin editor and offermaker form and bug fixes in supported Django and Python versions.
0.9.7
- Added Class Based View for offermaker form
- Added decide() method
0.9.5
- Small bug fixes
0.9.4
- Django 1.7 support
- Python 3 support

Support

Environments: Python 2.6, Python 2.7, Python 3.2, Python 3.3, Python 3.4, PyPy,
Django versions: Django 1.5, Django 1.6, Django 1.7 (Python 2.6 is not supported),

Demo application

You can check it online http://offermaker.kjw.pt

Or checkout and install locally:

git clone git@github.com:kkujawinski/django-offermaker-demo.git

Quick start

Install django-offermaker
```
pip install django-offermaker
```

Site configuration in settings.py

INSTALLED_APPS = (
    ...
    'offermaker',
)

Create Django form with needed fields:

from django import forms

class MyForm(forms.Form):
    product = forms.ChoiceField(
        label='Product',
        choices=(
            ('', '---'), ('PROD1', 'Product X'), ('PROD2', 'Product Y'), ('PROD3', 'Product Z'),
        ),
        required=False)
    crediting_period = forms.ChoiceField(
        label='Crediting period',
        choices=(('', '---'), ('12', '12'), ('24', '24'), ('36', '36'), ('48', '48')))
    interest_rate = forms.FloatField(label='Interest rate', min_value=1, max_value=5)
    contribution = forms.FloatField(label='Contribution', min_value=0)

    # # Uncomment for Django 1.5
    # def __init__(self, *args, **kwargs):
    #     super(MyForm, self).__init__(*args, **kwargs)
    #     self.fields['interest_rate'].widget.attrs['data-om-type'] = 'number'
    #     self.fields['interest_rate'].widget.attrs['data-om-min'] = 1
    #     self.fields['interest_rate'].widget.attrs['data-om-max'] = 5
    #     self.fields['contribution'].widget.attrs['data-om-type'] = 'number'
    #     self.fields['contribution'].widget.attrs['data-om-min'] = 0

Define your offer (in case you do not store it in database):

offer = {
    'params': {},
    'variants': [[
        {
            'params': {
                'crediting_period': ['24'],
                'product': ['PROD1']
            }
        }, {
            'params': {
                'crediting_period': ['12', '36', '48'],
                'product': ['PROD2']
            }
        }, {
            'params': {
                'product': ['PROD3']
            }
        }
    ], [
        {
            'params': {
                'contribution': [[10, 20]],
                'interest_rate': [[2, 2]],
                'product': ['PROD1']
            }
        }, {
            'params': {
                'contribution': [[30, 40]],
                'interest_rate': [[4, 4]],
                'product': ['PROD1']
            }
        }, {
            'params': {
                'contribution': [[30, 70]],
                'interest_rate': [[5, 5]],
                'product': ['PROD2', 'PROD3']
            }
        }
    ]]
}

Offer form:

Use dispatcher code in Django view

import offermaker

class MyOfferFormView(offermaker.OfferMakerFormView):
    form_class = MyForm
    offermaker_offer = offer
    template_name = 'my_offer_form_view.html'

my_offer_form_view = MyOfferFormView.as_view()

Initialize offerform in template

<head>
{% load offermaker %}
<script type="text/javascript" src="http://code.jquery.com/jquery-1.10.2.min.js"></script>
{% offermaker_javascript %}
</head>

<body>

<form action="?" method="post" id="offer_form">
    <div class="alert-placeholder" style="height: 30px;"></div>
    {% csrf_token %}
    {{ form.as_p }}
    <button type="submit">Submit</button>
</form>


<script type="text/javascript">
    (function() {
        $('#offer_form').offer_form();
    })();
</script>

Offer preview with Offermaker Template Tag

Pass offer form object from view to template:

class MyOfferPreviewView(TemplateView):
    template_name = 'offer_preview.html'

    def get_context_data(self):
        output = super(MyOfferPreviewView, self).get_context_data()
        output['offer'] = offermaker.OfferMakerCore(MyForm, offer)
        return output

Use proper template tag in template to print table:

{% load offermaker %}

{% offermaker_preview offer %}

Offermaker Admin Editor:

Use OfferJSONField field in your model. Remember to pass your django form created in 3.:

import offermaker

class MyOfferMakerField(offermaker.OfferJSONField):
    form_object = MyForm()

class MyOffer(models.Model):
    id = models.AutoField(primary_key=True)
    name = models.CharField(max_length=30)
    offer = MyOfferMakerField()

Create your own Admin Site for model:

import models

class OfferAdmin(admin.ModelAdmin):
    list_display = ('name',)
    search_fields = ('name', 'user')
    fields = ('name', 'offer')

    # # Uncomment for Django 1.5
    # class Media:
    #     js = ('//code.jquery.com/jquery-1.11.0.min.js',)


admin.site.register(models.Offer, OfferAdmin)

Decide helper:

core_object = offermaker.OfferMakerCore(MyForm, offer)

result = core_object.decide({'crediting_period': 24})
print(result['product'].items)
# frozenset({'PROD1', 'PROD3'})
print(result['interest_rate'].ranges)
# frozenset({(4, 4), (5, 5), (2, 2)})
print(result['contribution'].ranges)
# frozenset({(10, 20), (30, 70)})

result = core_object.decide({'crediting_period': 24, 'interest_rate': 2})
print(result['product'].fixed)
# PROD1

Basic customization

Using offers stored in database:

you need to pass proper offer object to Offermaker in form/preview view:

offer = MyOffer.objects.filter(id=request.GET['id']).first()
core_object = offermaker.OfferMakerCore(MyForm, offer.offer)

and configure proper params to be used in ajax requests:

$('#offer_form').offer_form({
    ajax_extra_params: function(params) {
        return { id: {{ request.GET.id }} };
    },
});

Substituting builtin formatters for infotip and error alerts:

$('#offer_form').offer_form({
    error_alert_factory: function (msg) {
        var $error = $('<p class="error"><span>' + msg + '</span></p>');
        $('.alert-placeholder', $form).append($error);
        return $error;
    },
    tooltip_factory: function ($field, msg) {
        var $tooltip = $('<p class="infotip">' + msg + '</p>');
        $field.parent().append($tooltip);
        return $tooltip;
    }
});

Use builtin formatters for Twitter Bootstap3:

(function() {
    $('#offer_form').offer_form({
        bootstrap3: true,
    });
})();

Customizing messages:

(function() {
    $('#offer_form').offer_form({
        msgs: {
            'NO_VARIANTS': 'No matching variants',
            'INFO_ITEMS': 'Available values are: %s.',
            'INFO_FIXED': 'Only available value is %s.',
            'RANGE_left': 'to %2$s',
            'RANGE_right': 'from %1$s',
            'RANGE_both': 'from %1$s to %2$s',
            'AND': ' and '
        },
        iteration_str: function (items) {
            return items.slice(0, -2).concat(items.slice(-2).join(msgs.AND)).join(', ');
        }
    });
})();

Creating preview table for certain fields:

{% offermaker_preview offer fields='product, crediting_period' %}

Add html attributes to generated preview table:

{% offermaker_preview offer class='table table-bordered' %}

Release files for django-offermaker 0.9.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-offermaker 0.9.8
File	Size	Uploaded
django-offermaker-0.9.8.tar.gz	116.2 kB	Feb 8, 2015	Details

Release files / django-offermaker-0.9.8.tar.gz

Download URL	django-offermaker-0.9.8.tar.gz
Size	116.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`9eafe05ba73323dd3fbcc284d5d28c188a6e4a2431f633815cac038b8af817c5`
BLAKE2b-256 checksum How to use checksums	`a2f868d1e7448177ec1dbb8d0299c987de77e11f1baebb6dc836921d2c214f54`
Upload date	Feb 8, 2015
Uploaded using Trusted Publishing? What is trusted publishing?	No