anaplan-sdk 0.2.7__tar.gz → 0.2.9__tar.gz

{anaplan_sdk-0.2.7 → anaplan_sdk-0.2.9}/PKG-INFO

@@ -1,14 +1,14 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.2.7
+Version: 0.2.9
 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@ba.valantic.com>
+Author-email: Vinzenz Klass <vinzenz.klass@valantic.com>
 License-Expression: Apache-2.0
 License-File: LICENSE
-Keywords: anaplan,anaplan alm api,anaplan api,anaplan bulk api,anaplan integration
+Keywords: anaplan,anaplan alm api,anaplan api,anaplan audit api,anaplan bulk api,anaplan integration
 Requires-Python: >=3.10.4
 Requires-Dist: cryptography<45.0.0,>=42.0.7
 Requires-Dist: httpx<1.0.0,>=0.27.0
@@ -22,6 +22,7 @@ Description-Content-Type: text/markdown
 <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"/>
@@ -30,15 +31,15 @@ Anaplan SDK
 
 ---
 
-Anaplan SDK is an independent, unofficial project providing pythonic access to
-the [Anaplan Integration API v2](https://anaplan.docs.apiary.io/). This Project aims to provide high-level abstractions
-over the API, so you can deal with python objects and simple functions rather than implementation details like HTTP
-Requests, Authentication, JSON Parsing, Compression, Chunking and so on.
+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 API](https://help.anaplan.com/use-the-bulk-apis-93218e5e-00e5-406e-8361-09ab861889a7),
-the [Transactional API](https://help.anaplan.com/use-the-transactional-apis-cc1c1e91-39fc-4272-a4b5-16bc91e9c313) and
-the [ALM API](https://help.anaplan.com/application-lifecycle-management-api-2565cfa6-e0c2-4e24-884e-d0df957184d6),
+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 APsI](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.

{anaplan_sdk-0.2.7 → anaplan_sdk-0.2.9}/README.md

@@ -5,6 +5,7 @@
 <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"/>
@@ -13,15 +14,15 @@ Anaplan SDK
 
 ---
 
-Anaplan SDK is an independent, unofficial project providing pythonic access to
-the [Anaplan Integration API v2](https://anaplan.docs.apiary.io/). This Project aims to provide high-level abstractions
-over the API, so you can deal with python objects and simple functions rather than implementation details like HTTP
-Requests, Authentication, JSON Parsing, Compression, Chunking and so on.
+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 API](https://help.anaplan.com/use-the-bulk-apis-93218e5e-00e5-406e-8361-09ab861889a7),
-the [Transactional API](https://help.anaplan.com/use-the-transactional-apis-cc1c1e91-39fc-4272-a4b5-16bc91e9c313) and
-the [ALM API](https://help.anaplan.com/application-lifecycle-management-api-2565cfa6-e0c2-4e24-884e-d0df957184d6),
+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 APsI](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.

{anaplan_sdk-0.2.7 → anaplan_sdk-0.2.9}/anaplan_sdk/_async_clients/_alm.py

@@ -1,8 +1,12 @@
+import warnings
+
 import httpx
 
 from anaplan_sdk._base import _AsyncBaseClient
 from anaplan_sdk.models import ModelRevision, Revision, SyncTask, User
 
+warnings.filterwarnings("always", category=DeprecationWarning)
+
 
 class _AsyncAlmClient(_AsyncBaseClient):
     def __init__(self, client: httpx.AsyncClient, model_id: str, retry_count: int) -> None:
@@ -15,6 +19,12 @@ class _AsyncAlmClient(_AsyncBaseClient):
         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")

{anaplan_sdk-0.2.7 → anaplan_sdk-0.2.9}/anaplan_sdk/_async_clients/_audit.py

@@ -6,6 +6,7 @@ from typing import Literal
 import httpx
 
 from anaplan_sdk._base import _AsyncBaseClient
+from anaplan_sdk.models import User
 
 Event = Literal["all", "byok", "user_activity"]
 
@@ -17,6 +18,43 @@ 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]:
+        """
+        Lists all the Users in the authenticated users default tenant.
+        :return: The List of Users.
+        """
+        return [
+            User.model_validate(e)
+            for e in (await self._get("https://api.anaplan.com/2/0/users")).get("users")
+        ]
+
+    async def get_events(self, days_into_past: int = 30, event_type: Event = "all") -> list:
+        """
+        Get audit events from Anaplan Audit API.
+        :param days_into_past: The nuber of days into the past to get events for. The API provides
+        data for up to 30 days.
+        :param event_type: The type of events to get.
+        :return: A list of audit events.
+        """
+        total = await self._get_total(days_into_past, event_type)
+        if total == 0:
+            return []
+        if total <= 10_000:
+            return await self._get_result_page(days_into_past, event_type)
+
+        return list(
+            chain.from_iterable(
+                await gather(
+                    *(
+                        self._get_result_page(
+                            days_into_past, event_type, self._limit, n * self._limit
+                        )
+                        for n in range(ceil(total / self._limit))
+                    )
+                )
+            )
+        )
+
     async def _get_total(self, days_into_past: int = 60, event_type: Event = "all") -> int:
         return (  # noqa
             await self._get(
@@ -47,23 +85,3 @@ class _AsyncAuditClient(_AsyncBaseClient):
                 },
             )
         ).get("response", [])
-
-    async def get_events(self, days_into_past: int = 30, event_type: Event = "all") -> list:
-        total = await self._get_total(days_into_past, event_type)
-        if total == 0:
-            return []
-        if total <= 10_000:
-            return await self._get_result_page(total)
-
-        return list(
-            chain.from_iterable(
-                await gather(
-                    *(
-                        self._get_result_page(
-                            days_into_past, event_type, self._limit, n * self._limit
-                        )
-                        for n in range(ceil(total / self._limit))
-                    )
-                )
-            )
-        )

{anaplan_sdk-0.2.7 → anaplan_sdk-0.2.9}/anaplan_sdk/_clients/_alm.py

@@ -1,8 +1,12 @@
+import warnings
+
 import httpx
 
 from anaplan_sdk._base import _BaseClient
 from anaplan_sdk.models import ModelRevision, Revision, SyncTask, User
 
+warnings.filterwarnings("always", category=DeprecationWarning)
+
 
 class _AlmClient(_BaseClient):
     def __init__(self, client: httpx.Client, model_id: str, retry_count: int) -> None:
@@ -15,6 +19,12 @@ class _AlmClient(_BaseClient):
         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")

{anaplan_sdk-0.2.7 → anaplan_sdk-0.2.9}/anaplan_sdk/_clients/_audit.py

@@ -5,6 +5,7 @@ from typing import Literal
 import httpx
 
 from anaplan_sdk._base import _BaseClient
+from anaplan_sdk.models import User
 
 Event = Literal["all", "byok", "user_activity"]
 
@@ -17,6 +18,42 @@ class _AuditClient(_BaseClient):
         self._url = "https://audit.anaplan.com/audit/api/1/events"
         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.
+        """
+        return [
+            User.model_validate(e)
+            for e in self._get("https://api.anaplan.com/2/0/users").get("users")
+        ]
+
+    def get_events(self, days_into_past: int = 30, event_type: Event = "all") -> list:
+        """
+        Get audit events from Anaplan Audit API.
+        :param days_into_past: The nuber of days into the past to get events for. The API provides
+                               data for up to 30 days.
+        :param event_type: The type of events to get.
+        :return: A list of audit events.
+        """
+        total = self._get_total(days_into_past, event_type)
+        if total == 0:
+            return []
+        if total <= 10_000:
+            return self._get_result_page(days_into_past, event_type)
+
+        from concurrent.futures import ThreadPoolExecutor
+
+        with ThreadPoolExecutor(max_workers=self._thread_count) as executor:
+            futures = [
+                executor.submit(
+                    self._get_result_page, days_into_past, event_type, self._limit, n * self._limit
+                )
+                for n in range(ceil(total / self._limit))
+            ]
+            results = [future.result() for future in futures]
+            return list(chain.from_iterable(results))
+
     def _get_total(self, days_into_past: int = 60, event_type: Event = "all") -> int:
         return (  # noqa
             self._get(
@@ -47,22 +84,3 @@ class _AuditClient(_BaseClient):
                 },
             )
         ).get("response", [])
-
-    def get_events(self, days_into_past: int = 30, event_type: Event = "all") -> list:
-        total = self._get_total(days_into_past, event_type)
-        if total == 0:
-            return []
-        if total <= 10_000:
-            return self._get_result_page(total)
-
-        from concurrent.futures import ThreadPoolExecutor
-
-        with ThreadPoolExecutor(max_workers=self._thread_count) as executor:
-            futures = [
-                executor.submit(
-                    self._get_result_page, days_into_past, event_type, self._limit, n * self._limit
-                )
-                for n in range(ceil(total / self._limit))
-            ]
-            results = [future.result() for future in futures]
-            return list(chain.from_iterable(results))

{anaplan_sdk-0.2.7 → anaplan_sdk-0.2.9}/docs/api/async_audit_client.md

@@ -2,4 +2,4 @@
     This Class is not meant to be instantiated directly, but rather accessed through the `audit` Property on an
     instance of [Client](client.md). For more details, see the [Guide](../guides/audit.md).
 
-::: anaplan_sdk._async_clients._audit._AuditClient
+::: anaplan_sdk._async_clients._AsyncAuditClient

{anaplan_sdk-0.2.7 → anaplan_sdk-0.2.9}/docs/api/audit_client.md

@@ -2,4 +2,4 @@
     This Class is not meant to be instantiated directly, but rather accessed through the `audit` Property on an
     instance of [Client](client.md). For more details, see the [Guide](../guides/audit.md).
 
-::: anaplan_sdk._clients._audit._AuditClient
+::: anaplan_sdk._clients._AuditClient

anaplan_sdk-0.2.9/docs/guides/audit.md

@@ -0,0 +1,81 @@
+You can use the Audit API to get fine-grained information about the changes made to any model, usage, user sign-ins,
+most frequently visited pages and much more. The Audit API exposes most the logs collected by Anaplan.
+
+For API details refer to
+[the Documentation](https://auditservice.docs.apiary.io/#).
+
+## Usage
+
+!!! tip "Tenant Level API"
+    Note the absence of `workspace_id` and `model_id` in the Audit API. The Audit API is a tenant level API, meaning it
+    is not scoped to a specific workspace or model. You can use the Audit API to get information about all workspaces and
+    models for the default tenant of the user you are providing the credentials for.
+
+The methods for the Audit API reside in a different namespace for better API navigability and
+comprehensiveness, but are accessible through the same client for convenience. For e.g., you can call
+the `.get_events()` method like so:
+
+/// tab | Synchronous
+
+```python
+import anaplan_sdk
+
+anaplan = anaplan_sdk.Client(
+    certificate="~/certs/anaplan.pem", private_key="~/keys/anaplan.pem"
+)
+events = anaplan.audit.get_events()
+```
+
+///
+/// tab | Asynchronous
+
+```python
+import anaplan_sdk
+
+anaplan = anaplan_sdk.AsyncClient(
+    certificate="~/certs/anaplan.pem", private_key="~/keys/anaplan.pem"
+)
+events = await anaplan.audit.get_events()
+```
+
+///
+
+The Audit API also exposes the `list_users()` method to get a list of all users in the workspace. You can for e.g. use
+the two methods in combination to get a list of events with the username using [polars](https://docs.pola.rs):
+
+/// tab | Synchronous
+
+```python
+import polars as pl
+
+events, users = anaplan.audit.get_events(14), anaplan.audit.list_users()
+df = pl.DataFrame(events, orient="row", infer_schema_length=1_000).join(
+    pl.DataFrame(users, orient="row").select(
+        pl.col("id").alias("userId"), "first_name", "last_name"
+    ),
+    on="userId",
+    how="left",
+)
+```
+
+///
+/// tab | Asynchronous
+
+```python
+import polars as pl
+
+events, users = await gather(
+    anaplan.audit.get_events(14), anaplan.audit.list_users()
+)
+df = pl.DataFrame(events, orient="row", infer_schema_length=1_000).join(
+    pl.DataFrame(users, orient="row").select(
+        pl.col("id").alias("userId"), "first_name", "last_name"
+    ),
+    on="userId",
+    how="left",
+)
+```
+
+///
+
+

{anaplan_sdk-0.2.7 → anaplan_sdk-0.2.9}/pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "anaplan-sdk"
-version = "0.2.7"
+version = "0.2.9"
 description = "Provides pythonic access to the Anaplan API"
 license = "Apache-2.0"
-authors = [{ name = "Vinzenz Klass", email = "vinzenz.klass@ba.valantic.com" }]
+authors = [{ name = "Vinzenz Klass", email = "vinzenz.klass@valantic.com" }]
 readme = "README.md"
-keywords = ["anaplan", "anaplan api", "anaplan bulk api", "anaplan integration", "anaplan alm api"]
+keywords = ["anaplan", "anaplan api", "anaplan bulk api", "anaplan integration", "anaplan alm api", "anaplan audit api"]
 requires-python = ">=3.10.4"
 dependencies = [
     "pydantic>=2.7.2,<3.0.0",

{anaplan_sdk-0.2.7 → anaplan_sdk-0.2.9}/uv.lock

@@ -3,7 +3,7 @@ requires-python = ">=3.10.4"
 
 [[package]]
 name = "anaplan-sdk"
-version = "0.2.7"
+version = "0.2.9"
 source = { editable = "." }
 dependencies = [
     { name = "cryptography" },

anaplan_sdk-0.2.7/docs/guides/audit.md

@@ -1,42 +0,0 @@
-You can use the Audit API to get fine-grained information about the changes made to any model, usage, user sign-ins,
-most frequently visited pages and much more. The Audit API exposes most the logs collected by Anaplan.
-
-For details refer to
-[the Documentation](https://auditservice.docs.apiary.io/#).
-
-## Usage
-
-The method for the Audit API reside in a different namespace for better API navigability and
-comprehensiveness, but are accessible through the same client for convenience. For e.g., you can call
-the `.get_events()` method like so:
-
-/// tab | Synchronous
-
-```python
-import anaplan_sdk
-
-anaplan = anaplan_sdk.Client(
-    workspace_id="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
-    model_id="11111111111111111111111111111111",
-    certificate="~/certs/anaplan.pem",
-    private_key="~/keys/anaplan.pem",
-)
-events = anaplan.audit.get_events()
-```
-
-///
-/// tab | Asynchronous
-
-```python
-import anaplan_sdk
-
-anaplan = anaplan_sdk.AsyncClient(
-    workspace_id="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
-    model_id="11111111111111111111111111111111",
-    certificate="~/certs/anaplan.pem",
-    private_key="~/keys/anaplan.pem",
-)
-events = await anaplan.audit.get_events()
-```
-
-///