Metadata-Version: 1.0
Name: django-shopify-sync
Version: 2.2.2
Summary: A package for synchronising Django models with Shopify resources.
Home-page: https://gitlab.com/thelabnyc/django-shopify-sync
Author: David Burke
Author-email: dburke@thelabnyc.com
License: MIT
Description-Content-Type: UNKNOWN
Description: .. role:: py(code)
           :language: python
        
        .. default-role:: py
        
        ===================
        Django Shopify Sync
        ===================
        
        This is a maintained fork of https://github.com/discolabs/django-shopify-sync
        
        Installation
        ============
        
        1. `pip install django-shopify-sync`
        2. Add `'shopify_sync',` to `INSTALLED_APPS`
        3. Create a new `shopify_sync.Session` in Django admin or shell, enter your Shopify admin API token and site name.
        
        Where to get these fields:
        
        * **API Token**: In the Shopify admin, this is caleld "API Key Password".
        * **Site name**: If your domain is http://my-site.myshopify.com your site name is my-site.
        
        This package supports Python 3.X and Django>=1.11
        
        How to use
        ==========
        
        First we will get some of the products from shopify
        
        .. code:: python
        
            from shopify_sync.models import Product, Session
            session = Session.objects.first()  # Assuming you have just one that you made previously
            products = Product.objects.sync_all(session, query="For bar")
        
        `sync_all` passes all kwargs to the `shopify_resource.find` so we can
        then sync only the items that shopify returns from that search. Now we have all
        of the `products` stored locally. Now to update from Django
        
        .. code:: python
        
            product = Product.objects.first()
            product.title = "New Bar Foo"
            product.save(push=True)
        
        The `save` method on the objects also accepts the optional argument `push`
        which will push the updated model that is locally to Shopify. Now if a product
        was edited on shopify through some means other than this Django app, we will
        not have the current updated model. For this we need to sync
        
        .. code:: python
        
            changed_product.sync()
        
        the `changed_product` will get a local copy of the shopify_resource and then
        do a `.reload()` on it so that we make a request to shopify. Then we sync
        that back with our database.
        
        
Platform: UNKNOWN
