anaplan-sdk 0.2.5__tar.gz → 0.2.6__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/PKG-INFO +1 -1
  2. anaplan_sdk-0.2.6/anaplan_sdk/_async_clients/_audit.py +69 -0
  3. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/anaplan_sdk/_async_clients/_bulk.py +2 -0
  4. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/anaplan_sdk/_base.py +8 -4
  5. anaplan_sdk-0.2.6/anaplan_sdk/_clients/_audit.py +68 -0
  6. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/anaplan_sdk/_clients/_bulk.py +2 -0
  7. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/pyproject.toml +3 -2
  8. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/uv.lock +1101 -1129
  9. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/.github/dependabot.yml +0 -0
  10. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/.github/workflows/docs.yml +0 -0
  11. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/.github/workflows/lint.yml +0 -0
  12. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/.github/workflows/tests.yml +0 -0
  13. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/.gitignore +0 -0
  14. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/.pre-commit-config.yaml +0 -0
  15. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/LICENSE +0 -0
  16. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/README.md +0 -0
  17. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/anaplan_sdk/__init__.py +0 -0
  18. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/anaplan_sdk/_async_clients/__init__.py +0 -0
  19. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/anaplan_sdk/_async_clients/_alm.py +0 -0
  20. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/anaplan_sdk/_async_clients/_transactional.py +0 -0
  21. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/anaplan_sdk/_auth.py +0 -0
  22. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/anaplan_sdk/_clients/__init__.py +0 -0
  23. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/anaplan_sdk/_clients/_alm.py +0 -0
  24. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/anaplan_sdk/_clients/_transactional.py +0 -0
  25. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/anaplan_sdk/exceptions.py +0 -0
  26. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/anaplan_sdk/models.py +0 -0
  27. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/alm.md +0 -0
  28. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/alm_client.md +0 -0
  29. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/anaplan_explained.md +0 -0
  30. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/async_alm_client.md +0 -0
  31. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/async_client.md +0 -0
  32. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/async_transactional_client.md +0 -0
  33. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/bulk.md +0 -0
  34. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/bulk_vs_transactional.md +0 -0
  35. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/client.md +0 -0
  36. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/css/styles.css +0 -0
  37. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/exceptions.md +0 -0
  38. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/img/anaplan-overview.webp +0 -0
  39. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/img/anaplan-sdk.webp +0 -0
  40. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/index.md +0 -0
  41. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/installation.md +0 -0
  42. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/logging.md +0 -0
  43. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/models.md +0 -0
  44. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/multiple_models.md +0 -0
  45. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/quickstart.md +0 -0
  46. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/transactional.md +0 -0
  47. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/docs/transactional_client.md +0 -0
  48. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/mkdocs.yml +0 -0
  49. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/tests/test_alm_client.py +0 -0
  50. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/tests/test_async_alm_client.py +0 -0
  51. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/tests/test_async_client.py +0 -0
  52. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/tests/test_async_transactional_client.py +0 -0
  53. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/tests/test_client.py +0 -0
  54. {anaplan_sdk-0.2.5 → anaplan_sdk-0.2.6}/tests/test_transactional_client.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: anaplan-sdk
3
- Version: 0.2.5
3
+ Version: 0.2.6
4
4
  Summary: Provides pythonic access to the Anaplan API
5
5
  Project-URL: Homepage, https://vinzenzklass.github.io/anaplan-sdk/
6
6
  Project-URL: Repository, https://github.com/VinzenzKlass/anaplan-sdk
