edan_f0/docs/source/releases/v1.5.rst

=======================
Oscar 1.5 release notes
=======================

:release: tbd

Welcome to Oscar 1.5


Table of contents:

.. contents::
    :local:
    :depth: 1


.. _compatibility_of_1.5:

Compatibility
-------------

Oscar 1.4 is compatible with Django 1.8, 1.9 and 1.10 as well as Python 2.7,
3.3, 3.4, 3.5 and 3.6.


.. _new_in_1.5:

What's new in Oscar 1.5?
------------------------


Removal of deprecated features
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

These methods/modules have been removed:

 - Profiling middleware. See `silk`_ or `django-cprofile-middleware`_
   for alternatives.
 - ``Product.min_child_price_incl_tax`` and ``Product.min_child_price_excl_tax``.
 - ``oscar.core.logging.handlers.EnvFileHandler()``
 - The ``ellipses_page_range`` templatetag. See `django-rangepaginator`_ for
   an alternative.
 - ``oscar.test.decorators`` module.
 - ``oscar.core.utils.compose`` function.


.. _silk: https://github.com/django-silk/silk
.. _django-cprofile-middleware: https://github.com/omarish/django-cprofile-middleware
.. _django-rangepaginator: https://pypi.python.org/pypi/django-rangepaginator/


Minor changes
~~~~~~~~~~~~~
- Add billing address to user's address book during checkout (:issue:`1532`). Number of usages for billing and shipping
   addresses tracked separately: billing address in ``UserAddress.num_orders_as_billing_address`` field
   and shipping address in ``UserAddress.num_order_as_shipping_address`` accordingly.

.. _incompatible_in_1.5:

Backwards incompatible changes in Oscar 1.5
-------------------------------------------

- Formset classes moved to the separate modules, if you import them directly - please update location or
  use :meth:`oscar.core.loading.get_classes` for loading classes (:issue:`1957`).

  Next classes have new locations:

  - ``BaseBasketLineFormSet``, ``BasketLineFormSet``, ``BaseSavedLineFormSet``, ``SavedLineFormSet`` moved to
    ``oscar.apps.basket.formsets`` module;
  - ``BaseStockRecordFormSet``, ``StockRecordFormSet``, ``BaseProductCategoryFormSet``, ``ProductCategoryFormSet``,
    ``BaseProductImageFormSet``, ``ProductImageFormSet``, ``BaseProductRecommendationFormSet``,
    ``ProductRecommendationFormSet``, ``ProductAttributesFormSet`` moved to ``oscar.apps.dashboard.catalogue.formsets``;
  - ``OrderedProductFormSet`` moved to ``oscar.apps.dashboard.promotions.formsets``;
  - ``LineFormset`` moved to ``oscar.apps.wishlists.formsets``.

- ``SimpleAddToBasketForm`` doesn't override the quantity field any
  more. Instead, it just hides the field declared by AddToBasketForm
  and sets the quantity to one. This means ``SimpleAddToBasketForm``
  doesn't need to be overridden for most cases, but please check
  things still work as expected for you if you have customized it.

- ``OSCAR_CURRENCY_FORMAT`` setting changed to dictionary form in order to support multi-currency for
  currency formatting. You can set `format`, `format_type` and `currency_digits` in it.
  Please refer to documentation for an example.

- Dashboard order list doesn't have shortcut filters any more, pass `status` parameter instead of
  `order_status` for the relevant filtering.

- Google Analytics tracking code has been migrated to Universal Analytics.

- ``GOOGLE_ANALYTICS_ID`` and ``USE_LESS`` settings were renamed into ``OSCAR_GOOGLE_ANALYTICS_ID`` and
  ``OSCAR_USE_LESS`` respectively in order to keep all Oscar settings under common namespace.

- Remove ``display_version`` and ``version`` variables from templates and template context.

Dependency changes
------------------