anaplan-sdk 0.2.7__tar.gz → 0.2.8__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 (57) hide show
  1. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/PKG-INFO +9 -8
  2. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/README.md +8 -7
  3. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/anaplan_sdk/_async_clients/_audit.py +8 -1
  4. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/anaplan_sdk/_clients/_audit.py +8 -1
  5. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/api/async_audit_client.md +1 -1
  6. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/api/audit_client.md +1 -1
  7. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/pyproject.toml +1 -1
  8. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/uv.lock +1 -1
  9. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/.github/dependabot.yml +0 -0
  10. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/.github/workflows/docs.yml +0 -0
  11. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/.github/workflows/lint.yml +0 -0
  12. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/.github/workflows/tests.yml +0 -0
  13. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/.gitignore +0 -0
  14. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/.pre-commit-config.yaml +0 -0
  15. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/LICENSE +0 -0
  16. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/anaplan_sdk/__init__.py +0 -0
  17. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/anaplan_sdk/_async_clients/__init__.py +0 -0
  18. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/anaplan_sdk/_async_clients/_alm.py +0 -0
  19. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/anaplan_sdk/_async_clients/_bulk.py +0 -0
  20. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/anaplan_sdk/_async_clients/_transactional.py +0 -0
  21. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/anaplan_sdk/_auth.py +0 -0
  22. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/anaplan_sdk/_base.py +0 -0
  23. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/anaplan_sdk/_clients/__init__.py +0 -0
  24. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/anaplan_sdk/_clients/_alm.py +0 -0
  25. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/anaplan_sdk/_clients/_bulk.py +0 -0
  26. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/anaplan_sdk/_clients/_transactional.py +0 -0
  27. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/anaplan_sdk/exceptions.py +0 -0
  28. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/anaplan_sdk/models.py +0 -0
  29. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/anaplan_explained.md +0 -0
  30. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/api/alm_client.md +0 -0
  31. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/api/async_alm_client.md +0 -0
  32. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/api/async_client.md +0 -0
  33. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/api/async_transactional_client.md +0 -0
  34. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/api/client.md +0 -0
  35. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/api/exceptions.md +0 -0
  36. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/api/models.md +0 -0
  37. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/api/transactional_client.md +0 -0
  38. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/css/styles.css +0 -0
  39. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/guides/alm.md +0 -0
  40. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/guides/audit.md +0 -0
  41. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/guides/bulk.md +0 -0
  42. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/guides/bulk_vs_transactional.md +0 -0
  43. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/guides/logging.md +0 -0
  44. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/guides/multiple_models.md +0 -0
  45. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/guides/transactional.md +0 -0
  46. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/img/anaplan-overview.webp +0 -0
  47. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/img/anaplan-sdk.webp +0 -0
  48. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/index.md +0 -0
  49. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/installation.md +0 -0
  50. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/docs/quickstart.md +0 -0
  51. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/mkdocs.yml +0 -0
  52. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/tests/test_alm_client.py +0 -0
  53. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/tests/test_async_alm_client.py +0 -0
  54. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/tests/test_async_client.py +0 -0
  55. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/tests/test_async_transactional_client.py +0 -0
  56. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/tests/test_client.py +0 -0
  57. {anaplan_sdk-0.2.7 → anaplan_sdk-0.2.8}/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.7
3
+ Version: 0.2.8
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
@@ -22,6 +22,7 @@ Description-Content-Type: text/markdown
22
22
  <h1 align="center" style="font-size: 3rem; font-weight: 400; margin: -15px 0">
23
23
  Anaplan SDK
24
24
  </h1>
25
+
25
26
  <p align="center" style="margin-top: 15px">
26
27
  <a href="https://pepy.tech/project/anaplan-sdk">
27
28
  <img align="center" src="https://static.pepy.tech/badge/anaplan-sdk/month" alt="Downloads Badge"/>
@@ -30,15 +31,15 @@ Anaplan SDK
30
31
 
31
32
  ---
32
33
 