@@ -0,0 +1,69 @@
1
+ from asyncio import gather
2
+ from itertools import chain
3
+ from math import ceil
4
+ from typing import Literal
5
+
6
+ import httpx
7
+
8
+ from anaplan_sdk._base import _AsyncBaseClient
9
+
10
+ Event = Literal["all", "byok", "user_activity"]
11
+
12
+
13
+ class _AuditClient(_AsyncBaseClient):
14
+ def __init__(self, client: httpx.AsyncClient, retry_count: int) -> None:
15
+ self._client = client
16
+ self._limit = 10_000
17
+ self._url = "https://audit.anaplan.com/audit/api/1/events"
18
+ super().__init__(retry_count, client)
19
+
20
+ async def _get_total(self, days_into_past: int = 60, event_type: Event = "all") -> int:
21
+ return ( # noqa
22
+ await self._get(
23
+ self._url,
24
+ params={
25
+ "limit": 0,
26
+ "type": event_type,
27
+ "intervalInHours": days_into_past * 24,
28
+ },
29
+ )
30
+ )["meta"]["paging"]["totalSize"] # noqa
31
+
32
+ async def _get_result_page(
33
+ self,
34
+ days_into_past: int = 60,
35
+ event_type: Event = "all",
36
+ limit: int = 10_000,
37
+ offset: int = 0,
38
+ ) -> list:
39
+ return (
40
+ await self._get(
41
+ self._url,
42
+ params={
43
+ "intervalInHours": days_into_past * 24,
44
+ "limit": limit,
45
+ "offset": offset,
46
+ "type": event_type,
47
+ },
48
+ )
49
+ ).get("response", [])
50
+
51
+ async def get_events(self, days_into_past: int = 30, event_type: Event = "all") -> list:
52
+ total = await self._get_total(days_into_past, event_type)
53
+ if total == 0:
54
+ return []
55
+ if total <= 10_000:
56
+ return await self._get_result_page(total)
57
+
58
+ return list(
59
+ chain.from_iterable(
60
+ await gather(
61
+ *(
62
+ self._get_result_page(
63
+ days_into_past, event_type, self._limit, n * self._limit
64
+ )
65
+ for n in range(ceil(total / self._limit))
66
+ )
67
+ )
68
+ )
69
+ )
@@ -17,6 +17,7 @@ from anaplan_sdk.exceptions import AnaplanActionError, InvalidIdentifierExceptio
17
17
  from anaplan_sdk.models import Action, Export, File, Import, Model, Process, Workspace
18
18
 
19
19
  from ._alm import _AsyncAlmClient
20
+ from ._audit import _AuditClient
20
21
  from ._transactional import _AsyncTransactionalClient
21
22
 
22
23
  logging.getLogger("httpx").setLevel(logging.CRITICAL)
@@ -109,6 +110,7 @@ class AsyncClient(_AsyncBaseClient):
109
110
  self._alm_client = (
110
111
  _AsyncAlmClient(self._client, model_id, self._retry_count) if model_id else None
111
112
  )
113
+ self.audit = _AuditClient(self._client, self._retry_count)
112
114
  self.status_poll_delay = status_poll_delay
113
115
  self.upload_chunk_size = upload_chunk_size
114
116
  self.allow_file_creation = allow_file_creation
@@ -23,8 +23,8 @@ class _BaseClient:
23
23
  self._retry_count = retry_count
24
24
  self._client = client
25
25
 
26
- def _get(self, url: str) -> dict[str, float | int | str | list | dict | bool]:
27
- return self._run_with_retry(self._client.get, url).json()
26
+ def _get(self, url: str, **kwargs) -> dict[str, float | int | str | list | dict | bool]:
27
+ return self._run_with_retry(self._client.get, url, **kwargs).json()
28
28
 
29
29
  def _get_binary(self, url: str) -> bytes:
30
30
  return self._run_with_retry(self._client.get, url).content
@@ -59,14 +59,16 @@ class _BaseClient:
59
59
  url = args[0] or kwargs.get("url")
60
60
  logger.info(f"Retrying for: {url}")
61
61
 
62
+ raise AnaplanException("Exhausted all retries without a successful response or Error.")
63
+
62
64
 
63
65
  class _AsyncBaseClient:
64
66
  def __init__(self, retry_count: int, client: httpx.AsyncClient):
65
67
  self._retry_count = retry_count
66
68
  self._client = client
67
69
 
68
- async def _get(self, url: str) -> dict[str, float | int | str | list | dict | bool]:
69
- return (await self._run_with_retry(self._client.get, url)).json()
70
+ async def _get(self, url: str, **kwargs) -> dict[str, float | int | str | list | dict | bool]:
71
+ return (await self._run_with_retry(self._client.get, url, **kwargs)).json()
70
72
 
71
73
  async def _get_binary(self, url: str) -> bytes:
72
74
  return (await self._run_with_retry(self._client.get, url)).content
@@ -105,6 +107,8 @@ class _AsyncBaseClient:
105
107
  url = args[0] or kwargs.get("url")
106
108
  logger.info(f"Retrying for: {url}")
107
109
 
