Metadata-Version: 1.1
Name: django-oscar-stores
Version: 2.2
Summary: An extension for Oscar to include stores
Home-page: https://github.com/django-oscar/django-oscar-stores
Author: David Winterbottom
Author-email: david.winterbottom@gmail.com
License: BSD
Description: ============
        Oscar stores
        ============
        
        .. image:: https://secure.travis-ci.org/django-oscar/django-oscar-stores.png
            :target: http://travis-ci.org/#!/django-oscar/django-oscar-stores
        
        .. image:: http://codecov.io/github/django-oscar/django-oscar-stores/coverage.svg?branch=master
            :alt: Coverage
            :target: http://codecov.io/github/django-oscar/django-oscar-stores?branch=master
        
        This is an extension for django-oscar_ that adds support for stores.  It
        provides:
        
        .. _django-oscar: https://github.com/django-oscar/django-oscar
        
        * A store locator page using Google maps for geocoding.  It also supports using
          the browser's location to show the nearest stores.
        * Store detail pages including opening hours
        * Store groups
        * A dashboard for managing stores
        
        It's highly extensible and can be used as a foundation for building sophisticated
        stores functionality within Oscar sites.
        
        Screenshots
        -----------
        
        Customer-facing pages:
        
        .. image:: https://github.com/django-oscar/django-oscar-stores/raw/master/docs/images/locator.thumb.png
            :target: https://github.com/django-oscar/django-oscar-stores/raw/master/docs/images/locator.png
        
        .. image:: https://github.com/django-oscar/django-oscar-stores/raw/master/docs/images/detail.thumb.png
            :target: https://github.com/django-oscar/django-oscar-stores/raw/master/docs/images/detail.png
        
        Dashboard pages:
        
        .. image:: https://github.com/django-oscar/django-oscar-stores/raw/master/docs/images/dashboard-list.thumb.png
            :target: https://github.com/django-oscar/django-oscar-stores/raw/master/docs/images/dashboard-list.png
        
        .. image:: https://github.com/django-oscar/django-oscar-stores/raw/master/docs/images/dashboard-detail.thumb.png
            :target: https://github.com/django-oscar/django-oscar-stores/raw/master/docs/images/dashboard-detail.png
        
        Dependencies
        ------------
        
        GeoDjango_ is used so a spatial database is required.  We recommend PostGIS.
        Django's docs include some `installation instructions`_ although it is renowned
        for being tricky.
        
        .. _GeoDjango: https://docs.djangoproject.com/en/stable/ref/contrib/gis
        .. _`installation instructions`: https://docs.djangoproject.com/en/stable/ref/contrib/gis/install
        
        Spatialite is another option although it can be tricky to set up.  On Ubuntu,
        you can do the following:
        
        .. code:: bash
        
            $ sudo apt-get install spatialite-bin libspatialite3 libgeos++-dev libgdal-dev libproj0
        
        The ``pysqlite`` python package is also required although it doesn't support C
        extensions by default.  To work-around this, there are two options:
        
        1. Download the package, edit ``setup.cfg`` to enable C extensions and install:
        
        .. code:: bash
        
            $ pip install pysqlite --no-install
            $ vim $VIRTUAL_ENV/build/pysqlite/setup.cfg
            $ pip install pysqlite
        
        2. Use a custom branch:
        
        .. code:: bash
        
           $ pip install git+git://github.com/tinio/pysqlite.git@extension-enabled#egg=pysqlite
        
        .. _`pysqlite`: http://code.google.com/p/pysqlite
        
        Installation
        ------------
        
        First, ensure you are using a spatial database and have django-oscar installed.
        
        Install package:
        
        .. code:: bash
        
            $ pip install django-oscar-stores
        
        Then add ``stores`` and ``stores.dashboard`` to ``INSTALLED_APPS``.
        
        Now update your root ``urls.py``:
        
        .. code:: python
        
            from django.views.i18n import JavaScriptCatalog
        
            urls = [
                # basic configuration for Oscar
                url(r'^', include(apps.get_app_config('oscar').urls[0])),
        
                # adds URLs for the dashboard store manager
                url(r'^dashboard/stores/', apps.get_app_config('stores_dashboard').urls),
        
                # adds URLs for overview and detail pages
                url(r'^stores/', apps.get_app_config('stores').urls),
        
                # adds internationalization URLs
                url(r'^jsi18n/$', JavaScriptCatalog.as_view(), name='javascript-catalogue'),
            ]
        
        Settings
        --------
        
        * ``GOOGLE_MAPS_API_KEY`` (default: not set).  Maps API key for use with Maps and Geocode APIs.
          You must provide this key.
        
        * ``STORES_GEOGRAPHIC_SRID`` (default: ``3577``).  This is used for distance
          calculations.  See http://spatialreference.org for more details.
        
        * ``STORES_GEODETIC_SRID`` (default: ``4326``).
        
        * ``STORES_MAX_SEARCH_DISTANCE`` (default: None). This filters stores
          in queries by distance. Units can be set using distance object:
        
        .. code:: python
        
            from django.contrib.gis.measure import D
            # Maximal distance of 150 miles
            STORES_MAX_SEARCH_DISTANCE = D(mi=150)
            # Maximal distance of 150 kilometers
            STORES_MAX_SEARCH_DISTANCE = D(km=150)
        
        Contributing
        ------------
        
        There is sandbox site within the repo which is a sample Oscar project that uses
        the stores extension.  Set this up with:
        
        .. code:: bash
        
            $ make sandbox
        
        This loads a fixture which provides a superuser to test the dashboard with::
        
            email: superuser@example.com
            username: superuser
            password: testing
        
        Run tests with:
        
        .. code:: bash
        
            $ pytest
        
        License
        -------
        
        ``django-oscar-stores`` is released under the permissive `New BSD license`_.
        
        .. _`New BSD license`: http://github.com/django-oscar/django-oscar-stores/blob/master/LICENSE
        
Keywords: django,oscar,e-commerce
Platform: linux
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
