Skip to main content

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>=4.2

How to use

First we will get some of the products from Shopify

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

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

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.

How to publish a new version

Use commitizen via the bin/publish.sh script.

./bin/publish.sh

Contributing

This project is in maintenance mode. Please do not post feature requests unless you intend to both implement them in a merge request and generally help maintain the project. A great first step would be a merge request to update base packages and ensure we are compatible with new Django versions.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_shopify_sync-3.3.0.tar.gz (66.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_shopify_sync-3.3.0-py3-none-any.whl (46.6 kB view details)

Uploaded Python 3

File details

Details for the file django_shopify_sync-3.3.0.tar.gz.

File metadata

  • Download URL: django_shopify_sync-3.3.0.tar.gz
  • Upload date:
  • Size: 66.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for django_shopify_sync-3.3.0.tar.gz
Algorithm Hash digest
SHA256 af036201deb8d9d8eafc7968de5d47cd07d3b88653ff171612f2c51be86ab1df
MD5 8e12d706a72b0f6848ee6e1544f504c6
BLAKE2b-256 2f5d676ed30bfcafd7e65f98523d4177468fa23a0401e7bceb7caea68bd2aa34

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_shopify_sync-3.3.0.tar.gz:

Publisher: .gitlab-ci.yml on thelabnyc/django-shopify-sync

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_shopify_sync-3.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_shopify_sync-3.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0f044080aee4f01af5709e160e6e5c1f6b40aebaf49ed1f17767618363de5cff
MD5 c4e217fa4eda6f264f4b68cc22d03e7e
BLAKE2b-256 c870c54096786c67a00bbca1ad2ab8a7d402a5835aa40f772f58a13aebed8cc9

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_shopify_sync-3.3.0-py3-none-any.whl:

Publisher: .gitlab-ci.yml on thelabnyc/django-shopify-sync

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page