Skip to main content

Bluelight Specials - Enhancements to the offer and vouchers features for Django Oscar.

Project description

license kit format downloads

This package contains enhancements and improvements to the built-in offers and vouchers features in Django Oscar.

Features

  • Group Restricted Vouchers: Bluelight adds the ability to restrict application of vouchers to a specific whitelist of groups (django.contrib.auth.models.Group). For example, you could create a voucher code that can only be applied by users who belong to the group Customer Service Reps.

  • Compound Offer Conditions: By default, Oscar only allows assigning a single condition to a promotional offer. Compound offer conditions allow you to create more complex logic around when an offer should be enabled. For example, you could create a compound condition specifying that a basket must contain at least 3 items and have a total value greater than $50.
    • Compound conditions can aggregate an unlimited number of child conditions together.

    • Compound conditions can join their child conditions using either an AND or an OR conjunction.

    • Very complex conditions requiring both AND and OR conjunctions can be modeled by creating multiple levels of compound conditions.

  • Parent / Child Voucher Codes: By default Oscar doesn’t support bulk creation of voucher codes. Bluelight adds the ability to bulk create any number of child vouchers (with unique, automatically generated codes) for any standard (non-child) voucher. This can be useful when sending voucher codes to customer’s through email, as it allows the creation of hundreds or thousands of non-sequential, one-time-use codes.
    • Child codes can be added when creating a new voucher or after a voucher is created.

    • More child codes can be generated for a voucher at any time.

    • Child codes can be exported in CSV and JSON formats.

    • Any time a parent voucher is edited (name changed, benefit altered, etc), all child codes are also updated to match.

    • When a parent voucher is deleted, all children are also deleted.

    • Once a voucher has child codes assigned to it, the parent voucher itself can not be applied by anyone.

Roadmap

  • Make child code creation and updating more performant, possibly by (1) extracting some of the work into asynchronous Celery tasks and (2) better tracking of dirty model fields before saving.

  • Add ability to duplicate vouchers.

  • Add ability to add conditions to vouchers.

Caveats

Bluelight currently works by forking four of Oscar’s apps: offer, voucher, dashboard.offers, and dashboard.vouchers. Currently there is no way to use Bluelight if your application has already forked those applications.

Installation

Install django-oscar-bluelight.:

$ pip install django-oscar-bluelight

Import Bluelight’s settings into your projects settings.py file.:

from oscar.defaults import *
from oscarbluelight.defaults import *  # NOQA # Needed so that Bluelight's views show up in the dashboard
from oscar import OSCAR_MAIN_TEMPLATE_DIR, get_core_apps
from oscarbluelight import BLUELIGHT_TEMPLATE_DIR

Add Bluelight to your install apps.:

INSTALLED_APPS = [
    ...
] + get_core_apps([
    ...
    'oscarbluelight.dashboard.offers',
    'oscarbluelight.dashboard.vouchers',
    'oscarbluelight.offer',
    'oscarbluelight.voucher',
    ...
])

Add Bluelight’s template directory directly before Oscar’s.:

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [
            BLUELIGHT_TEMPLATE_DIR,
            OSCAR_MAIN_TEMPLATE_DIR,
        ],
        ...
    }
]

Usage

After installation, the new functionality will show up in the Oscar dashboard under the Offers menu.

Changelog

0.4.1

  • Fixed several exceptions throw in dashboard views when a voucher had no offers linked to it.

0.4.0

  • Dashboard:
    • Separate vouchers form offers in benefits and conditions lists

    • Add condition field to voucher form. Allows creating more complex vouchers, such as those that require specific items in the basket.

    • Add priority field to vouchers and offers forms. Display priority field in detail and list fields.

    • Add offer restrictions fields to voucher form.

  • Performance:
    • Move child code creation and updating background task with Celery.

0.3.1

  • Use correct transaction.atomic syntax in voucher creation.

  • Fix validation of voucher name and code when child codes exist.

  • Set max_length to 128 on name field of voucher form, to match model.

0.3.0

  • Makes it possible to selectively apply offers to specific groups of users (using django.auth.contrib.models.Group).

  • Adds custom dashboard screens for managing offer / voucher benefits.

0.2.2

  • Fix bug preventing Voucher.groups form field from being blank

0.2.1

  • Fix bug the excluded templates from package.

0.2.0

  • Renamed package to oscarbluelight to have consistent naming with other Oscar projects.

0.1.1

  • Fix bug the excluded templates from package.

0.1.0

  • Initial release.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-oscar-bluelight-0.4.1.tar.gz (33.0 kB view details)

Uploaded Source

Built Distribution

django_oscar_bluelight-0.4.1-py3-none-any.whl (56.5 kB view details)

Uploaded Python 3

File details

Details for the file django-oscar-bluelight-0.4.1.tar.gz.

File metadata

File hashes

Hashes for django-oscar-bluelight-0.4.1.tar.gz
Algorithm Hash digest
SHA256 ec01592418133f0834f19ae6077df06e21279f0073ed3d648d86d32f336a00ea
MD5 20fd601cbc3b15b11e0fa0841a3296e3
BLAKE2b-256 a286f5afa813064ab0e80499cf527cc70373fcbf90f99932fc9ec30267a37e9d

See more details on using hashes here.

Provenance

File details

Details for the file django_oscar_bluelight-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_oscar_bluelight-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a3c368b0b3265ac6c2947a5e9fa1a37a8dce644d69134c67b97448d52b773388
MD5 4da6eb44432328a4f124fcde526f4a90
BLAKE2b-256 809cf6f4d7337106b6cb12c7a345446ba68dbcfafabdb38c0415300909d57cf1

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page