110
+ raise AnaplanException("Exhausted all retries without a successful response or Error.")
111
+
108
112
 
109
113
  def action_url(action_id: int) -> Literal["imports", "exports", "actions", "processes"]:
110
114
  """
@@ -0,0 +1,68 @@
1
+ from itertools import chain
2
+ from math import ceil
3
+ from typing import Literal
4
+
5
+ import httpx
6
+
7
+ from anaplan_sdk._base import _BaseClient
8
+
9
+ Event = Literal["all", "byok", "user_activity"]
10
+
11
+
12
+ class _AuditClient(_BaseClient):
13
+ def __init__(self, client: httpx.Client, retry_count: int, thread_count: int) -> None:
14
+ self._client = client
15
+ self._limit = 10_000
16
+ self._thread_count = thread_count
17
+ self._url = "https://audit.anaplan.com/audit/api/1/events"
18
+ super().__init__(retry_count, client)
19
+
20
+ def _get_total(self, days_into_past: int = 60, event_type: Event = "all") -> int:
21
+ return ( # noqa
22
+ self._get(
23
+ self._url,
24
+ params={
25
+ "limit": 0,
26
+ "type": event_type,
27
+ "intervalInHours": days_into_past * 24,
28
+ },
29
+ )
30
+ )["meta"]["paging"]["totalSize"] # noqa
31
+
32
+ def _get_result_page(
33
+ self,
34
+ days_into_past: int = 60,
35
+ event_type: Event = "all",
36
+ limit: int = 10_000,
37
+ offset: int = 0,
38
+ ) -> list:
39
+ return (
40
+ self._get(
41
+ self._url,
42
+ params={
43
+ "intervalInHours": days_into_past * 24,
44
+ "limit": limit,
45
+ "offset": offset,
46
+ "type": event_type,
47
+ },
48
+ )
49
+ ).get("response", [])
50
+
51
+ def get_events(self, days_into_past: int = 30, event_type: Event = "all") -> list:
52
+ total = self._get_total(days_into_past, event_type)
53
+ if total == 0:
54
+ return []
55
+ if total <= 10_000:
56
+ return self._get_result_page(total)
57
+
58
+ from concurrent.futures import ThreadPoolExecutor
59
+
60
+ with ThreadPoolExecutor(max_workers=self._thread_count) as executor:
61
+ futures = [
62
+ executor.submit(
63
+ self._get_result_page, days_into_past, event_type, self._limit, n * self._limit
64
+ )
65
+ for n in range(ceil(total / self._limit))
66
+ ]
67
+ results = [future.result() for future in futures]
68
+ return list(chain.from_iterable(results))
@@ -18,6 +18,7 @@ from anaplan_sdk.exceptions import AnaplanActionError, InvalidIdentifierExceptio
18
18
  from anaplan_sdk.models import Action, Export, File, Import, Model, Process, Workspace
19
19
 
20
20
  from ._alm import _AlmClient
21
+ from ._audit import _AuditClient
21
22
  from ._transactional import _TransactionalClient
22
23
 
23
24
  logging.getLogger("httpx").setLevel(logging.CRITICAL)
@@ -115,6 +116,7 @@ class Client(_BaseClient):
115
116
  _AlmClient(self._client, model_id, self._retry_count) if model_id else None
116
117
  )
117
118
  self._thread_count = multiprocessing.cpu_count()
119
+ self.audit = _AuditClient(self._client, self._retry_count, self._thread_count)
118
120
  self.status_poll_delay = status_poll_delay
119
121
  self.upload_parallel = upload_parallel
120
122
  self.upload_chunk_size = upload_chunk_size
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "anaplan-sdk"
3
- version = "0.2.5"
3
+ version = "0.2.6"
4
4
  description = "Provides pythonic access to the Anaplan API"
5
5
  license = "Apache-2.0"
6
6
  authors = [{ name = "Vinzenz Klass", email = "vinzenz.klass@ba.valantic.com" }]
@@ -22,7 +22,8 @@ dev = [
22
22
  "pytest-xdist>=3.6.1",
23
23
  "mkdocs>=1.6.1",
24
24
  "mkdocs-material>=9.5.41",
25
- "mkdocstrings[python]>=0.26.2"
25
+ "mkdocstrings[python]>=0.26.2",
26
+ "polars>=1.25.2",
26
27
  ]
27
28
 
28
29
  [project.urls]