anaplan-sdk 0.3.1b1__tar.gz → 0.4.0__tar.gz

anaplan_sdk-0.4.0/.github/workflows/lint.yml

@@ -0,0 +1,9 @@
+name: Ruff
+on: [ push, pull_request ]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
+      - run: ruff format --check

{anaplan_sdk-0.3.1b1 → anaplan_sdk-0.4.0}/.github/workflows/tests.yml

@@ -13,6 +13,8 @@ jobs:
       ANAPLAN_SDK_TEST_MODEL_ID: ${{secrets.ANAPLAN_SDK_TEST_MODEL_ID}}
       ANAPLAN_SDK_TEST_CERT: ${{secrets.ANAPLAN_SDK_TEST_CERT}}
       ANAPLAN_SDK_TEST_PK: ${{secrets.ANAPLAN_SDK_TEST_PK}}
+      AZ_STORAGE_ACCOUNT: ${{secrets.AZ_STORAGE_ACCOUNT}}
+      AZ_STORAGE_SAS_TOKEN: ${{secrets.AZ_STORAGE_SAS_TOKEN}}
 
     name: "Python ${{ matrix.python-version }}"
     runs-on: "ubuntu-latest"
@@ -32,4 +34,4 @@ jobs:
           pip install uv
           uv sync
       - name: "Run tests"
-        run: "uv run python -m pytest -n 8 --dist loadfile tests/"
+        run: "uv run python -m pytest -n 12 --dist loadfile tests/"

{anaplan_sdk-0.3.1b1 → anaplan_sdk-0.4.0}/.pre-commit-config.yaml

@@ -1,10 +1,10 @@
 repos:
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.5.29
+    rev: 0.7.3
     hooks:
       - id: uv-lock
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.9.6
+    rev: v0.11.9
     hooks:
       - id: ruff
         args: [ --fix ]

anaplan_sdk-0.4.0/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: anaplan-sdk
+Version: 0.4.0
+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 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<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
+
+<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.0/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.0/anaplan_sdk/_async_clients/__init__.py

@@ -0,0 +1,13 @@
+from ._alm import _AsyncAlmClient
+from ._audit import _AsyncAuditClient
+from ._bulk import AsyncClient
+from ._cloud_works import _AsyncCloudWorksClient
+from ._transactional import _AsyncTransactionalClient
+
+__all__ = [
+    "AsyncClient",
+    "_AsyncAlmClient",
+    "_AsyncAuditClient",
+    "_AsyncCloudWorksClient",
+    "_AsyncTransactionalClient",
+]

{anaplan_sdk-0.3.1b1 → anaplan_sdk-0.4.0}/anaplan_sdk/_async_clients/_alm.py

@@ -1,35 +1,14 @@
-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):
     def __init__(self, client: httpx.AsyncClient, model_id: str, retry_count: int) -> None:
-        self._client = client
         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.3.1b1 → anaplan_sdk-0.4.0}/anaplan_sdk/_async_clients/_audit.py

@@ -10,21 +10,36 @@ Event = Literal["all", "byok", "user_activity"]
 
 class _AsyncAuditClient(_AsyncBaseClient):
     def __init__(self, client: httpx.AsyncClient, retry_count: int) -> None:
-        self._client = client
         self._limit = 10_000
         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:
