anaplan-sdk 0.4.0a2__tar.gz → 0.4.1__tar.gz

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/PKG-INFO

@@ -1,19 +1,19 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.4.0a2
-Summary: Provides pythonic access to the Anaplan API
+Version: 0.4.1
+Summary: Streamlined Python Interface for Anaplan
 Project-URL: Homepage, https://vinzenzklass.github.io/anaplan-sdk/
 Project-URL: Repository, https://github.com/VinzenzKlass/anaplan-sdk
 Project-URL: Documentation, https://vinzenzklass.github.io/anaplan-sdk/
 Author-email: Vinzenz Klass <vinzenz.klass@valantic.com>
 License-Expression: Apache-2.0
 License-File: LICENSE
-Keywords: anaplan,anaplan alm api,anaplan api,anaplan audit api,anaplan bulk api,anaplan integration
+Keywords: anaplan,anaplan alm api,anaplan api,anaplan audit api,anaplan bulk api,anaplan cloudworks api,anaplan integration,anaplan integration api,anaplan sdk,anaplan transactional api
 Requires-Python: >=3.10.4
 Requires-Dist: httpx<1.0.0,>=0.27.0
 Requires-Dist: pydantic<3.0.0,>=2.7.2
 Provides-Extra: cert
-Requires-Dist: cryptography<45.0.0,>=42.0.7; extra == 'cert'
+Requires-Dist: cryptography<46.0.0,>=42.0.7; extra == 'cert'
 Provides-Extra: oauth
 Requires-Dist: oauthlib<4.0.0,>=3.0.0; extra == 'oauth'
 Description-Content-Type: text/markdown

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/anaplan_sdk/_async_clients/_bulk.py

@@ -56,6 +56,7 @@ class AsyncClient(_AsyncBaseClient):
         redirect_uri: str | None = None,
         refresh_token: str | None = None,
         oauth2_scope: str = "openid profile email offline_access",
+        on_auth_code: Callable[[str], str] | None = None,
         on_token_refresh: Callable[[dict[str, str]], None] | None = None,
         timeout: float | httpx.Timeout = 30,
         retry_count: int = 2,
@@ -91,6 +92,9 @@ class AsyncClient(_AsyncBaseClient):
         :param refresh_token: If you have a valid refresh token, you can pass it to skip the
                               interactive authentication code step.
         :param oauth2_scope: The scope of the Oauth2 token, if you want to narrow it.
+        :param on_auth_code: A callback that takes the redirect URI as a single argument and must
+                             return the entire response URI. This will substitute the interactive
+                             authentication code step in the terminal.
         :param on_token_refresh: A callback function that is called whenever the token is refreshed.
                                  With this you can for example securely store the token in your
                                  application or on your server for later reuse. The function
@@ -124,6 +128,7 @@ class AsyncClient(_AsyncBaseClient):
                     redirect_uri=redirect_uri,
                     refresh_token=refresh_token,
                     oauth2_scope=oauth2_scope,
+                    on_auth_code=on_auth_code,
                     on_token_refresh=on_token_refresh,
                 )
             ),

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/anaplan_sdk/_async_clients/_transactional.py

@@ -92,7 +92,15 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
         """
         Insert new items to the given list. The items must be a list of dictionaries with at least
         the keys `code` and `name`. You can optionally pass further keys for parents, extra
-        properties etc.
+        properties etc. If you pass a long list, it will be split into chunks of 100,000 items, the
+        maximum allowed by the API.
+
+        **Warning**: If one or some of the requests timeout during large batch operations, the
+        operation may actually complete on the server. Retries for these chunks will then report
+        these items as "ignored" rather than "added", leading to misleading results. The results in
+        Anaplan will be correct, but this function may report otherwise. Be generous with your
+        timeouts and retries if you are using this function for large batch operations.
+
         :param list_id: The ID of the List.
         :param items: The items to insert into the List.
         :return: The result of the insertion, indicating how many items were added,
@@ -123,7 +131,16 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
 
     async def delete_list_items(self, list_id: int, items: list[dict[str, str | int]]) -> int:
         """
-        Deletes items from a List.
+        Deletes items from a List. If you pass a long list, it will be split into chunks of 100,000
+        items, the maximum allowed by the API.
+
+        **Warning**: If one or some of the requests timeout during large batch operations, the
+        operation may actually complete on the server. Retries for these chunks will then report
+        none of these items as deleted, since on the retry none are removed, leading to misleading
+        results. The results in Anaplan will be correct, but this function may report otherwise.
+        Be generous with your timeouts and retries if you are using this function for large batch
+        operations.
+
         :param list_id: The ID of the List.
         :param items: The items to delete from the List. Must be a dict with either `code` or `id`
                       as the keys to identify the records to delete.
