anaplan-sdk 0.4.0a1__py3-none-any.whl → 0.4.0a2__py3-none-any.whl

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/_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/_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/_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/_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/_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/_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/_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.dist-info/METADATA

@@ -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.0a1.dist-info → anaplan_sdk-0.4.0a2.dist-info}/RECORD

@@ -3,19 +3,19 @@ anaplan_sdk/_auth.py,sha256=wqlyrZwaJSEXW5J2-GV4UIw7KxDkfQ-loWdePVy2lWg,10231
 anaplan_sdk/_base.py,sha256=lKwtDSi1KRGDxd60Vv0prS_XhB7fsJkvtNWxI23njOA,12319
 anaplan_sdk/exceptions.py,sha256=ALkA9fBF0NQ7dufFxV6AivjmHyuJk9DOQ9jtJV2n7f0,1809
 anaplan_sdk/_async_clients/__init__.py,sha256=pZXgMMg4S9Aj_pxQCaSiPuNG-sePVGBtNJ0133VjqW4,364
-anaplan_sdk/_async_clients/_alm.py,sha256=bfLBJ5xu4hqqoc-QDGPNM7PuIAAIB_aD7yz68cpXfUA,3990
-anaplan_sdk/_async_clients/_audit.py,sha256=bD9ILvfyQ1xg73iRtRG-lX9ukwURhiDRVte8HYpkfe0,1830
-anaplan_sdk/_async_clients/_bulk.py,sha256=VAsgSXZM4kqcFJly0hvBP5f6rNHywdH3gDK7i7zl3yE,24421
+anaplan_sdk/_async_clients/_alm.py,sha256=O1_r-O1tNDq7vXRwE2UEFE5S2bPmPh4IAQPQ8bmZfQE,3297
+anaplan_sdk/_async_clients/_audit.py,sha256=a92RY0B3bWxp2CCAWjzqKfvBjG1LJGlai0Hn5qmwgF8,2312
+anaplan_sdk/_async_clients/_bulk.py,sha256=pvx0ux5tAAtCsNJrJorC_SDRxvDUSWu5aKPolE1_nuo,25297
 anaplan_sdk/_async_clients/_cloud_works.py,sha256=KPX9W55SF6h8fJd4Rx-HLq6eaRA-Vo3rFu343UiiaGQ,16642
 anaplan_sdk/_async_clients/_cw_flow.py,sha256=ZTNAbKDwb59Wg3u68hbtt1kpd-LNz9K0sftT-gvYzJQ,3651
-anaplan_sdk/_async_clients/_transactional.py,sha256=KBGH0XrQhbxq9fhhV5-ZflShJvpm8iHk0Jq9K_-lz6Y,7465
+anaplan_sdk/_async_clients/_transactional.py,sha256=zEM-wWxX-mCkk9H_nIl3WDZ6X3bo6LQxWLpfLCG5BDw,6524
 anaplan_sdk/_clients/__init__.py,sha256=FsbwvZC1FHrxuRXwbPxUzbhz_lO1DpXIxEOjx6-3QuA,219
-anaplan_sdk/_clients/_alm.py,sha256=i7S2FuvQEAWAfEd6xn0Hu9eWqlcnxsaXFqQvQCmeYNw,3881
-anaplan_sdk/_clients/_audit.py,sha256=rEWn2uBenv308hYSLH5PEEvYbNtP2THJw0Fp7fRJiX0,1834
-anaplan_sdk/_clients/_bulk.py,sha256=0s2EmHroWMvzFcIpH6LcVEvVWXLA9CUFMSnuQtLe4ls,24468
+anaplan_sdk/_clients/_alm.py,sha256=UAdQxgHfax-VquC0YtbqrRBku2Rn35tVgwJdxYFScps,3202
+anaplan_sdk/_clients/_audit.py,sha256=xQQiwWIb4QQefolPvxNwBFE-pkRzzi8fYPyewjF63lc,2181
+anaplan_sdk/_clients/_bulk.py,sha256=CaDFD5j5nZtvCPKwyVYBBpf1qr-OWMuPFXojF-fEM1k,25119
 anaplan_sdk/_clients/_cloud_works.py,sha256=KAMnLoeMJ2iwMXlDSbKynCE57BtkCfOgM5O8wT1kkSs,16291
 anaplan_sdk/_clients/_cw_flow.py,sha256=5IFWFT-qbyGvaSOOtaFOjHnOlyYbj4Rj3xiavfTlm8c,3527
-anaplan_sdk/_clients/_transactional.py,sha256=WlNgpTEvbeAAla9wFaWiv6LB6NhwPPNp3FDI1UgAxHw,7300
+anaplan_sdk/_clients/_transactional.py,sha256=o1wcAgVyIn2EdJL8Ivw6cW7KZ9OEFwv-PpbhvQAqCfo,6465
 anaplan_sdk/models/__init__.py,sha256=nSplwPG_74CG9CKbv1PzP9bsA9v5-daS4azpTCvCQTI,925
 anaplan_sdk/models/_alm.py,sha256=IqsTPvkx_ujLpaqZgIrTcr44KHJyKc4dyeRs9rkDjms,2307
 anaplan_sdk/models/_base.py,sha256=k2hGE0NmnNwLNJsPUuSjSYSUG9W2orZmMiCGYer7Zuk,554