+        """
+        Retrieves information about the specified user, or the authenticated user if none specified.
+        :return: The requested or currently authenticated User.
+        """
+        return User.model_validate(
+            (await self._get(f"https://api.anaplan.com/2/0/users/{user_id}")).get("user")
+        )
+
     async def get_events(self, days_into_past: int = 30, event_type: Event = "all") -> list:
         """
         Get audit events from Anaplan Audit API.

{anaplan_sdk-0.3.1b1 → anaplan_sdk-0.4.0}/anaplan_sdk/_async_clients/_bulk.py

@@ -1,16 +1,12 @@
-"""
-Asynchronous Client.
-"""
-
 import logging
 from asyncio import gather, sleep
 from copy import copy
-from typing import AsyncIterator, Iterator
+from typing import AsyncIterator, Callable, Iterator
 
 import httpx
 from typing_extensions import Self
 
-from anaplan_sdk._auth import AnaplanBasicAuth, AnaplanCertAuth, get_certificate, get_private_key
+from anaplan_sdk._auth import create_auth
 from anaplan_sdk._base import _AsyncBaseClient, action_url
 from anaplan_sdk.exceptions import AnaplanActionError, InvalidIdentifierException
 from anaplan_sdk.models import (
@@ -27,6 +23,7 @@ from anaplan_sdk.models import (
 
 from ._alm import _AsyncAlmClient
 from ._audit import _AsyncAuditClient
+from ._cloud_works import _AsyncCloudWorksClient
 from ._transactional import _AsyncTransactionalClient
 
 logging.getLogger("httpx").setLevel(logging.CRITICAL)
@@ -54,7 +51,13 @@ class AsyncClient(_AsyncBaseClient):
         certificate: str | bytes | None = None,
         private_key: str | bytes | None = None,
         private_key_password: str | bytes | None = None,
-        timeout: float = 30,
+        client_id: str | None = None,
+        client_secret: str | None = None,
+        redirect_uri: str | None = None,
+        refresh_token: str | None = None,
+        oauth2_scope: str = "openid profile email offline_access",
+        on_token_refresh: Callable[[dict[str, str]], None] | None = None,
+        timeout: float | httpx.Timeout = 30,
         retry_count: int = 2,
         status_poll_delay: int = 1,
         upload_chunk_size: int = 25_000_000,
@@ -82,7 +85,19 @@ class AsyncClient(_AsyncBaseClient):
                             itself.
         :param private_key: The absolute path to the private key file or the private key itself.
         :param private_key_password: The password to access the private key if there is one.
-        :param timeout: The timeout in seconds for the HTTP requests.
+        :param client_id: The client Id of the Oauth2 Anaplan Client.
+        :param client_secret: The client secret for your Oauth2 Anaplan Client.
+        :param redirect_uri: The redirect URI for your Oauth2 Anaplan Client.
+        :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_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
+                                 must accept a single argument, which is the token dictionary
+                                 returned by the Oauth2 token endpoint and does not return anything.
+        :param timeout: The timeout in seconds for the HTTP requests. Alternatively, you can pass
+                        an instance of `httpx.Timeout` to set the timeout for the HTTP requests.
         :param retry_count: The number of times to retry an HTTP request if it fails. Set this to 0
                             to never retry. Defaults to 2, meaning each HTTP Operation will be
                             tried a total number of 2 times.
@@ -96,34 +111,38 @@ class AsyncClient(_AsyncBaseClient):
                             manually assigned so there is typically no value in dynamically
                             creating new files and uploading content to them.
         """
-        if not ((user_email and password) or (certificate and private_key)):
-            raise ValueError(
-                "Must provide `certificate` and `private_key` or `user_email` and `password`."
-                "If you Private Key is Password protected, must also pass `private_key_password`."
-            )
-        self._client = httpx.AsyncClient(
+        _client = httpx.AsyncClient(
             auth=(
-                AnaplanCertAuth(
-                    get_certificate(certificate), get_private_key(private_key, private_key_password)
+                create_auth(
+                    user_email=user_email,
+                    password=password,
+                    certificate=certificate,
+                    private_key=private_key,
+                    private_key_password=private_key_password,
+                    client_id=client_id,
+                    client_secret=client_secret,
+                    redirect_uri=redirect_uri,
+                    refresh_token=refresh_token,
+                    oauth2_scope=oauth2_scope,
+                    on_token_refresh=on_token_refresh,
                 )
-                if certificate
-                else AnaplanBasicAuth(user_email=user_email, password=password)
             ),
             timeout=timeout,
         )
         self._retry_count = retry_count
         self._url = f"https://api.anaplan.com/2/0/workspaces/{workspace_id}/models/{model_id}"
         self._transactional_client = (
-            _AsyncTransactionalClient(self._client, model_id, retry_count) if model_id else None
+            _AsyncTransactionalClient(_client, model_id, retry_count) if model_id else None
         )
         self._alm_client = (
-            _AsyncAlmClient(self._client, model_id, self._retry_count) if model_id else None
+            _AsyncAlmClient(_client, model_id, self._retry_count) if model_id else None
         )
-        self.audit = _AsyncAuditClient(self._client, self._retry_count)
+        self._audit = _AsyncAuditClient(_client, self._retry_count)
+        self._cloud_works = _AsyncCloudWorksClient(_client, self._retry_count)
         self.status_poll_delay = status_poll_delay
         self.upload_chunk_size = upload_chunk_size
         self.allow_file_creation = allow_file_creation
-        super().__init__(retry_count, self._client)
+        super().__init__(retry_count, _client)
 
     @classmethod
     def from_existing(cls, existing: Self, workspace_id: str, model_id: str) -> Self:
@@ -145,6 +164,22 @@ class AsyncClient(_AsyncBaseClient):
         client._alm_client = _AsyncAlmClient(existing._client, model_id, existing._retry_count)
         return client
 
+    @property
+    def audit(self) -> _AsyncAuditClient:
+        """
+        The Audit Client provides access to the Anaplan Audit API.
+        For details, see https://vinzenzklass.github.io/anaplan-sdk/guides/audit/.
+        """
+        return self._audit
+
+    @property
+    def cw(self) -> _AsyncCloudWorksClient:
+        """
+        The Cloud Works Client provides access to the Anaplan Cloud Works API.
+        For details, see https://vinzenzklass.github.io/anaplan-sdk/guides/cloud_works/.
+        """
+        return self._cloud_works
+
     @property
     def transactional(self) -> _AsyncTransactionalClient:
         """
@@ -184,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
             )
         ]