@@ -158,8 +175,13 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
         """
         Write the passed items to the specified module. If successful, the number of cells changed
         is returned, if only partially successful or unsuccessful, the response with the according
-        details is returned instead. For more details,
-        see: https://anaplan.docs.apiary.io/#UpdateModuleCellData.
+        details is returned instead.
+
+        **You can update a maximum of 100,000 cells or 15 MB of data (whichever is lower) in a
+        single request.** You must chunk your data accordingly. This is not done by this SDK,
+        since it is discouraged. For larger imports, you should use the Bulk API instead.
+
+        For more details see: https://anaplan.docs.apiary.io/#UpdateModuleCellData.
         :param module_id: The ID of the Module.
         :param data: The data to write to the Module.
         :return: The number of cells changed or the response with the according error details.

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/anaplan_sdk/_auth.py

@@ -144,6 +144,7 @@ class AnaplanOauth2AuthCodeAuth(_AnaplanAuth):
         redirect_uri: str,
         refresh_token: str | None = None,
         scope: str = "openid profile email offline_access",
+        on_auth_code: Callable[[str], str] | None = None,
         on_token_refresh: Callable[[dict[str, str]], None] | None = None,
     ):
         try:
@@ -163,6 +164,7 @@ class AnaplanOauth2AuthCodeAuth(_AnaplanAuth):
         self._refresh_token = refresh_token
         self._scope = scope
         self._id_token = None
+        self._on_auth_code = on_auth_code
         self._on_token_refresh = on_token_refresh
         if not refresh_token:
             self.__auth_code_flow()
@@ -195,13 +197,17 @@ class AnaplanOauth2AuthCodeAuth(_AnaplanAuth):
         try:
             logger.info("Creating Authentication Token with OAuth2 Authorization Code Flow.")
             url, _, _ = self._oauth.prepare_authorization_request(
-                "https://us1a.app.anaplan.com/auth/authorize",
+                "https://us1a.app.anaplan.com/auth/prelogin",
                 redirect_url=self._redirect_uri,
                 scope=self._scope,
             )
-            authorization_response = input(
-                f"Please go to {url} and authorize the app.\n"
-                "Then paste the entire redirect URL here: "
+            authorization_response = (
+                self._on_auth_code(url)
+                if self._on_auth_code
+                else input(
+                    f"Please go to {url} and authorize the app.\n"
+                    "Then paste the entire redirect URL here: "
+                )
             )
             url, headers, body = self._oauth.prepare_token_request(
                 token_url=self._token_url,
@@ -211,7 +217,7 @@ class AnaplanOauth2AuthCodeAuth(_AnaplanAuth):
             )
             self._parse_auth_response(httpx.post(url=url, headers=headers, content=body))
         except (httpx.HTTPError, ValueError, TypeError, OAuth2Error) as error:
-            raise AnaplanException("Error during OAuth2 authorization flow.") from error
+            raise InvalidCredentialsException("Error during OAuth2 authorization flow.") from error
 
 
 def create_auth(
@@ -225,6 +231,7 @@ def create_auth(
     redirect_uri: str | None = None,
     refresh_token: str | None = None,
     oauth2_scope: str = "openid profile email offline_access",
+    on_auth_code: Callable[[str], str] | None = None,
     on_token_refresh: Callable[[dict[str, str]], None] | None = None,
 ) -> _AnaplanAuth:
     if certificate and private_key:
@@ -238,6 +245,7 @@ def create_auth(
             redirect_uri=redirect_uri,
             refresh_token=refresh_token,
             scope=oauth2_scope,
+            on_auth_code=on_auth_code,
             on_token_refresh=on_token_refresh,
         )
     raise ValueError(

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/anaplan_sdk/_base.py

@@ -12,11 +12,7 @@ from typing import Any, Callable, Coroutine, Iterator, Literal, Type, TypeVar
 import httpx
 from httpx import HTTPError, Response
 
-from .exceptions import (
-    AnaplanException,
-    AnaplanTimeoutException,
-    InvalidIdentifierException,
-)
+from .exceptions import AnaplanException, AnaplanTimeoutException, InvalidIdentifierException
 from .models import AnaplanModel
 from .models.cloud_works import (
     AmazonS3ConnectionInput,

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/anaplan_sdk/_clients/_bulk.py

@@ -58,6 +58,7 @@ class Client(_BaseClient):
         redirect_uri: str | None = None,
         refresh_token: str | None = None,
         oauth2_scope: str = "openid profile email offline_access",
+        on_auth_code: Callable[[str], str] | None = None,
         on_token_refresh: Callable[[dict[str, str]], None] | None = None,
         timeout: float | httpx.Timeout = 30,
         retry_count: int = 2,
@@ -94,6 +95,9 @@ class Client(_BaseClient):
         :param refresh_token: If you have a valid refresh token, you can pass it to skip the
                               interactive authentication code step.
         :param oauth2_scope: The scope of the Oauth2 token, if you want to narrow it.
+        :param on_auth_code: A callback that takes the redirect URI as a single argument and must
+                     return the entire response URI. This will substitute the interactive
+                     authentication code step in the terminal.
         :param on_token_refresh: A callback function that is called whenever the token is refreshed.
                                  With this you can for example securely store the token in your
                                  application or on your server for later reuse. The function
@@ -130,6 +134,7 @@ class Client(_BaseClient):
                     redirect_uri=redirect_uri,
                     refresh_token=refresh_token,
                     oauth2_scope=oauth2_scope,
+                    on_auth_code=on_auth_code,
                     on_token_refresh=on_token_refresh,
                 )
             ),
@@ -473,8 +478,7 @@ class Client(_BaseClient):
         :return: The identifier of the spawned Task.
         """
         response = self._post(
-            f"{self._url}/{action_url(action_id)}/{action_id}/tasks",
-            json={"localeName": "en_US"},
+            f"{self._url}/{action_url(action_id)}/{action_id}/tasks", json={"localeName": "en_US"}
         )
         task_id = response.get("task").get("taskId")
         logger.info(f"Invoked Action '{action_id}', spawned Task: '{task_id}'.")

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/anaplan_sdk/_clients/_transactional.py

