returnzap · sheats · Dec 20, 2024 · Jan 11, 2024 · Apr 16, 2024 · May 22, 2024
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -6,7 +6,7 @@ jobs:
     name: Python ${{ matrix.version }}
     strategy:
       matrix:
-        version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
       - name: Checkout
@@ -18,7 +18,7 @@ jobs:
       - name: Install Dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install pytest mock pytest-cov
+          pip install pytest mock pytest-cov setuptools
           python setup.py install
           pytest --cov=./ --cov-report=xml
       - name: Run Tests

diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -3,7 +3,7 @@ name: pre-commit
 on:
   pull_request:
   push:
-    branches: [master]
+    branches: [main]
 
 jobs:
   pre-commit:

diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
@@ -22,7 +22,7 @@ jobs:
             This probably means that it is not reproducible or it has been fixed in a newer version.
             If it’s an enhancement and hasn’t been taken on since it was submitted, then it seems other issues have taken priority.
 
-            If you still encounter this issue with the latest stable version, please reopen using the issue template. You can also contribute directly by submitting a pull request– see the [CONTRIBUTING.md](https://github.com/Shopify/shopify_python_api/blob/master/CONTRIBUTING.md) file for guidelines
+            If you still encounter this issue with the latest stable version, please reopen using the issue template. You can also contribute directly by submitting a pull request– see the [CONTRIBUTING.md](https://github.com/Shopify/shopify_python_api/blob/main/CONTRIBUTING.md) file for guidelines
 
             Thank you!
           days-before-pr-stale: -1

diff --git a/CHANGELOG b/CHANGELOG
@@ -1,6 +1,15 @@
 == Unreleased
 
+== Version 12.7.0
+
+- Remove requirement to use a predefined API version. Now you can use any valid API version string. ([#737](https://github.com/Shopify/shopify_python_api/pull/737))
+
+== Version 12.6.0
+
+- Update API version with 2024-07 release ([#723](https://github.com/Shopify/shopify_python_api/pull/723))
+
 == Version 12.5.0
+
 - Remove `cgi` import to avoid triggering a `DeprecationWarning` on Python 3.11.
 - Update API version with 2024-04 release.([710](https://github.com/Shopify/shopify_python_api/pull/710))
 

diff --git a/README.md b/README.md
@@ -2,8 +2,9 @@
 
 [![Build Status](https://github.com/Shopify/shopify_python_api/workflows/CI/badge.svg)](https://github.com/Shopify/shopify_python_api/actions)
 [![PyPI version](https://badge.fury.io/py/ShopifyAPI.svg)](https://badge.fury.io/py/ShopifyAPI)
-[![codecov](https://codecov.io/gh/Shopify/shopify_python_api/branch/master/graph/badge.svg?token=pNTx0TARUx)](https://codecov.io/gh/Shopify/shopify_python_api)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/Shopify/shopify_python_api/blob/master/LICENSE)
+![Supported Python Versions](https://img.shields.io/badge/python-3.7%20|%203.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12-brightgreen)
+[![codecov](https://codecov.io/gh/Shopify/shopify_python_api/branch/main/graph/badge.svg?token=pNTx0TARUx)](https://codecov.io/gh/Shopify/shopify_python_api)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/Shopify/shopify_python_api/blob/main/LICENSE)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 
 The [Shopify Admin API](https://shopify.dev/docs/admin-api) Python Library
@@ -23,20 +24,28 @@ pip install --upgrade ShopifyAPI
 
 ### Table of Contents
 
-- [Getting Started](#getting-started)
-  - [Public and Custom Apps](#public-and-custom-apps)
-  - [Private Apps](#private-apps)
-- [Billing](#billing)
-- [Session Tokens](docs/session-tokens.md)
-- [Handling Access Scope Operations](docs/api-access.md)
-- [Advanced Usage](#advanced-usage)
-- [Prefix Options](#prefix-options)
-- [Console](#console)
-- [GraphQL](#graphql)
+- [Usage](#usage)
+  - [Requirements](#requirements)
+  - [Installation](#installation)
+  - [Table of Contents](#table-of-contents)
+  - [Getting Started](#getting-started)
+    - [Public and Custom Apps](#public-and-custom-apps)
+    - [Private Apps](#private-apps)
+      - [With full session](#with-full-session)
+      - [With temporary session](#with-temporary-session)
+  - [Billing](#billing)
+  - [Advanced Usage](#advanced-usage)
+  - [Prefix options](#prefix-options)
+  - [Console](#console)
+  - [GraphQL](#graphql)
 - [Using Development Version](#using-development-version)
+    - [Building and installing dev version](#building-and-installing-dev-version)
+    - [Running Tests](#running-tests)
 - [Relative Cursor Pagination](#relative-cursor-pagination)
+- [Set up pre-commit locally \[OPTIONAL\]](#set-up-pre-commit-locally-optional)
 - [Limitations](#limitations)
 - [Additional Resources](#additional-resources)
+  - [Sample apps built using this library](#sample-apps-built-using-this-library)
 
 
 ### Getting Started
@@ -54,7 +63,7 @@ pip install --upgrade ShopifyAPI
 
     ```python
     shop_url = "SHOP_NAME.myshopify.com"
-    api_version = '2024-01'
+    api_version = '2024-07'
     state = binascii.b2a_hex(os.urandom(15)).decode("utf-8")
     redirect_uri = "http://myapp.com/auth/shopify/callback"
     scopes = ['read_products', 'read_orders']
@@ -263,7 +272,7 @@ page2 = shopify.Product.find(from_=next_url)
 ```
 
 ## Set up pre-commit locally [OPTIONAL]
-[Pre-commit](https://pre-commit.com/) is set up as a GitHub action that runs on pull requests and pushes to the `master` branch. If you want to run pre-commit locally, install it and set up the git hook scripts
+[Pre-commit](https://pre-commit.com/) is set up as a GitHub action that runs on pull requests and pushes to the `main` branch. If you want to run pre-commit locally, install it and set up the git hook scripts
 ```shell
 pip install -r requirements.txt
 pre-commit install

diff --git a/RELEASING b/RELEASING
@@ -15,6 +15,6 @@ Releasing shopify_python_api
     git tag -m "Release X.Y.Z" vX.Y.Z
 
 7. Push the changes to github
-    git push --tags origin master
+    git push --tags origin main
 
 8. Shipit!
diff --git a/SECURITY.md b/SECURITY.md
@@ -4,7 +4,7 @@
 
 ### New features
 
-New features will only be added to the master branch and will not be made available in point releases.
+New features will only be added to the main branch and will not be made available in point releases.
 
 ### Bug fixes
 

diff --git a/setup.py b/setup.py
@@ -24,7 +24,8 @@
     install_requires=[
         "pyactiveresource>=2.2.2",
         "PyJWT >= 2.0.0",
-        "PyYAML",
+        "PyYAML>=6.0.1; python_version>='3.12'",
+        "PyYAML; python_version<'3.12'",
         "six",
     ],
     test_suite="test",
@@ -44,6 +45,7 @@
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
         "Topic :: Software Development",
         "Topic :: Software Development :: Libraries",
         "Topic :: Software Development :: Libraries :: Python Modules",

diff --git a/shopify/api_version.py b/shopify/api_version.py
@@ -17,6 +17,9 @@ def coerce_to_version(cls, version):
         try:
             return cls.versions[version]
         except KeyError:
+            # Dynamically create a new Release object if version string is not found
+            if Release.FORMAT.match(version):
+                return Release(version)
             raise VersionNotFoundError
 
     @classmethod
@@ -38,6 +41,8 @@ def define_known_versions(cls):
         cls.define_version(Release("2023-10"))
         cls.define_version(Release("2024-01"))
         cls.define_version(Release("2024-04"))
+        cls.define_version(Release("2024-07"))
+        cls.define_version(Release("2024-10"))
 
     @classmethod
     def clear_defined_versions(cls):

diff --git a/shopify/resources/__init__.py b/shopify/resources/__init__.py
@@ -38,7 +38,7 @@
 from .page import Page
 from .country import Country
 from .refund import Refund
-from .fulfillment import Fulfillment, FulfillmentOrders
+from .fulfillment import Fulfillment, FulfillmentOrders, FulfillmentV2
 from .fulfillment_event import FulfillmentEvent
 from .fulfillment_service import FulfillmentService
 from .carrier_service import CarrierService

diff --git a/shopify/version.py b/shopify/version.py
@@ -1 +1 @@
-VERSION = "12.5.0"
+VERSION = "12.7.0"
diff --git a/test/api_version_test.py b/test/api_version_test.py
@@ -29,6 +29,20 @@ def test_coerce_to_version_raises_with_string_that_does_not_match_known_version(
         with self.assertRaises(shopify.VersionNotFoundError):
             shopify.ApiVersion.coerce_to_version("crazy-name")
 
+    def test_coerce_to_version_creates_new_release_on_the_fly(self):
+        new_version = "2025-01"
+        coerced_version = shopify.ApiVersion.coerce_to_version(new_version)
+
+        self.assertIsInstance(coerced_version, shopify.Release)
+        self.assertEqual(coerced_version.name, new_version)
+        self.assertEqual(
+            coerced_version.api_path("https://test.myshopify.com"),
+            f"https://test.myshopify.com/admin/api/{new_version}",
+        )
+
+        # Verify that the new version is not added to the known versions
+        self.assertNotIn(new_version, shopify.ApiVersion.versions)
+
 
 class ReleaseTest(TestCase):
     def test_raises_if_format_invalid(self):

diff --git a/test/session_test.py b/test/session_test.py
@@ -288,3 +288,16 @@ def normalize_url(self, url):
         scheme, netloc, path, query, fragment = urllib.parse.urlsplit(url)
         query = "&".join(sorted(query.split("&")))
         return urllib.parse.urlunsplit((scheme, netloc, path, query, fragment))
+
+    def test_session_with_coerced_version(self):
+        future_version = "2030-01"
+        session = shopify.Session("test.myshopify.com", future_version, "token")
+        self.assertEqual(session.api_version.name, future_version)
+        self.assertEqual(
+            session.api_version.api_path("https://test.myshopify.com"),
+            f"https://test.myshopify.com/admin/api/{future_version}",
+        )
+
+    def test_session_with_invalid_version(self):
+        with self.assertRaises(shopify.VersionNotFoundError):
+            shopify.Session("test.myshopify.com", "invalid-version", "token")