Merge branch 'master' into remove_unused_cgi_import

Author: Arkham

.github/workflows/build.yml

@@ -6,13 +6,13 @@ jobs:
     name: Python ${{ matrix.version }}
     strategy:
       matrix:
-        version: ["3.7", "3.10"]
+        version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
     steps:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.version }}
       - name: Install Dependencies

.github/workflows/pre-commit.yml

@@ -12,6 +12,6 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v2
     - name: Setup
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
     - name: Pre-commit
       uses: pre-commit/action@v2.0.0

CHANGELOG

@@ -2,6 +2,14 @@
 
 - Remove `cgi` import to avoid triggering a `DeprecationWarning` on Python 3.11.
 
+== Version 12.4.0
+
+- Update API version with 2023-07, 2023-10, 2024-01 releases ([#694](https://github.com/Shopify/shopify_python_api/pull/694))
+
+== Version 12.3.0
+
+- Update API version with 2023-04 release ([#649](https://github.com/Shopify/shopify_python_api/pull/649))
+
 == Version 12.2.0
 
 - Update API version with 2023-01 release ([#631](https://github.com/Shopify/shopify_python_api/pull/631))

README.md

@@ -46,13 +46,15 @@ pip install --upgrade ShopifyAPI
 1. We then need to supply these keys to the Shopify Session Class so that it knows how to authenticate.
 
    ```python
+   import shopify
+
    shopify.Session.setup(api_key=API_KEY, secret=API_SECRET)
    ```
 1.  In order to access a shop's data, apps need an access token from that specific shop. We need to authenticate with that shop using OAuth, which we can start in the following way:
 
     ```python
     shop_url = "SHOP_NAME.myshopify.com"
-    api_version = '2020-10'
+    api_version = '2024-01'
     state = binascii.b2a_hex(os.urandom(15)).decode("utf-8")
     redirect_uri = "http://myapp.com/auth/shopify/callback"
     scopes = ['read_products', 'read_orders']
@@ -160,6 +162,12 @@ product.destroy()
 # Delete the resource from the remote server (i.e. Shopify)
 ```
 
+Here is another example to retrieve a list of open orders using certain parameters:
+
+```python
+new_orders = shopify.Order.find(status="open", limit="50")
+```
+
 ### Prefix options
 
 Some resources such as `Fulfillment` are prefixed by a parent resource in the Shopify API (e.g. `orders/450789469/fulfillments/255858046`). In order to interact with these resources, you must specify the identifier of the parent resource in your request.
@@ -242,7 +250,7 @@ python setup.py test
 ## Relative Cursor Pagination
 Cursor based pagination support has been added in 6.0.0.
 
-```
+```python
 import shopify
 
 page1 = shopify.Product.find()

setup.py

@@ -39,11 +39,11 @@
         "Operating System :: OS Independent",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.4",
-        "Programming Language :: Python :: 3.5",
-        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
         "Topic :: Software Development",
         "Topic :: Software Development :: Libraries",
         "Topic :: Software Development :: Libraries :: Python Modules",

shopify/api_version.py

@@ -33,6 +33,10 @@ def define_known_versions(cls):
         cls.define_version(Release("2022-07"))
         cls.define_version(Release("2022-10"))
         cls.define_version(Release("2023-01"))
+        cls.define_version(Release("2023-04"))
+        cls.define_version(Release("2023-07"))
+        cls.define_version(Release("2023-10"))
+        cls.define_version(Release("2024-01"))
 
     @classmethod
     def clear_defined_versions(cls):

shopify/version.py

@@ -1 +1 @@
-VERSION = "12.2.0"
+VERSION = "12.4.0"

test/session_token_test.py

@@ -79,7 +79,7 @@ def test_raises_if_aud_doesnt_match_api_key(self):
         with self.assertRaises(session_token.SessionTokenError) as cm:
             session_token.decode_from_header(self.build_auth_header(), api_key=self.api_key, secret=self.secret)
 
-        self.assertEqual("Invalid audience", str(cm.exception))
+        self.assertEqual("Audience doesn't match", str(cm.exception))
 
     def test_raises_if_issuer_hostname_is_invalid(self):
         self.payload["iss"] = "bad_shop_hostname"