33
- Anaplan SDK is an independent, unofficial project providing pythonic access to
34
- the [Anaplan Integration API v2](https://anaplan.docs.apiary.io/). This Project aims to provide high-level abstractions
35
- over the API, so you can deal with python objects and simple functions rather than implementation details like HTTP
36
- Requests, Authentication, JSON Parsing, Compression, Chunking and so on.
34
+ Anaplan SDK is an independent, unofficial project providing pythonic access to Anaplan. Anaplan SDK provides high-level
35
+ abstractions over the various Anaplan APIs, so you can focus on you requirements rather than spend time on
36
+ implementation details like authentication, error handling, chunking, compression and data formatting.
37
37
 
38
38
  This Projects supports
39
- the [Bulk API](https://help.anaplan.com/use-the-bulk-apis-93218e5e-00e5-406e-8361-09ab861889a7),
40
- the [Transactional API](https://help.anaplan.com/use-the-transactional-apis-cc1c1e91-39fc-4272-a4b5-16bc91e9c313) and
41
- the [ALM API](https://help.anaplan.com/application-lifecycle-management-api-2565cfa6-e0c2-4e24-884e-d0df957184d6),
39
+ the [Bulk APIs](https://help.anaplan.com/use-the-bulk-apis-93218e5e-00e5-406e-8361-09ab861889a7),
40
+ the [Transactional APIs](https://help.anaplan.com/use-the-transactional-apis-cc1c1e91-39fc-4272-a4b5-16bc91e9c313) and
41
+ the [ALM APsI](https://help.anaplan.com/application-lifecycle-management-api-2565cfa6-e0c2-4e24-884e-d0df957184d6),
42
+ the [Audit APIs](https://auditservice.docs.apiary.io/#),
42
43
  providing both synchronous and asynchronous Clients.
43
44
 
44
45
  Visit [Anaplan SDK](https://vinzenzklass.github.io/anaplan-sdk/) for documentation.
@@ -5,6 +5,7 @@
5
5
  <h1 align="center" style="font-size: 3rem; font-weight: 400; margin: -15px 0">
6
6
  Anaplan SDK
7
7
  </h1>
8
+
8
9
  <p align="center" style="margin-top: 15px">
9
10
  <a href="https://pepy.tech/project/anaplan-sdk">
10
11
  <img align="center" src="https://static.pepy.tech/badge/anaplan-sdk/month" alt="Downloads Badge"/>
@@ -13,15 +14,15 @@ Anaplan SDK
13
14
 
14
15
  ---
15
16
 
16
- Anaplan SDK is an independent, unofficial project providing pythonic access to
17
- the [Anaplan Integration API v2](https://anaplan.docs.apiary.io/). This Project aims to provide high-level abstractions
18
- over the API, so you can deal with python objects and simple functions rather than implementation details like HTTP
19
- Requests, Authentication, JSON Parsing, Compression, Chunking and so on.
17
+ Anaplan SDK is an independent, unofficial project providing pythonic access to Anaplan. Anaplan SDK provides high-level
18
+ abstractions over the various Anaplan APIs, so you can focus on you requirements rather than spend time on
19
+ implementation details like authentication, error handling, chunking, compression and data formatting.
20
20
 
21
21
  This Projects supports
22
- the [Bulk API](https://help.anaplan.com/use-the-bulk-apis-93218e5e-00e5-406e-8361-09ab861889a7),
23
- the [Transactional API](https://help.anaplan.com/use-the-transactional-apis-cc1c1e91-39fc-4272-a4b5-16bc91e9c313) and
24
- the [ALM API](https://help.anaplan.com/application-lifecycle-management-api-2565cfa6-e0c2-4e24-884e-d0df957184d6),
22
+ the [Bulk APIs](https://help.anaplan.com/use-the-bulk-apis-93218e5e-00e5-406e-8361-09ab861889a7),
23
+ the [Transactional APIs](https://help.anaplan.com/use-the-transactional-apis-cc1c1e91-39fc-4272-a4b5-16bc91e9c313) and
24
+ the [ALM APsI](https://help.anaplan.com/application-lifecycle-management-api-2565cfa6-e0c2-4e24-884e-d0df957184d6),
25
+ the [Audit APIs](https://auditservice.docs.apiary.io/#),
25
26
  providing both synchronous and asynchronous Clients.
26
27
 
27
28
  Visit [Anaplan SDK](https://vinzenzklass.github.io/anaplan-sdk/) for documentation.
@@ -49,11 +49,18 @@ class _AsyncAuditClient(_AsyncBaseClient):
49
49
  ).get("response", [])
50
50
 
51
51
  async def get_events(self, days_into_past: int = 30, event_type: Event = "all") -> list:
52
+ """
53
+ Get audit events from Anaplan Audit API.
54
+ :param days_into_past: The nuber of days into the past to get events for. The API provides
55
+ data for up to 30 days.
56
+ :param event_type: The type of events to get.
57
+ :return: A list of audit events.
58
+ """
52
59
  total = await self._get_total(days_into_past, event_type)
53
60
  if total == 0:
54
61
  return []
55
62
  if total <= 10_000:
56
- return await self._get_result_page(total)
63
+ return await self._get_result_page(days_into_past, event_type)
57
64
 
58
65
  return list(
59
66
  chain.from_iterable(
@@ -49,11 +49,18 @@ class _AuditClient(_BaseClient):
49
49
  ).get("response", [])
50
50
 
51
51
  def get_events(self, days_into_past: int = 30, event_type: Event = "all") -> list:
52
+ """
53
+ Get audit events from Anaplan Audit API.
54
+ :param days_into_past: The nuber of days into the past to get events for. The API provides
55
+ data for up to 30 days.
56
+ :param event_type: The type of events to get.
57
+ :return: A list of audit events.
58
+ """
52
59
  total = self._get_total(days_into_past, event_type)
53
60
  if total == 0:
54
61
  return []
55
62
  if total <= 10_000:
56
- return self._get_result_page(total)
63
+ return self._get_result_page(days_into_past, event_type)
57
64
 
58
65
  from concurrent.futures import ThreadPoolExecutor
59
66
 
@@ -2,4 +2,4 @@
2
2
  This Class is not meant to be instantiated directly, but rather accessed through the `audit` Property on an
3
3
  instance of [Client](client.md). For more details, see the [Guide](../guides/audit.md).
4
4
 
5
- ::: anaplan_sdk._async_clients._audit._AuditClient
5
+ ::: anaplan_sdk._async_clients._AsyncAuditClient
@@ -2,4 +2,4 @@
2
2
  This Class is not meant to be instantiated directly, but rather accessed through the `audit` Property on an
3
3
  instance of [Client](client.md). For more details, see the [Guide](../guides/audit.md).
4
4
 
5
- ::: anaplan_sdk._clients._audit._AuditClient
5
+ ::: anaplan_sdk._clients._AuditClient
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "anaplan-sdk"
3
- version = "0.2.7"
3
+ version = "0.2.8"
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" }]
@@ -3,7 +3,7 @@ requires-python = ">=3.10.4"
3
3
 
4
4
  [[package]]
5
5
  name = "anaplan-sdk"
6
- version = "0.2.7"
6
+ version = "0.2.8"
7
7
  source = { editable = "." }
8
8
  dependencies = [
9
9
  { name = "cryptography" },
File without changes
File without changes
File without changes
File without changes