Metadata-Version: 2.1
Name: django-oscar-api-vue-storefront
Version: 0.1.0b0
Summary: REST API module for django-oscar
Home-page: https://github.com/ladrua/django-oscar-api-vue-storefront
Author: Stian Aurdal
Author-email: stian@aurdal.io
License: BSD
Description: ===================================
        Django Oscar API for Vue-Storefront
        ===================================
        
        This package provides a RESTful API for `django-oscar <https://github.com/django-oscar/django-oscar>`_ adapted to `vue-storefront <https://github.com/DivanteLtd/vue-storefront>`_.
        
        Usage
        =====
        
        Still under development, no release yet.
        
        
        Notes
        =====
        
        `Documentation <https://github.com/DivanteLtd/vue-storefront-integration-boilerplate/blob/master/1.%20Expose%20the%20API%20endpoints%20required%20by%20VS/Required%20API%20specification.md>`_ we are following for the api.
        
        `Better definition of required fields <https://github.com/DivanteLtd/bigcommerce2vuestorefront/tree/master/src/templates>`_
        
        `Data Definitions <https://divanteltd.github.io/vue-storefront/guide/data/elasticsearch.html#product-type>`_
        
        Developing
        ==========
        
        1. To start using ``git clone`` then cd into directory and run ``pip install -e .``
        
        2. Add ``oscar_vue_api`` to INSTALLED_APPS:
        ::
           INSTALLED_APPS = [
               ....
               'rest_framework',
               'corsheaders',
               'oscar_vue_api',
           ]
           MIDDLEWARE = (
               'corsheaders.middleware.CorsMiddleware',
               #...
           )
           CORS_ORIGIN_ALLOW_ALL = True
           REST_FRAMEWORK = {
            'DEFAULT_AUTHENTICATION_CLASSES': (
                ....
                'oscar_vue_api.authentication.TokenAuthSupportQueryString',
            )
           }
        
        3. Import the api urls to your projects ``urls.py`` file:
        ::
           from oscar_vue_api.app import application as api
        
           urlpatterns = [
               ....
               url(r'^vsbridge/', api.urls),
           ]
        
        
        Notes
        =====
        
        Export exsisting categories and products to elasticsearch: ``./manage.py oav_export``
        
        Delete all ElasticSearch entries ``curl -X DELETE 'http://localhost:9200/_all'``
        
        
        
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
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.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Provides-Extra: dev
Provides-Extra: docs