@@ -23,7 +23,7 @@ anaplan_sdk/models/_bulk.py,sha256=dHP3kMvsKONCZS6mHB271-wp2S4P3rM874Ita8TzABU,8
 anaplan_sdk/models/_transactional.py,sha256=_0UbVR9D5QABI29yloYrJTSgL-K0EU7PzPeJu5LdhnY,4854
 anaplan_sdk/models/cloud_works.py,sha256=AWSwyVhAqOGYgWTbCTrfVQuqEY0_LW3ct5zxSZ7UKWs,19466
 anaplan_sdk/models/flows.py,sha256=SuLgNj5-2SeE3U1i8iY8cq2IkjuUgd_3M1n2ENructk,3625
-anaplan_sdk-0.4.0a1.dist-info/METADATA,sha256=uB_U8TLOlAGW4qGoDojbO28B9XIME4mglxwrm57SzO8,4751
-anaplan_sdk-0.4.0a1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-anaplan_sdk-0.4.0a1.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-anaplan_sdk-0.4.0a1.dist-info/RECORD,,
+anaplan_sdk-0.4.0a2.dist-info/METADATA,sha256=-hZsuCu5si1jen5pTxo307hfKXMTGYulIxFrsg_tsUw,3463
+anaplan_sdk-0.4.0a2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+anaplan_sdk-0.4.0a2.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+anaplan_sdk-0.4.0a2.dist-info/RECORD,,

anaplan_sdk-0.4.0a1.dist-info/METADATA

@@ -1,140 +0,0 @@
-Metadata-Version: 2.4
-Name: anaplan-sdk
-Version: 0.4.0a1
-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" style="margin: 0 0 10px">
-  <img width="200" height="200" src="https://vinzenzklass.github.io/anaplan-sdk/img/anaplan-sdk.webp" alt='Python' style="border-radius: 15px">
-</p>
-
-<h1 align="center" style="font-size: 3rem; font-weight: 400; margin: -15px 0">
-Anaplan SDK
-</h1>
-
-<p align="center" style="margin-top: 15px">
-<a href="https://pepy.tech/project/anaplan-sdk">
-<img align="center" src="https://static.pepy.tech/badge/anaplan-sdk/month" alt="Downloads Badge"/>
-</a>
-</p>
-
----
-
-Anaplan SDK is an independent, unofficial project providing pythonic access to Anaplan. Anaplan SDK provides high-level
-abstractions over the various Anaplan APIs, so you can focus on you requirements rather than spend time on
-implementation details like authentication, error handling, chunking, compression and data formatting.
-
-This Projects supports
-the [Bulk APIs](https://help.anaplan.com/use-the-bulk-apis-93218e5e-00e5-406e-8361-09ab861889a7),
-the [Transactional APIs](https://help.anaplan.com/use-the-transactional-apis-cc1c1e91-39fc-4272-a4b5-16bc91e9c313) and
-the [ALM APIs](https://help.anaplan.com/application-lifecycle-management-api-2565cfa6-e0c2-4e24-884e-d0df957184d6),
-the [Audit APIs](https://auditservice.docs.apiary.io/#),
-providing both synchronous and asynchronous Clients.
-
-Visit [Anaplan SDK](https://vinzenzklass.github.io/anaplan-sdk/) for documentation.
-
-If you find any issues or feel that this SDK is not adequately covering your use case,
-please [open an issue](https://github.com/VinzenzKlass/anaplan-sdk/issues/new).
-
----
-
-### Install Anaplan SDK using pip
-
-```shell
-pip install anaplan-sdk
-```
-
-### Instantiate a client
-
-```python
-import anaplan_sdk
-
-anaplan = anaplan_sdk.Client(
-    workspace_id="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
-    model_id="11111111111111111111111111111111",
-    user_email="admin@company.com",
-    password="my_super_secret_password",
-)
-```
-
-### Find workspaces and models
-
-If you don't know the workspace and model Ids, instantiate client with authentication information only and
-call `.list_workspaces()` and list `.list_models()`
-
-```python
-anaplan = anaplan_sdk.Client(
-    user_email="admin@company.com",
-    password="my_super_secret_password",
-)
-
-for workspace in anaplan.list_workspaces():
-    print(f"{workspace.name}: {workspace.id}")
-
-for model in anaplan.list_models():
-    print(f"{model.name}: {model.id}")
-```
-
-### Async Support
-
-This SDK also provides an `AsyncClient` with full async support
-
-```python
-import asyncio
-
-anaplan = anaplan_sdk.AsyncClient(
-    workspace_id="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
-    model_id="11111111111111111111111111111111",
-    user_email="admin@company.com",
-    password="my_super_secret_password",
-)
-workspaces, models = await asyncio.gather(
-    anaplan.list_workspaces(), anaplan.list_models()
-)
-for workspace in workspaces:
-    print(f"{workspace.name}: {workspace.id}")
-for model in models:
-    print(f"{model.name}: {model.id}")
-```
-
-For more information, API reference and detailed guides,
-visit [Anaplan SDK](https://vinzenzklass.github.io/anaplan-sdk/).
-
-### Contributing
-
-Pull Requests are welcome. For major changes, please open an issue 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.