Metadata-Version: 2.1
Name: django-oscar-vat_moss
Version: 0.1
Summary: EU VATMOSS support for django-oscar
Home-page: https://github.com/hastexo/django-oscar-vat_moss
Author: hastexo
Author-email: code@hastexo.com
License: Copyright (c) 2016, hastexo Professional Services GmbH and individual contributors.
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without modification,
        are permitted provided that the following conditions are met:
        
            1. Redistributions of source code must retain the above copyright notice,
               this list of conditions and the following disclaimer.
           
            2. Redistributions in binary form must reproduce the above copyright
               notice, this list of conditions and the following disclaimer in the
               documentation and/or other materials provided with the distribution.
        
            3. Neither the name of hastexo Professional Services GmbH nor the
               names of its contributors may be used to endorse or promote
               products derived from this software without specific prior
               written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
        ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
        (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
        LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
        ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
        SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Keywords: VATMOSS,Tax,Oscar
Platform: linux
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Other/Nonlisted Topic
License-File: LICENSE
Requires-Dist: requests>=1.0
Requires-Dist: django-localflavor
Provides-Extra: oscar
Requires-Dist: django-oscar>=1.1; extra == "oscar"

oscar\_vat\_moss
================

Enables EU VATMOSS processing for the Oscar e-commerce system
-------------------------------------------------------------

.. image:: https://travis-ci.org/hastexo/django-oscar-vat_moss.svg?branch=master
   :target: https://travis-ci.org/hastexo/django-oscar-vat_moss

.. image:: https://codecov.io/github/hastexo/django-oscar-vat_moss/coverage.svg?branch=master
   :target: https://codecov.io/github/hastexo/django-oscar-vat_moss?branch=master
		    
This package enables e-commerce application based on Django Oscar to
assess and charge VAT (Value Added Tax) according to EU regulations.

It is based on
`django-oscar <https://github.com/django-oscar/django-oscar/>`_
and
`vat_moss-python <https://github.com/wbond/vat_moss-python>`_.

Installation
------------

For now, install with

::

    pip install https://github.com/hastexo/django-oscar-vat_moss/archive/master.zip

to get the latest master. There are no named releases yet, and the
package isn't yet on PyPI.

Use
---

To use, you must

-  Enable a pricing ``Strategy`` that uses the ``DeferredTax`` tax mixin

-  Add a ``CheckoutSessionMixin`` to your checkout session, so taxes can
   be applied when the customer's shipping address is known

-  Optionally extend your data model with a field accommodating your
   customer's VATIN (VAT Identification Number) if you want to enable
   VAT-free B2B transactions under the reverse charge system. If all
   your transactions are B2C, this last bit may be safely omitted.

Enabling a VAT-enabled pricing strategy
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Add ``oscar_vat_moss.partner.strategy.VATStrategy`` to your
``partner/strategy.py`` module, and update your ``Selector`` to use it
when appropriate:

.. code:: python

    # partner/strategy.py

    from oscar_vat_moss.partner.strategy import VATStrategy

    class Selector(object):
        def strategy(self, request=None, user=None, **kwargs):
            # Apply your strategy selection logic, where appropriate:
            return VATStrategy(request)

If you only want one selector and you **always** want to apply
``VATStrategy``, you may also simply use:

.. code:: python

    # partner/strategy.py

    from oscar_vat_moss.partner.strategy import *

Applying VAT on checkout
~~~~~~~~~~~~~~~~~~~~~~~~

Add ``oscar_vat_moss.checkout.session.CheckoutSessionMixin`` to your
``checkout/session.py`` module:

.. code:: python

    # checkout/session.py

    from oscar_vat_moss.checkout.session import CheckoutSessionMixin

Documentation
~~~~~~~~~~~~~~~~~~~~~~~~

Additional documentation can be found at
http://django-oscar-vat-moss.readthedocs.org/en/master/.