@@ -86,7 +86,15 @@ class _TransactionalClient(_BaseClient):
         """
         Insert new items to the given list. The items must be a list of dictionaries with at least
         the keys `code` and `name`. You can optionally pass further keys for parents, extra
-        properties etc.
+        properties etc. If you pass a long list, it will be split into chunks of 100,000 items, the
+        maximum allowed by the API.
+
+        **Warning**: If one or some of the requests timeout during large batch operations, the
+        operation may actually complete on the server. Retries for these chunks will then report
+        these items as "ignored" rather than "added", leading to misleading results. The results in
+        Anaplan will be correct, but this function may report otherwise. Be generous with your
+        timeouts and retries if you are using this function for large batch operations.
+
         :param list_id: The ID of the List.
         :param items: The items to insert into the List.
         :return: The result of the insertion, indicating how many items were added,
@@ -120,7 +128,16 @@ class _TransactionalClient(_BaseClient):
 
     def delete_list_items(self, list_id: int, items: list[dict[str, str | int]]) -> int:
         """
-        Deletes items from a List.
+        Deletes items from a List. If you pass a long list, it will be split into chunks of 100,000
+        items, the maximum allowed by the API.
+
+        **Warning**: If one or some of the requests timeout during large batch operations, the
+        operation may actually complete on the server. Retries for these chunks will then report
+        none of these items as deleted, since on the retry none are removed, leading to misleading
+        results. The results in Anaplan will be correct, but this function may report otherwise.
+        Be generous with your timeouts and retries if you are using this function for large batch
+        operations.
+
         :param list_id: The ID of the List.
         :param items: The items to delete from the List. Must be a dict with either `code` or `id`
                       as the keys to identify the records to delete.
