anaplan-sdk 0.4.0a1__tar.gz → 0.4.0a2__tar.gz

anaplan_sdk-0.4.0a2/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: anaplan-sdk
+Version: 0.4.0a2
+Summary: Provides pythonic access to the Anaplan API
+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
+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'
+Provides-Extra: oauth
+Requires-Dist: oauthlib<4.0.0,>=3.0.0; extra == 'oauth'
+Description-Content-Type: text/markdown
+
+<p align="center">
+    <img width="160" height="160" src="https://vinzenzklass.github.io/anaplan-sdk/img/anaplan-sdk.webp" alt='Python' style="border-radius: 15px">
+</p>
+
+<h3 align="center" style="font-size: 3rem; font-weight: 600;">
+    Anaplan SDK
+</h3>
+
+<p align="center" style="font-size: 1.2rem; font-weight: 300; margin: 15px 0">
+    Streamlined Python Interface for Anaplan
+</p>
+
+<div align="center">
+    <a href="https://pepy.tech/projects/anaplan-sdk">
+        <img src="https://static.pepy.tech/badge/anaplan-sdk" alt="">
+    </a>
+    <a href="https://pypi.org/project/anaplan-sdk/">
+        <img src="https://img.shields.io/pypi/v/anaplan-sdk.svg" alt="PyPi Latest Release"/>
+    </a>
+    <a href="https://pepy.tech/projects/anaplan-sdk">
+        <img src="https://static.pepy.tech/badge/anaplan-sdk/month" alt="PyPI Downloads">
+    </a>
+</div>
+
+---
+
+Anaplan SDK is an independent, unofficial project providing pythonic access to Anaplan. It delivers high-level
+abstractions over all Anaplan APIs, allowing you to focus on business requirements rather than implementation details.
+
+## Key Features
+
+- **Pythonic Interface**: Clean, intuitive access to Anaplan functionality
+- **Simplified API Interactions**: Automatic handling of authentication, error handling, and data formatting
+- **Performance Optimizations**: Built-in chunking and compression techniques
+- **Multiple API Support**: Compatible with all major Anaplan API endpoints
+- **Flexible Client Options**: Both synchronous and asynchronous implementations
+- **Developer-Friendly**: Designed to reduce boilerplate code and accelerate development
+
+## Getting Started
+
+Head over to the [Quick Start](quickstart.md) for basic usage instructions and examples.
+
+## Contributing
+
+Pull Requests are welcome. For major changes,
+please [open an issue](https://github.com/VinzenzKlass/anaplan-sdk/issues/new) first to discuss what you would like to
+change. To submit a pull request, please follow the
+standard [Fork & Pull Request workflow](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
+
+Before submitting your pull request, please ensure that all the files pass linting and formatting checks. You can do
+this by running the following command:
+
+```shell
+uv sync --dev
+
+ruff check
+ruff format
+```
+
+You can also enable [pre-commit](https://pre-commit.com/) hooks to automatically format and lint your code before
+committing:
+
+```shell
+pre-commit install
+```
+
+If your PR goes beyond a simple bug fix or small changes, please add tests to cover your changes.

anaplan_sdk-0.4.0a2/README.md

@@ -0,0 +1,67 @@
+<p align="center">
+    <img width="160" height="160" src="https://vinzenzklass.github.io/anaplan-sdk/img/anaplan-sdk.webp" alt='Python' style="border-radius: 15px">
+</p>
+
+<h3 align="center" style="font-size: 3rem; font-weight: 600;">
+    Anaplan SDK
+</h3>
+
+<p align="center" style="font-size: 1.2rem; font-weight: 300; margin: 15px 0">
+    Streamlined Python Interface for Anaplan
+</p>
+
+<div align="center">
+    <a href="https://pepy.tech/projects/anaplan-sdk">
+        <img src="https://static.pepy.tech/badge/anaplan-sdk" alt="">
+    </a>
+    <a href="https://pypi.org/project/anaplan-sdk/">
+        <img src="https://img.shields.io/pypi/v/anaplan-sdk.svg" alt="PyPi Latest Release"/>
+    </a>
+    <a href="https://pepy.tech/projects/anaplan-sdk">
+        <img src="https://static.pepy.tech/badge/anaplan-sdk/month" alt="PyPI Downloads">
+    </a>
+</div>
+
+---
+
+Anaplan SDK is an independent, unofficial project providing pythonic access to Anaplan. It delivers high-level
+abstractions over all Anaplan APIs, allowing you to focus on business requirements rather than implementation details.
+
+## Key Features
+
+- **Pythonic Interface**: Clean, intuitive access to Anaplan functionality
+- **Simplified API Interactions**: Automatic handling of authentication, error handling, and data formatting
+- **Performance Optimizations**: Built-in chunking and compression techniques
+- **Multiple API Support**: Compatible with all major Anaplan API endpoints
+- **Flexible Client Options**: Both synchronous and asynchronous implementations
+- **Developer-Friendly**: Designed to reduce boilerplate code and accelerate development
+
+## Getting Started
+
+Head over to the [Quick Start](quickstart.md) for basic usage instructions and examples.
+
+## Contributing
+
+Pull Requests are welcome. For major changes,
+please [open an issue](https://github.com/VinzenzKlass/anaplan-sdk/issues/new) first to discuss what you would like to
+change. To submit a pull request, please follow the
+standard [Fork & Pull Request workflow](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
+
+Before submitting your pull request, please ensure that all the files pass linting and formatting checks. You can do
+this by running the following command:
+
+```shell
+uv sync --dev
+
+ruff check
+ruff format
+```
+
+You can also enable [pre-commit](https://pre-commit.com/) hooks to automatically format and lint your code before
+committing:
+
+```shell
+pre-commit install
+```
+
+If your PR goes beyond a simple bug fix or small changes, please add tests to cover your changes.

{anaplan_sdk-0.4.0a1 → anaplan_sdk-0.4.0a2}/anaplan_sdk/_async_clients/_alm.py

@@ -1,11 +1,7 @@
-import warnings
-
 import httpx
 
 from anaplan_sdk._base import _AsyncBaseClient
-from anaplan_sdk.models import ModelRevision, Revision, SyncTask, User
-
-warnings.filterwarnings("always", category=DeprecationWarning)
+from anaplan_sdk.models import ModelRevision, Revision, SyncTask
 
 
 class _AsyncAlmClient(_AsyncBaseClient):
@@ -13,22 +9,6 @@ class _AsyncAlmClient(_AsyncBaseClient):
         self._url = f"https://api.anaplan.com/2/0/models/{model_id}/alm"
         super().__init__(retry_count, client)
 
-    async def list_users(self) -> list[User]:
-        """
-        Lists all the Users in the authenticated users default tenant.
-        :return: The List of Users.
-        """
-        warnings.warn(
-            "`list_users()` on the ALM client is deprecated and will be removed in a "
-            "future version. Use `list_users()` on the Audit client instead.",
-            DeprecationWarning,
-            stacklevel=1,
-        )
-        return [
-            User.model_validate(e)
-            for e in (await self._get("https://api.anaplan.com/2/0/users")).get("users")
-        ]
-
     async def get_syncable_revisions(self, source_model_id: str) -> list[Revision]:
         """
         Use this call to return the list of revisions from your source model that can be

{anaplan_sdk-0.4.0a1 → anaplan_sdk-0.4.0a2}/anaplan_sdk/_async_clients/_audit.py

@@ -14,14 +14,21 @@ class _AsyncAuditClient(_AsyncBaseClient):
         self._url = "https://audit.anaplan.com/audit/api/1/events"
         super().__init__(retry_count, client)
 
-    async def list_users(self) -> list[User]:
+    async def list_users(self, search_pattern: str | None = None) -> list[User]:
         """
         Lists all the Users in the authenticated users default tenant.
+        :param search_pattern: Optionally filter for specific users. When provided,
+               case-insensitive matches users with emails or names containing this string.
+               You can use the wildcards `%` for 0-n characters, and `_` for exactly 1 character.
+               When None (default), returns all users.
         :return: The List of Users.
         """
+        params = {"s": search_pattern} if search_pattern else None
         return [
             User.model_validate(e)
-            for e in await self._get_paginated("https://api.anaplan.com/2/0/users", "users")
+            for e in await self._get_paginated(
+                "https://api.anaplan.com/2/0/users", "users", params=params
+            )
         ]
 
     async def get_user(self, user_id: str = "me") -> User:

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

@@ -219,29 +219,41 @@ class AsyncClient(_AsyncBaseClient):
             )
         return self._alm_client
 
-    async def list_workspaces(self) -> list[Workspace]:
+    async def list_workspaces(self, search_pattern: str | None = None) -> list[Workspace]:
         """
         Lists all the Workspaces the authenticated user has access to.
+        :param search_pattern: Optionally filter for specific workspaces. When provided,
+               case-insensitive matches workspaces with names containing this string.
+               You can use the wildcards `%` for 0-n characters, and `_` for exactly 1 character.
+               When None (default), returns all users.
         :return: The List of Workspaces.
         """
+        params = {"tenantDetails": "true"}
+        if search_pattern:
+            params["s"] = search_pattern
         return [
             Workspace.model_validate(e)
             for e in await self._get_paginated(
-                "https://api.anaplan.com/2/0/workspaces",
-                "workspaces",
-                params={"tenantDetails": "true"},
+                "https://api.anaplan.com/2/0/workspaces", "workspaces", params=params
             )
         ]
 
-    async def list_models(self) -> list[Model]:
+    async def list_models(self, search_pattern: str | None = None) -> list[Model]:
         """
         Lists all the Models the authenticated user has access to.
+        :param search_pattern: Optionally filter for specific models. When provided,
+               case-insensitive matches models names containing this string.
+               You can use the wildcards `%` for 0-n characters, and `_` for exactly 1 character.
+               When None (default), returns all users.
         :return: The List of Models.
         """
+        params = {"modelDetails": "true"}
+        if search_pattern:
+            params["s"] = search_pattern
         return [
             Model.model_validate(e)
             for e in await self._get_paginated(
-                "https://api.anaplan.com/2/0/models", "models", params={"modelDetails": "true"}
+                "https://api.anaplan.com/2/0/models", "models", params=params
             )
         ]
 

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

@@ -1,4 +1,3 @@
-import warnings
 from asyncio import gather
 from itertools import chain
 from typing import Any
@@ -16,8 +15,6 @@ from anaplan_sdk.models import (
     Module,
 )
 
-warnings.filterwarnings("always", category=DeprecationWarning)
-
 
 class _AsyncTransactionalClient(_AsyncBaseClient):
     def __init__(self, client: httpx.AsyncClient, model_id: str, retry_count: int) -> None:
@@ -169,25 +166,3 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
         """
         res = await self._post(f"{self._url}/modules/{module_id}/data", json=data)
         return res if "failures" in res else res["numberOfCellsChanged"]
-
-    async def write_to_module(
-        self, module_id: int, data: list[dict[str, Any]]
-    ) -> int | dict[str, Any]:
-        warnings.warn(
-            "`write_to_module()` is deprecated and will be removed in a future version. "
-            "Use `update_module_data()` instead.",
-            DeprecationWarning,
-            stacklevel=1,
-        )
-        return await self.update_module_data(module_id, data)
-
-    async def add_items_to_list(
-        self, list_id: int, items: list[dict[str, str | int | dict]]
-    ) -> InsertionResult:
-        warnings.warn(
-            "`add_items_to_list()` is deprecated and will be removed in a future version. "
-            "Use `insert_list_items()` instead.",
-            DeprecationWarning,
-            stacklevel=1,
-        )
-        return await self.insert_list_items(list_id, items)

{anaplan_sdk-0.4.0a1 → anaplan_sdk-0.4.0a2}/anaplan_sdk/_clients/_alm.py

@@ -1,11 +1,7 @@
-import warnings
-
 import httpx
 
 from anaplan_sdk._base import _BaseClient
-from anaplan_sdk.models import ModelRevision, Revision, SyncTask, User
-
-warnings.filterwarnings("always", category=DeprecationWarning)
+from anaplan_sdk.models import ModelRevision, Revision, SyncTask
 
 
 class _AlmClient(_BaseClient):
@@ -13,22 +9,6 @@ class _AlmClient(_BaseClient):
         self._url = f"https://api.anaplan.com/2/0/models/{model_id}/alm"
         super().__init__(retry_count, client)
 
-    def list_users(self) -> list[User]:
-        """
-        Lists all the Users in the authenticated users default tenant.
-        :return: The List of Users.
-        """
-        warnings.warn(
-            "`list_users()` on the ALM client is deprecated and will be removed in a "
-            "future version. Use `list_users()` on the Audit client instead.",
-            DeprecationWarning,
-            stacklevel=1,
-        )
-        return [
-            User.model_validate(e)
-            for e in self._get("https://api.anaplan.com/2/0/users").get("users")
-        ]
-
     def get_syncable_revisions(self, source_model_id: str) -> list[Revision]:
         """
         Use this call to return the list of revisions from your source model that can be

{anaplan_sdk-0.4.0a1 → anaplan_sdk-0.4.0a2}/anaplan_sdk/_clients/_audit.py

@@ -15,14 +15,19 @@ class _AuditClient(_BaseClient):
         self._url = "https://audit.anaplan.com/audit/api/1/events"
         super().__init__(retry_count, client)
 
-    def list_users(self) -> list[User]:
+    def list_users(self, search_pattern: str | None = None) -> list[User]:
         """
         Lists all the Users in the authenticated users default tenant.
+        :param search_pattern: Optional filter for users. When provided, case-insensitive matches
+               users with emails containing this string. When None (default), returns all users.
         :return: The List of Users.
         """
+        params = {"s": search_pattern} if search_pattern else None
         return [
             User.model_validate(e)
-            for e in self._get_paginated("https://api.anaplan.com/2/0/users", "users")
+            for e in self._get_paginated(
+                "https://api.anaplan.com/2/0/users", "users", params=params
+            )
         ]
 
     def get_user(self, user_id: str = "me") -> User:

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

@@ -225,29 +225,38 @@ class Client(_BaseClient):
             )
         return self._alm_client
 
-    def list_workspaces(self) -> list[Workspace]:
+    def list_workspaces(self, search_pattern: str | None = None) -> list[Workspace]:
         """
         Lists all the Workspaces the authenticated user has access to.
+        :param search_pattern: Optional filter for workspaces. When provided, case-insensitive
+               matches workspaces with names containing this string. When None (default),
+               returns all workspaces.
         :return: The List of Workspaces.
         """
+        params = {"tenantDetails": "true"}
+        if search_pattern:
+            params["s"] = search_pattern
         return [
             Workspace.model_validate(e)
             for e in self._get_paginated(
-                "https://api.anaplan.com/2/0/workspaces",
-                "workspaces",
-                params={"tenantDetails": "true"},
+                "https://api.anaplan.com/2/0/workspaces", "workspaces", params=params
             )
         ]
 
-    def list_models(self) -> list[Model]:
+    def list_models(self, search_pattern: str | None = None) -> list[Model]:
         """
         Lists all the Models the authenticated user has access to.
+        :param search_pattern: Optional filter for models. When provided, case-insensitive matches
+               models with names containing this string. When None (default), returns all models.
         :return: The List of Models.
         """
+        params = {"modelDetails": "true"}
+        if search_pattern:
+            params["s"] = search_pattern
         return [
             Model.model_validate(e)
             for e in self._get_paginated(
-                "https://api.anaplan.com/2/0/models", "models", params={"modelDetails": "true"}
+                "https://api.anaplan.com/2/0/models", "models", params=params
             )
         ]
 

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

@@ -1,4 +1,3 @@
-import warnings
 from concurrent.futures import ThreadPoolExecutor
 from itertools import chain
 from typing import Any
@@ -164,23 +163,3 @@ class _TransactionalClient(_BaseClient):
         """
         res = self._post(f"{self._url}/modules/{module_id}/data", json=data)
         return res if "failures" in res else res["numberOfCellsChanged"]
-
-    def write_to_module(self, module_id: int, data: list[dict[str, Any]]) -> int | dict[str, Any]:
-        warnings.warn(
-            "`write_to_module()` is deprecated and will be removed in a future version. "
-            "Use `update_module_data()` instead.",
-            DeprecationWarning,
-            stacklevel=1,
-        )
-        return self.update_module_data(module_id, data)
-
-    def add_items_to_list(
-        self, list_id: int, items: list[dict[str, str | int | dict]]
-    ) -> InsertionResult:
-        warnings.warn(
-            "`add_items_to_list()` is deprecated and will be removed in a future version. "
-            "Use `insert_list_items()` instead.",
-            DeprecationWarning,
-            stacklevel=1,
-        )
-        return self.insert_list_items(list_id, items)

anaplan_sdk-0.4.0a2/docs/anaplan_explained.md

@@ -0,0 +1,68 @@
+# Anaplan Basics
+
+This guide explains key Anaplan concepts for developers working with the Bulk API. You can think of the flow of uploading data to Anaplan with the Bulk API like so:
+
+<iframe id="bulk-overview"  src="../assets/overview.html"></iframe>
+
+---
+
+## Quick Overview
+
+- You upload data to files in Anaplan. The only supported file formats are `csv` and `xlsx`.
+- Import Actions move data from files to Lists & Modules
+- Export Actions move data from Lists & Modules to files
+- You download these files to retrieve data
+- Processes are sequences of actions
+- **Never** run concurrent operations that reference the same file.
+
+
+## Files
+
+- All data exchange happens through files (referenced by ID (113000000000), not SFTP/FTP)
+- Files have a 48-hour lifetime
+- Files are **not safe for concurrent access**. You can override the content of a file while another import is reading
+  from it. Anaplan does not acquire locks and will not queue the task.
+
+## Actions
+
+All data is exchanged through files. When uploading data, you are uploading the data to a file previously registered
+with Anaplan. When downloading data, you are downloading a file either registered with Anaplan or produced by an
+export action. Anaplan does not use (S)FTP, you will reference these files only by their ID and send or receive their
+content in the body of HTTP Requests.
+
+- Anaplan has the following type of actions:
+    - Imports - 112000000000 IDs.
+    - Exports - 116000000000 IDs.
+    - Processes - 118000000000 IDs.
+    - Other Actions - 117000000000 IDs.
+
+Imports read data from a file and load it into a module. Exports conversely load data from a module to a file. The
+file id of the resulting file is identical to the export id. "Other Actions" move things around in Anaplan and can
+also delete data etc. Processes are simply a sequence of the other three.
+
+Invoking any Action will spawn a Task. You can then query the status of this task.
+
+Files are **NOT Safe** for concurrent access. If you want to override the content of a file while an import is being
+run against it, you can. Import and Export Actions, however, are. If you run an Export while an Import into a module
+that will affect the data of the module you are trying to export from, Anaplan will queue this task. No dirty reads.
+
+## Imports
+
+Imports read data from a file and load it into a list or module. Only after running an Import against the file you just
+uploaded is the data actually "in" Anaplan. Only uploading a file will do nothing and after 48h - the lifetime for files
+in Anaplan - the content will simply vanish. Import Actions are quite powerful and can incur mapping of columns from
+i.e. a csv structure to dimensions in Anaplan, type conversion, date parsing and more. They are also quite easy to get
+wrong and very sensitive to change.
+
+## Exports
+
+When you want to get some data from Anaplan, you will have to do the reverse of an Import, in two similar steps. First,
+you run an export and wait for the spawned task to complete. Then you can download the content of the file that was
+populated by the export action. The File will have the same ID as the Export Action that produced it.
+
+## Processes
+
+A Process is just an arbitrary sequence of any kind of actions. These are useful for grouping actions that must only be
+run together or just represent some logical grouping. Processes can include import an export actions. When loading data
+to or from Anaplan with a process, you will have to find the Import or Export contained in the process, and the
+referenced data source in the case of an Import.

{anaplan_sdk-0.4.0a1 → anaplan_sdk-0.4.0a2}/docs/api/async/async_alm_client.md

@@ -1,4 +1,4 @@
-!!! note
+???+ note
     This Class is not meant to be instantiated directly, but rather accessed through the `alm` Property on an
     instance of [AsyncClient](async_client.md). For more details, see the [Guide](../../guides/alm.md).
 

{anaplan_sdk-0.4.0a1 → anaplan_sdk-0.4.0a2}/docs/api/async/async_audit_client.md

@@ -1,4 +1,4 @@
-!!! note
+???+ note
     This Class is not meant to be instantiated directly, but rather accessed through the `audit` Property on an
     instance of [AsyncClient](async_client.md). For more details, see the [Guide](../../guides/audit.md).
 

anaplan_sdk-0.4.0a2/docs/api/async/async_cw_client.md

@@ -0,0 +1,5 @@
+???+ note
+    This Class is not meant to be instantiated directly, but rather accessed through the `cw` Property on an
+    instance of [AsyncClient](async_client.md). For more details, see the [Guide](../../guides/cloud_works.md).
+
+::: anaplan_sdk._async_clients._AsyncCloudWorksClient

anaplan_sdk-0.4.0a2/docs/api/async/async_flows_client.md

@@ -0,0 +1,5 @@
+???+ note
+    This Class is not meant to be instantiated directly, but rather accessed through the `cw.flows` Property on an
+    instance of [AsyncClient](async_client.md). For more details, see the [Guide](../../guides/cloud_works.md).
+
+::: anaplan_sdk._async_clients._cw_flow._AsyncFlowClient

anaplan_sdk-0.4.0a2/docs/api/sync/sync_cw_client.md

@@ -0,0 +1,5 @@
+???+ note
+    This Class is not meant to be instantiated directly, but rather accessed through the `cw` Property on an
+    instance of [Client](sync_client.md). For more details, see the [Guide](../../guides/cloud_works.md).
+
+::: anaplan_sdk._async_clients._AsyncCloudWorksClient

anaplan_sdk-0.4.0a2/docs/api/sync/sync_flows_client.md

@@ -0,0 +1,5 @@
+???+ note
+    This Class is not meant to be instantiated directly, but rather accessed through the `cw.flows` Property on an
+    instance of [Client](sync_client.md). For more details, see the [Guide](../../guides/cloud_works.md).
+
+::: anaplan_sdk._async_clients._cw_flow._AsyncFlowClient