diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-django-oscar-bluelight.spec | 1344 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 1346 insertions, 0 deletions
@@ -0,0 +1 @@ +/django-oscar-bluelight-5.3.0.tar.gz diff --git a/python-django-oscar-bluelight.spec b/python-django-oscar-bluelight.spec new file mode 100644 index 0000000..ee21ae3 --- /dev/null +++ b/python-django-oscar-bluelight.spec @@ -0,0 +1,1344 @@ +%global _empty_manifest_terminate_build 0 +Name: python-django-oscar-bluelight +Version: 5.3.0 +Release: 1 +Summary: Bluelight Specials - Enhancements to the offer and vouchers features for Django Oscar. +License: ISC +URL: https://gitlab.com/thelabnyc/django-oscar-bluelight +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/a2/58/ce1542e2a3c1f08c16cb90beebf669d11f028d07b8830cfd6281ec98068e/django-oscar-bluelight-5.3.0.tar.gz +BuildArch: noarch + +Requires: python3-celery +Requires: python3-Django +Requires: python3-django-oscar +Requires: python3-django-redis +Requires: python3-django-pgviews +Requires: python3-djangorestframework +Requires: python3-psycopg2-binary +Requires: python3-redis +Requires: python3-coverage +Requires: python3-django-debug-toolbar +Requires: python3-flake8 +Requires: python3-hiredis +Requires: python3-sorl-thumbnail +Requires: python3-sphinx +Requires: python3-splinter +Requires: python3-tox +Requires: python3-unittest-xml-reporting +Requires: python3-versiontag + +%description +# Django Oscar Bluelight Specials + +[](https://pypi.python.org/pypi/django-oscar-bluelight) +[](https://pypi.python.org/pypi/django-oscar-bluelight) +[](https://pypi.python.org/pypi/django-oscar-bluelight) + +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]{.title-ref}.: + +```sh +pip install django-oscar-bluelight +``` + +Import Bluelight's settings into your projects `settings.py` file. + +```py +from oscar.defaults import * +from oscarbluelight.defaults import * # Needed so that Bluelight's views show up in the dashboard +``` + +Add Bluelight to your installed apps (replacing the equivalent Django +Oscar apps). The top-level `oscarbluelight` app must be defined before +the `oscar` app---if it isn't Django will not correctly find the +Bluelight's templates. + +```py +INSTALLED_APPS = [ + ... + # Bluelight. Must come before `django-oscar` so that template inheritance / overrides work correctly. + 'oscarbluelight', + 'django_pgviews', + + # django-oscar + 'oscar', + 'oscar.apps.analytics', + 'oscar.apps.checkout', + 'oscar.apps.address', + 'oscar.apps.shipping', + 'oscar.apps.catalogue', + 'oscar.apps.catalogue.reviews', + 'sandbox.partner', # 'oscar.apps.partner', + 'sandbox.basket', # 'oscar.apps.basket', + 'oscar.apps.payment', + 'oscarbluelight.offer', # 'oscar.apps.offer', + 'oscar.apps.order', + 'oscar.apps.customer', + 'oscar.apps.search', + 'oscarbluelight.voucher', # 'oscar.apps.voucher', + 'oscar.apps.wishlists', + 'oscar.apps.dashboard', + 'oscar.apps.dashboard.reports', + 'oscar.apps.dashboard.users', + 'oscar.apps.dashboard.orders', + 'oscar.apps.dashboard.catalogue', + 'oscarbluelight.dashboard.offers', # 'oscar.apps.dashboard.offers', + 'oscar.apps.dashboard.partners', + 'oscar.apps.dashboard.pages', + 'oscar.apps.dashboard.ranges', + 'oscar.apps.dashboard.reviews', + 'oscarbluelight.dashboard.vouchers', # 'oscar.apps.dashboard.vouchers', + 'oscar.apps.dashboard.communications', + 'oscar.apps.dashboard.shipping', + ... +] +``` + +Fork the basket application in your project and add +`BluelightBasketMixin` as a parent class of the `Line` model. + +```py +from oscar.apps.basket.abstract_models import AbstractLine +from oscarbluelight.mixins import BluelightBasketLineMixin + +class Line(BluelightBasketLineMixin, AbstractLine): + pass + +from oscar.apps.basket.models import * # noqa +``` + +## Usage + +After installation, the new functionality will show up in the Oscar +dashboard under the Offers menu. + +## Changelog + +### 5.3.0 + +- Add new system for obtaining structured data regarding offer upsell messages +- Add `BLUELIGHT_IGNORED_ORDER_STATUSES`, ignore voucher usage on orders with those statuses + +### 5.2.4 +- Change `DEFAULT_AUTO_FIELD` to `BigAutoField`, migrate `Voucher_offers` through table. + +### 5.2.3 + +- Fix bug where Voucher.\_create_child returns the unsaved voucher object instead of the saved version. + +### 5.2.2 + +- Fix performance issues with creating / updating large numbers of child voucher codes. + +### 5.2.1 + +- Fix 500 error in dashboard when saving offer directly from form step 1. + +### 5.2.0 + +- Add created date filtering to Voucher child code export view. + +### 5.1.3 + +- Fix performance issue in VoucherStatsView when a code had a large number of child codes. + +### 5.1.2 + +- Revert change to `CREATE OR REPLACE TRIGGER` from `r5.1.1` since this syntax is only supported in PostgreSQL 14. + +### 5.1.1 + +- Reduce opportunities for deadlocks while updating PostgresSQL views and triggers. + +### 5.1.0 + +- Add new `max_discount` field to Benefit models, to allow capping the total discount granted by a benefit within a single application. Primary intended use case is for capping the discount granted by a compound benefits, when its child benefits could, in some product combinations, exceed the desired discount. +- Convert README from reStructuredText to Markdown. +- Fix performance issues related to vouchers with large numbers if children. + +### 5.0.1 + +- Remove duplicate `offer_type` field from offer form. + +### 5.0.0 + +- Oscar 3.1 compatibility +- Drops Oscar 3.0 compatibility (due to 3.1's significant changes to offers / vouchers). +- Fix bug in Offer Restrictions form which always reset voucher-type + offers to site-type offers. +- Add new "Fixed Price Per Item" benefit type + +### 4.1.0 + +- Add new dashboard view to view and delete voucher child codes. +- Tweak voucher form to allow creating custom child codes on initial + voucher creation. + +### 4.0.0 + +- Oscar 3.0 Compatibility +- Add checkbox for excluding offer from cosmetic pricing + +### 3.0.1 + +- Improve performance of the \"Add Products to Range\" functionality + in the dashboard by utilizing batch inserts. + +### 3.0.0 + +- Use Postgres materialized views to improve performance of querying + for products in a range. + +### 2.0.0 + +- Support django-oscar 2.1 + +### 1.0.0 + +- Add improved reporting formats for offers and vouchers. + +### 0.14.1 + +- Fix bug in CompoundBenefit which caused lines to not be properly + consumed by a condition if the last-to-be-applied child benefit + didn't trigger a discount. + +### 0.14.0 + +- Add support for django-oscar 2.x. +- Drop support for django-oscar 1.x. + +### 0.13.0 + +- Internationalization +- Feature: Compound Benefits. Allows applying more than one benefit + with a single offer. +- Improve performance of Range.contains_product by utilizing Redis + SETs. Requires Redis caching on the Django site + +### 0.12.0 + +- Improve UI of the offer group dashboard view. +- Improve checkout performance by tuning the update query in + Offer.record_usage. +- Alter behavior of MultibuyDiscountBenefit. Not discounts the + second-most expensive product, rather than the cheapest product. +- Remove now-unused cosmetic-pricing settings. + +### 0.11.1 + +- Fix bug with effective price. + +### 0.11.0 + +- Add support for adding images to Offers and Vouchers. +- Add support for Python 3.7. +- Add support for Django 2.1. + +### 0.10.0 + +- Add flag to offer result objects to allow flagging a result as + hidden in the UI. Doesn't functionally affect anything other than + adding the boolean flag property. +- Bugfix for clearing products from range cache + +### 0.9.0 + +- Add support for Oscar 1.6 and Django 2.0. + - Due to the write of the offer's system in Oscar 1.6, this + release drops support for Oscar 1.5. + +### 0.8.7 + +- Fix exception thrown when editing a voucher +- Fix broken Webpack build + +### 0.8.6 + +- Improve performance of offer application by caching the results of + `Range.contains_product` and `Range.contains`. + +### 0.8.5 + +- Improve performance of cosmetic price application by using + `select_related`. + +### 0.8.4 + +- Fix Django 2.0 Deprecation warnings. + +### 0.8.3 + +- Fix bug preventing saving an Offer's short name in the dashboard. + +### 0.8.2 + +- Fix method signature bug in several shipping benefits. + +### 0.8.1 + +- Adds support for Django 1.11 and Oscar 1.5 + +### 0.8.0 + +- Add Concept of System Offer Groups. + - System Offer Groups are standard offer groups, but are + automatically created and are ensured to always exist. They + can not, therefore, be created or deleted via the dashboard + UI. They are lazy-created by referencing them in code using + the + `oscarbluelight.offer.groups.register_system_offer_group(slug='foo')` + function. - Along with this functionality comes the addition of offer + and group related signals which can be used to perform + actions at specific points in time during offer group + application. For example you could create a system offer + group for offers which should be applied only after taxes + have been calculated. Then you could use the + `pre_offer_group_apply` signal to perform tax calculation on + a basket directly before the offer group is applied. + +### 0.7.1 + +- Fix exception in dashboard when adding compound conditions + +### 0.7.0 + +- Fix bug related to conditions consuming basket lines when the + condition range differed from the benefit range. +- Run model validation before applying benefits to a basket. Results + in better error reporting of invalid but difficult to enforce data. +- Start to rebuild OfferGroup dashboard view as a React application. + - Currently just recreates existing functionality using React + and an API endpoint. - Next release will include drag-and-drop priority sorting of + offers, vouchers, and offer groups. + +### 0.6.1 + +- Drop Django 1.9 support. +- In offer group list, dim inactive offers and vouchers. +- List related vouchers on benefit and condition edit pages. +- Limit orders displayed on voucher stats. +- Start testing against Django 1.11 and Oscar 1.5rc1: + - Fix issue with Voucher ordering when doing a + select_for_update. - Fix Oscar 1.5 issue with conditionaloffer_set vs offers + related name. - Fix Oscar 1.5 issue with basket.Line.line_tax. - Upgrade sandbox to Oscar 1.5. +- Add new field to ConditionalOffer: short_name +- Make OfferApplications ordered + +### 0.6.0 + +- Add concept of Offer groups. + - This makes it possible to create promotions which overlap on + line items. +- Add API for determining why a line was discounted. + +### 0.5.4 + +- Improve unit testing with tox. + +### 0.5.3 + +- Upgrade test dependencies. + +### 0.5.2 + +- Upgraded to `versiontag` 1.2.0. + +### 0.5.1 + +- Fixed bug where voucher condition range was always set to be equal + to the benefit range. + +### 0.5.0 + +- Create custom subclasses of all built-in Oscar conditions and Benefits + - Eliminates need for monkey-patching the + `Condition.consume_items` method. - Adds migration to change all row's proxy_class from + `oscar.apps.offer.FOOBAR` to `oscarbluelight.offer.FOOBAR`. +- Change behavior of `FixedPriceBenefit` to be more logical. + - Uses the benefit's assigned range instead of the + condition's range. - Respects the `max_affected_items` setting. +- Improved dashboard form validation using polymorphic `_clean` + methods on benefits and conditions. +- Disallow deleting a range when a benefit or a condition depends on + it. +- If a benefit or condition's proxy_class isn't a proxy_model, + automatically create the row in the subclass's table. + +### 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]{.title-ref} to have consistent + naming with other Oscar projects. + +### 0.1.1 + +- Fix bug the excluded templates from package. + +### 0.1.0 + +- Initial release. + + +%package -n python3-django-oscar-bluelight +Summary: Bluelight Specials - Enhancements to the offer and vouchers features for Django Oscar. +Provides: python-django-oscar-bluelight +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-django-oscar-bluelight +# Django Oscar Bluelight Specials + +[](https://pypi.python.org/pypi/django-oscar-bluelight) +[](https://pypi.python.org/pypi/django-oscar-bluelight) +[](https://pypi.python.org/pypi/django-oscar-bluelight) + +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]{.title-ref}.: + +```sh +pip install django-oscar-bluelight +``` + +Import Bluelight's settings into your projects `settings.py` file. + +```py +from oscar.defaults import * +from oscarbluelight.defaults import * # Needed so that Bluelight's views show up in the dashboard +``` + +Add Bluelight to your installed apps (replacing the equivalent Django +Oscar apps). The top-level `oscarbluelight` app must be defined before +the `oscar` app---if it isn't Django will not correctly find the +Bluelight's templates. + +```py +INSTALLED_APPS = [ + ... + # Bluelight. Must come before `django-oscar` so that template inheritance / overrides work correctly. + 'oscarbluelight', + 'django_pgviews', + + # django-oscar + 'oscar', + 'oscar.apps.analytics', + 'oscar.apps.checkout', + 'oscar.apps.address', + 'oscar.apps.shipping', + 'oscar.apps.catalogue', + 'oscar.apps.catalogue.reviews', + 'sandbox.partner', # 'oscar.apps.partner', + 'sandbox.basket', # 'oscar.apps.basket', + 'oscar.apps.payment', + 'oscarbluelight.offer', # 'oscar.apps.offer', + 'oscar.apps.order', + 'oscar.apps.customer', + 'oscar.apps.search', + 'oscarbluelight.voucher', # 'oscar.apps.voucher', + 'oscar.apps.wishlists', + 'oscar.apps.dashboard', + 'oscar.apps.dashboard.reports', + 'oscar.apps.dashboard.users', + 'oscar.apps.dashboard.orders', + 'oscar.apps.dashboard.catalogue', + 'oscarbluelight.dashboard.offers', # 'oscar.apps.dashboard.offers', + 'oscar.apps.dashboard.partners', + 'oscar.apps.dashboard.pages', + 'oscar.apps.dashboard.ranges', + 'oscar.apps.dashboard.reviews', + 'oscarbluelight.dashboard.vouchers', # 'oscar.apps.dashboard.vouchers', + 'oscar.apps.dashboard.communications', + 'oscar.apps.dashboard.shipping', + ... +] +``` + +Fork the basket application in your project and add +`BluelightBasketMixin` as a parent class of the `Line` model. + +```py +from oscar.apps.basket.abstract_models import AbstractLine +from oscarbluelight.mixins import BluelightBasketLineMixin + +class Line(BluelightBasketLineMixin, AbstractLine): + pass + +from oscar.apps.basket.models import * # noqa +``` + +## Usage + +After installation, the new functionality will show up in the Oscar +dashboard under the Offers menu. + +## Changelog + +### 5.3.0 + +- Add new system for obtaining structured data regarding offer upsell messages +- Add `BLUELIGHT_IGNORED_ORDER_STATUSES`, ignore voucher usage on orders with those statuses + +### 5.2.4 +- Change `DEFAULT_AUTO_FIELD` to `BigAutoField`, migrate `Voucher_offers` through table. + +### 5.2.3 + +- Fix bug where Voucher.\_create_child returns the unsaved voucher object instead of the saved version. + +### 5.2.2 + +- Fix performance issues with creating / updating large numbers of child voucher codes. + +### 5.2.1 + +- Fix 500 error in dashboard when saving offer directly from form step 1. + +### 5.2.0 + +- Add created date filtering to Voucher child code export view. + +### 5.1.3 + +- Fix performance issue in VoucherStatsView when a code had a large number of child codes. + +### 5.1.2 + +- Revert change to `CREATE OR REPLACE TRIGGER` from `r5.1.1` since this syntax is only supported in PostgreSQL 14. + +### 5.1.1 + +- Reduce opportunities for deadlocks while updating PostgresSQL views and triggers. + +### 5.1.0 + +- Add new `max_discount` field to Benefit models, to allow capping the total discount granted by a benefit within a single application. Primary intended use case is for capping the discount granted by a compound benefits, when its child benefits could, in some product combinations, exceed the desired discount. +- Convert README from reStructuredText to Markdown. +- Fix performance issues related to vouchers with large numbers if children. + +### 5.0.1 + +- Remove duplicate `offer_type` field from offer form. + +### 5.0.0 + +- Oscar 3.1 compatibility +- Drops Oscar 3.0 compatibility (due to 3.1's significant changes to offers / vouchers). +- Fix bug in Offer Restrictions form which always reset voucher-type + offers to site-type offers. +- Add new "Fixed Price Per Item" benefit type + +### 4.1.0 + +- Add new dashboard view to view and delete voucher child codes. +- Tweak voucher form to allow creating custom child codes on initial + voucher creation. + +### 4.0.0 + +- Oscar 3.0 Compatibility +- Add checkbox for excluding offer from cosmetic pricing + +### 3.0.1 + +- Improve performance of the \"Add Products to Range\" functionality + in the dashboard by utilizing batch inserts. + +### 3.0.0 + +- Use Postgres materialized views to improve performance of querying + for products in a range. + +### 2.0.0 + +- Support django-oscar 2.1 + +### 1.0.0 + +- Add improved reporting formats for offers and vouchers. + +### 0.14.1 + +- Fix bug in CompoundBenefit which caused lines to not be properly + consumed by a condition if the last-to-be-applied child benefit + didn't trigger a discount. + +### 0.14.0 + +- Add support for django-oscar 2.x. +- Drop support for django-oscar 1.x. + +### 0.13.0 + +- Internationalization +- Feature: Compound Benefits. Allows applying more than one benefit + with a single offer. +- Improve performance of Range.contains_product by utilizing Redis + SETs. Requires Redis caching on the Django site + +### 0.12.0 + +- Improve UI of the offer group dashboard view. +- Improve checkout performance by tuning the update query in + Offer.record_usage. +- Alter behavior of MultibuyDiscountBenefit. Not discounts the + second-most expensive product, rather than the cheapest product. +- Remove now-unused cosmetic-pricing settings. + +### 0.11.1 + +- Fix bug with effective price. + +### 0.11.0 + +- Add support for adding images to Offers and Vouchers. +- Add support for Python 3.7. +- Add support for Django 2.1. + +### 0.10.0 + +- Add flag to offer result objects to allow flagging a result as + hidden in the UI. Doesn't functionally affect anything other than + adding the boolean flag property. +- Bugfix for clearing products from range cache + +### 0.9.0 + +- Add support for Oscar 1.6 and Django 2.0. + - Due to the write of the offer's system in Oscar 1.6, this + release drops support for Oscar 1.5. + +### 0.8.7 + +- Fix exception thrown when editing a voucher +- Fix broken Webpack build + +### 0.8.6 + +- Improve performance of offer application by caching the results of + `Range.contains_product` and `Range.contains`. + +### 0.8.5 + +- Improve performance of cosmetic price application by using + `select_related`. + +### 0.8.4 + +- Fix Django 2.0 Deprecation warnings. + +### 0.8.3 + +- Fix bug preventing saving an Offer's short name in the dashboard. + +### 0.8.2 + +- Fix method signature bug in several shipping benefits. + +### 0.8.1 + +- Adds support for Django 1.11 and Oscar 1.5 + +### 0.8.0 + +- Add Concept of System Offer Groups. + - System Offer Groups are standard offer groups, but are + automatically created and are ensured to always exist. They + can not, therefore, be created or deleted via the dashboard + UI. They are lazy-created by referencing them in code using + the + `oscarbluelight.offer.groups.register_system_offer_group(slug='foo')` + function. - Along with this functionality comes the addition of offer + and group related signals which can be used to perform + actions at specific points in time during offer group + application. For example you could create a system offer + group for offers which should be applied only after taxes + have been calculated. Then you could use the + `pre_offer_group_apply` signal to perform tax calculation on + a basket directly before the offer group is applied. + +### 0.7.1 + +- Fix exception in dashboard when adding compound conditions + +### 0.7.0 + +- Fix bug related to conditions consuming basket lines when the + condition range differed from the benefit range. +- Run model validation before applying benefits to a basket. Results + in better error reporting of invalid but difficult to enforce data. +- Start to rebuild OfferGroup dashboard view as a React application. + - Currently just recreates existing functionality using React + and an API endpoint. - Next release will include drag-and-drop priority sorting of + offers, vouchers, and offer groups. + +### 0.6.1 + +- Drop Django 1.9 support. +- In offer group list, dim inactive offers and vouchers. +- List related vouchers on benefit and condition edit pages. +- Limit orders displayed on voucher stats. +- Start testing against Django 1.11 and Oscar 1.5rc1: + - Fix issue with Voucher ordering when doing a + select_for_update. - Fix Oscar 1.5 issue with conditionaloffer_set vs offers + related name. - Fix Oscar 1.5 issue with basket.Line.line_tax. - Upgrade sandbox to Oscar 1.5. +- Add new field to ConditionalOffer: short_name +- Make OfferApplications ordered + +### 0.6.0 + +- Add concept of Offer groups. + - This makes it possible to create promotions which overlap on + line items. +- Add API for determining why a line was discounted. + +### 0.5.4 + +- Improve unit testing with tox. + +### 0.5.3 + +- Upgrade test dependencies. + +### 0.5.2 + +- Upgraded to `versiontag` 1.2.0. + +### 0.5.1 + +- Fixed bug where voucher condition range was always set to be equal + to the benefit range. + +### 0.5.0 + +- Create custom subclasses of all built-in Oscar conditions and Benefits + - Eliminates need for monkey-patching the + `Condition.consume_items` method. - Adds migration to change all row's proxy_class from + `oscar.apps.offer.FOOBAR` to `oscarbluelight.offer.FOOBAR`. +- Change behavior of `FixedPriceBenefit` to be more logical. + - Uses the benefit's assigned range instead of the + condition's range. - Respects the `max_affected_items` setting. +- Improved dashboard form validation using polymorphic `_clean` + methods on benefits and conditions. +- Disallow deleting a range when a benefit or a condition depends on + it. +- If a benefit or condition's proxy_class isn't a proxy_model, + automatically create the row in the subclass's table. + +### 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]{.title-ref} to have consistent + naming with other Oscar projects. + +### 0.1.1 + +- Fix bug the excluded templates from package. + +### 0.1.0 + +- Initial release. + + +%package help +Summary: Development documents and examples for django-oscar-bluelight +Provides: python3-django-oscar-bluelight-doc +%description help +# Django Oscar Bluelight Specials + +[](https://pypi.python.org/pypi/django-oscar-bluelight) +[](https://pypi.python.org/pypi/django-oscar-bluelight) +[](https://pypi.python.org/pypi/django-oscar-bluelight) + +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]{.title-ref}.: + +```sh +pip install django-oscar-bluelight +``` + +Import Bluelight's settings into your projects `settings.py` file. + +```py +from oscar.defaults import * +from oscarbluelight.defaults import * # Needed so that Bluelight's views show up in the dashboard +``` + +Add Bluelight to your installed apps (replacing the equivalent Django +Oscar apps). The top-level `oscarbluelight` app must be defined before +the `oscar` app---if it isn't Django will not correctly find the +Bluelight's templates. + +```py +INSTALLED_APPS = [ + ... + # Bluelight. Must come before `django-oscar` so that template inheritance / overrides work correctly. + 'oscarbluelight', + 'django_pgviews', + + # django-oscar + 'oscar', + 'oscar.apps.analytics', + 'oscar.apps.checkout', + 'oscar.apps.address', + 'oscar.apps.shipping', + 'oscar.apps.catalogue', + 'oscar.apps.catalogue.reviews', + 'sandbox.partner', # 'oscar.apps.partner', + 'sandbox.basket', # 'oscar.apps.basket', + 'oscar.apps.payment', + 'oscarbluelight.offer', # 'oscar.apps.offer', + 'oscar.apps.order', + 'oscar.apps.customer', + 'oscar.apps.search', + 'oscarbluelight.voucher', # 'oscar.apps.voucher', + 'oscar.apps.wishlists', + 'oscar.apps.dashboard', + 'oscar.apps.dashboard.reports', + 'oscar.apps.dashboard.users', + 'oscar.apps.dashboard.orders', + 'oscar.apps.dashboard.catalogue', + 'oscarbluelight.dashboard.offers', # 'oscar.apps.dashboard.offers', + 'oscar.apps.dashboard.partners', + 'oscar.apps.dashboard.pages', + 'oscar.apps.dashboard.ranges', + 'oscar.apps.dashboard.reviews', + 'oscarbluelight.dashboard.vouchers', # 'oscar.apps.dashboard.vouchers', + 'oscar.apps.dashboard.communications', + 'oscar.apps.dashboard.shipping', + ... +] +``` + +Fork the basket application in your project and add +`BluelightBasketMixin` as a parent class of the `Line` model. + +```py +from oscar.apps.basket.abstract_models import AbstractLine +from oscarbluelight.mixins import BluelightBasketLineMixin + +class Line(BluelightBasketLineMixin, AbstractLine): + pass + +from oscar.apps.basket.models import * # noqa +``` + +## Usage + +After installation, the new functionality will show up in the Oscar +dashboard under the Offers menu. + +## Changelog + +### 5.3.0 + +- Add new system for obtaining structured data regarding offer upsell messages +- Add `BLUELIGHT_IGNORED_ORDER_STATUSES`, ignore voucher usage on orders with those statuses + +### 5.2.4 +- Change `DEFAULT_AUTO_FIELD` to `BigAutoField`, migrate `Voucher_offers` through table. + +### 5.2.3 + +- Fix bug where Voucher.\_create_child returns the unsaved voucher object instead of the saved version. + +### 5.2.2 + +- Fix performance issues with creating / updating large numbers of child voucher codes. + +### 5.2.1 + +- Fix 500 error in dashboard when saving offer directly from form step 1. + +### 5.2.0 + +- Add created date filtering to Voucher child code export view. + +### 5.1.3 + +- Fix performance issue in VoucherStatsView when a code had a large number of child codes. + +### 5.1.2 + +- Revert change to `CREATE OR REPLACE TRIGGER` from `r5.1.1` since this syntax is only supported in PostgreSQL 14. + +### 5.1.1 + +- Reduce opportunities for deadlocks while updating PostgresSQL views and triggers. + +### 5.1.0 + +- Add new `max_discount` field to Benefit models, to allow capping the total discount granted by a benefit within a single application. Primary intended use case is for capping the discount granted by a compound benefits, when its child benefits could, in some product combinations, exceed the desired discount. +- Convert README from reStructuredText to Markdown. +- Fix performance issues related to vouchers with large numbers if children. + +### 5.0.1 + +- Remove duplicate `offer_type` field from offer form. + +### 5.0.0 + +- Oscar 3.1 compatibility +- Drops Oscar 3.0 compatibility (due to 3.1's significant changes to offers / vouchers). +- Fix bug in Offer Restrictions form which always reset voucher-type + offers to site-type offers. +- Add new "Fixed Price Per Item" benefit type + +### 4.1.0 + +- Add new dashboard view to view and delete voucher child codes. +- Tweak voucher form to allow creating custom child codes on initial + voucher creation. + +### 4.0.0 + +- Oscar 3.0 Compatibility +- Add checkbox for excluding offer from cosmetic pricing + +### 3.0.1 + +- Improve performance of the \"Add Products to Range\" functionality + in the dashboard by utilizing batch inserts. + +### 3.0.0 + +- Use Postgres materialized views to improve performance of querying + for products in a range. + +### 2.0.0 + +- Support django-oscar 2.1 + +### 1.0.0 + +- Add improved reporting formats for offers and vouchers. + +### 0.14.1 + +- Fix bug in CompoundBenefit which caused lines to not be properly + consumed by a condition if the last-to-be-applied child benefit + didn't trigger a discount. + +### 0.14.0 + +- Add support for django-oscar 2.x. +- Drop support for django-oscar 1.x. + +### 0.13.0 + +- Internationalization +- Feature: Compound Benefits. Allows applying more than one benefit + with a single offer. +- Improve performance of Range.contains_product by utilizing Redis + SETs. Requires Redis caching on the Django site + +### 0.12.0 + +- Improve UI of the offer group dashboard view. +- Improve checkout performance by tuning the update query in + Offer.record_usage. +- Alter behavior of MultibuyDiscountBenefit. Not discounts the + second-most expensive product, rather than the cheapest product. +- Remove now-unused cosmetic-pricing settings. + +### 0.11.1 + +- Fix bug with effective price. + +### 0.11.0 + +- Add support for adding images to Offers and Vouchers. +- Add support for Python 3.7. +- Add support for Django 2.1. + +### 0.10.0 + +- Add flag to offer result objects to allow flagging a result as + hidden in the UI. Doesn't functionally affect anything other than + adding the boolean flag property. +- Bugfix for clearing products from range cache + +### 0.9.0 + +- Add support for Oscar 1.6 and Django 2.0. + - Due to the write of the offer's system in Oscar 1.6, this + release drops support for Oscar 1.5. + +### 0.8.7 + +- Fix exception thrown when editing a voucher +- Fix broken Webpack build + +### 0.8.6 + +- Improve performance of offer application by caching the results of + `Range.contains_product` and `Range.contains`. + +### 0.8.5 + +- Improve performance of cosmetic price application by using + `select_related`. + +### 0.8.4 + +- Fix Django 2.0 Deprecation warnings. + +### 0.8.3 + +- Fix bug preventing saving an Offer's short name in the dashboard. + +### 0.8.2 + +- Fix method signature bug in several shipping benefits. + +### 0.8.1 + +- Adds support for Django 1.11 and Oscar 1.5 + +### 0.8.0 + +- Add Concept of System Offer Groups. + - System Offer Groups are standard offer groups, but are + automatically created and are ensured to always exist. They + can not, therefore, be created or deleted via the dashboard + UI. They are lazy-created by referencing them in code using + the + `oscarbluelight.offer.groups.register_system_offer_group(slug='foo')` + function. - Along with this functionality comes the addition of offer + and group related signals which can be used to perform + actions at specific points in time during offer group + application. For example you could create a system offer + group for offers which should be applied only after taxes + have been calculated. Then you could use the + `pre_offer_group_apply` signal to perform tax calculation on + a basket directly before the offer group is applied. + +### 0.7.1 + +- Fix exception in dashboard when adding compound conditions + +### 0.7.0 + +- Fix bug related to conditions consuming basket lines when the + condition range differed from the benefit range. +- Run model validation before applying benefits to a basket. Results + in better error reporting of invalid but difficult to enforce data. +- Start to rebuild OfferGroup dashboard view as a React application. + - Currently just recreates existing functionality using React + and an API endpoint. - Next release will include drag-and-drop priority sorting of + offers, vouchers, and offer groups. + +### 0.6.1 + +- Drop Django 1.9 support. +- In offer group list, dim inactive offers and vouchers. +- List related vouchers on benefit and condition edit pages. +- Limit orders displayed on voucher stats. +- Start testing against Django 1.11 and Oscar 1.5rc1: + - Fix issue with Voucher ordering when doing a + select_for_update. - Fix Oscar 1.5 issue with conditionaloffer_set vs offers + related name. - Fix Oscar 1.5 issue with basket.Line.line_tax. - Upgrade sandbox to Oscar 1.5. +- Add new field to ConditionalOffer: short_name +- Make OfferApplications ordered + +### 0.6.0 + +- Add concept of Offer groups. + - This makes it possible to create promotions which overlap on + line items. +- Add API for determining why a line was discounted. + +### 0.5.4 + +- Improve unit testing with tox. + +### 0.5.3 + +- Upgrade test dependencies. + +### 0.5.2 + +- Upgraded to `versiontag` 1.2.0. + +### 0.5.1 + +- Fixed bug where voucher condition range was always set to be equal + to the benefit range. + +### 0.5.0 + +- Create custom subclasses of all built-in Oscar conditions and Benefits + - Eliminates need for monkey-patching the + `Condition.consume_items` method. - Adds migration to change all row's proxy_class from + `oscar.apps.offer.FOOBAR` to `oscarbluelight.offer.FOOBAR`. +- Change behavior of `FixedPriceBenefit` to be more logical. + - Uses the benefit's assigned range instead of the + condition's range. - Respects the `max_affected_items` setting. +- Improved dashboard form validation using polymorphic `_clean` + methods on benefits and conditions. +- Disallow deleting a range when a benefit or a condition depends on + it. +- If a benefit or condition's proxy_class isn't a proxy_model, + automatically create the row in the subclass's table. + +### 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]{.title-ref} to have consistent + naming with other Oscar projects. + +### 0.1.1 + +- Fix bug the excluded templates from package. + +### 0.1.0 + +- Initial release. + + +%prep +%autosetup -n django-oscar-bluelight-5.3.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-django-oscar-bluelight -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 5.3.0-1 +- Package Spec generated @@ -0,0 +1 @@ +d8be2fb4563b5dfbf60fb6d5a5196651 django-oscar-bluelight-5.3.0.tar.gz |