@@ -155,8 +172,13 @@ class _TransactionalClient(_BaseClient):
         """
         Write the passed items to the specified module. If successful, the number of cells changed
         is returned, if only partially successful or unsuccessful, the response with the according
-        details is returned instead. For more details,
-        see: https://anaplan.docs.apiary.io/#UpdateModuleCellData.
+        details is returned instead.
+
+        **You can update a maximum of 100,000 cells or 15 MB of data (whichever is lower) in a
+        single request.** You must chunk your data accordingly. This is not done by this SDK,
+        since it is discouraged. For larger imports, you should use the Bulk API instead.
+
+        For more details see: https://anaplan.docs.apiary.io/#UpdateModuleCellData.
         :param module_id: The ID of the Module.
         :param data: The data to write to the Module.
         :return: The number of cells changed or the response with the according error details.

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/anaplan_sdk/models/_base.py

@@ -6,12 +6,7 @@ class AnaplanModel(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
 
     @field_serializer(
-        "action_id",
-        "file_id",
-        "process_id",
-        "id",
-        when_used="unless-none",
-        check_fields=False,
+        "action_id", "file_id", "process_id", "id", when_used="unless-none", check_fields=False
     )  # While these are of type int, they are serialized as strings in the API payloads
     def str_serializer(self, v: int) -> str:
         return str(v)

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/anaplan_sdk/models/cloud_works.py

@@ -262,8 +262,7 @@ class SingleIntegration(Integration):
 
 class AnaplanSource(AnaplanModel):
     type: Literal["Anaplan"] = Field(
-        default="Anaplan",
-        description="Literal signifying this is an Anaplan source.",
+        default="Anaplan", description="Literal signifying this is an Anaplan source."
     )
     action_id: int = Field(
         description=(
@@ -294,20 +293,18 @@ class TableSource(AnaplanModel):
 
 class TableTarget(TableSource):
     overwrite: bool = Field(
-        default=False,
-        description="Whether to overwrite the table if it exists.",
+        default=False, description="Whether to overwrite the table if it exists."
     )
 
 
 class AnaplanTarget(AnaplanModel):
     type: Literal["Anaplan"] = Field(
-        default="Anaplan",
-        description="Literal signifying this is an Anaplan target.",
+        default="Anaplan", description="Literal signifying this is an Anaplan target."
     )
     action_id: int = Field(
         description=(
             "The ID of the action to be used as a target. This can be a process, or import."
-        ),
+        )
     )
     file_id: int = Field(description="The ID of the file to be used as a target.")
 
@@ -342,8 +339,7 @@ class IntegrationInput(AnaplanModel):
         ),
     )
     nux_visible: bool = Field(
-        default=False,
-        description="Whether this integration is visible in the UI.",
+        default=False, description="Whether this integration is visible in the UI."
     )
     jobs: list[IntegrationJobInput] = Field(
         description="The jobs in this integration.", min_length=1

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/docs/guides/authentication.md

@@ -142,6 +142,41 @@ will need to copy the entire redirect URI from your browser and paste it into th
     Unfortunately, registering localhost redirect URIs is not supported by Anaplan. This means we cannot intercept the
     redirect URI and extract the `authorization_code` automatically. This is a limitation of Anaplan's OAuth2 implementation. See [this Community Note](https://community.anaplan.com/discussion/156599/oauth-rediredt-url-port-for-desktop-apps).
 
+### Authorization Code
+
+When using OAuth authentication, the default behavior prompts you to manually open a URL, authorize the application, and paste the redirect URL back into your terminal. However, you can customize this flow by providing the `on_auth_code` callback.
+
+The `on_auth_code` callback lets you hook into the Auth Flow to handle the authorization URL programmatically and return the authorization response. `on_auth_code` must be a callable that takes the authorization URL as a single argument of type `str` and returns the redirect URL as a `str`.
+
+=== "Synchronous"
+    ```python
+    def on_auth_code(redirect_uri: str) -> str:
+        return input(f"Go fetch! {redirect_uri}\nPaste here: ")
+
+    anaplan = anaplan_sdk.Client(
+        workspace_id="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
+        model_id="11111111111111111111111111111111",
+        redirect_uri="https://vinzenzklass.github.io/anaplan-sdk",
+        client_id="my_anaplan_oauth_client_id",
+        client_secret="my_anaplan_oauth_client_secret",
+        on_auth_code=on_auth_code,
+    )
+    ```
+=== "Asynchronous"
+    ```python
+    def on_auth_code(redirect_uri: str) -> str:
+        return input(f"Go fetch! {redirect_uri}\nPaste here: ")
+
+    anaplan = anaplan_sdk.AsyncClient(
+        workspace_id="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
+        model_id="11111111111111111111111111111111",
+        redirect_uri="https://vinzenzklass.github.io/anaplan-sdk",
+        client_id="my_anaplan_oauth_client_id",
+        client_secret="my_anaplan_oauth_client_secret",
+        on_auth_code=on_auth_code,
+    )
+    ```
+
 ### Refresh Tokens
 
 You can extend the above example to also pass a `refresh_token` to authenticate without any user interaction, and 

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/pyproject.toml

@@ -1,11 +1,22 @@
 [project]
 name = "anaplan-sdk"
-version = "0.4.0a2"
-description = "Provides pythonic access to the Anaplan API"
+version = "0.4.1"
+description = "Streamlined Python Interface for Anaplan"
 license = "Apache-2.0"
 authors = [{ name = "Vinzenz Klass", email = "vinzenz.klass@valantic.com" }]
 readme = "README.md"
-keywords = ["anaplan", "anaplan api", "anaplan bulk api", "anaplan integration", "anaplan alm api", "anaplan audit api"]
+keywords = [
+    "anaplan",
+    "anaplan api",
+    "anaplan sdk",
+    "anaplan bulk api",
+    "anaplan integration",
+    "anaplan integration api",
+    "anaplan alm api",
+    "anaplan audit api",
+    "anaplan cloudworks api",
+    "anaplan transactional api",
+]
 requires-python = ">=3.10.4"
 dependencies = [
     "pydantic>=2.7.2,<3.0.0",
@@ -13,7 +24,7 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-cert = ["cryptography>=42.0.7,<45.0.0"]
+cert = ["cryptography>=42.0.7,<46.0.0"]
 oauth = ["oauthlib>=3.0.0,<4.0.0"]
 
 [dependency-groups]
@@ -29,8 +40,7 @@ dev = [
     "polars>=1.29.0",
     "griffe-fieldz>=0.2.1",
     "oauthlib>=3.2.2",
-    "cryptography>=42.0.7",
-    "pykeepass>=4.1.1.post1",
+    "cryptography>=45.0.0",
 ]
 
 [project.urls]
@@ -77,7 +87,7 @@ fix = true
 target-version = "py312"
 
 [tool.ruff.format]
-skip-magic-trailing-comma = false
+skip-magic-trailing-comma = true
 
 [tool.ruff.lint]
 select = ["E", "F", "B", "I"]
@@ -89,6 +99,4 @@ asyncio_default_test_loop_scope = "session"
 minversion = "8.0"
 addopts = "-ra -q"
 pythonpath = "anaplan_sdk/"
-testpaths = [
-    "tests",
-]
+testpaths = ["tests"]

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/tests/async/conftest.py

@@ -13,6 +13,7 @@ def client() -> AsyncClient:
         certificate=getenv("ANAPLAN_SDK_TEST_CERT"),
         private_key=getenv("ANAPLAN_SDK_TEST_PK"),
         retry_count=3,
+        timeout=120,
     )
 
 

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/tests/async/test_async_transactional_client.py

@@ -33,6 +33,8 @@ async def test_get_model_status(client: AsyncClient):
 async def test_long_list_insertion(client: AsyncClient, test_list, list_items_long):
     result = await client.transactional.insert_list_items(test_list, list_items_long)
     assert isinstance(result, InsertionResult)
+    assert result.failures == []
+    assert result.added == 200_000
     assert result.total == 200_000
 
 
@@ -44,6 +46,8 @@ async def test_long_list_deletion(client: AsyncClient, test_list, list_items_lon
 async def test_short_list_insertion(client: AsyncClient, test_list, list_items_short):
     result = await client.transactional.insert_list_items(test_list, list_items_short)
     assert isinstance(result, InsertionResult)
+    assert result.failures == []
+    assert result.added == 1_000
     assert result.total == 1_000
 
 

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/tests/conftest.py

@@ -247,12 +247,7 @@ def notification_dict(name):
         "integrationIds": [],
         "channels": ["in_app"],
         "notifications": {
-            "config": [
-                {
-                    "type": "full_failure",
-                    "users": ["8a868cd97f8f98a3017fe45cbdc65e25"],
-                }
-            ],
+            "config": [{"type": "full_failure", "users": ["8a868cd97f8f98a3017fe45cbdc65e25"]}]
         },
     }
 

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/tests/sync/conftest.py

@@ -13,6 +13,7 @@ def client() -> Client:
         certificate=getenv("ANAPLAN_SDK_TEST_CERT"),
         private_key=getenv("ANAPLAN_SDK_TEST_PK"),
         retry_count=3,
+        timeout=120,
     )
 
 

{anaplan_sdk-0.4.0a2 → anaplan_sdk-0.4.1}/tests/sync/test_transactional_client.py

@@ -33,6 +33,8 @@ def test_get_model_status(client: Client):
 def test_long_list_insertion(client: Client, test_list, list_items_long):
     result = client.transactional.insert_list_items(test_list, list_items_long)
     assert isinstance(result, InsertionResult)
+    assert result.failures == []
+    assert result.added == 200_000
     assert result.total == 200_000
 
 
@@ -44,6 +46,8 @@ def test_long_list_deletion(client: Client, test_list, list_items_long):
 def test_short_list_insertion(client: Client, test_list, list_items_short):
     result = client.transactional.insert_list_items(test_list, list_items_short)
     assert isinstance(result, InsertionResult)
+    assert result.failures == []
+    assert result.added == 1_000
     assert result.total == 1_000