<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
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.
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),
providing both synchronous and asynchronous Clients.
Visit [Anaplan SDK](https://vinzenzklass.github.io/anaplan-sdk/) for documentation.
---
### 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/).
Raw data
{
"_id": null,
"home_page": null,
"name": "anaplan-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10.4",
"maintainer_email": null,
"keywords": "anaplan, anaplan alm api, anaplan api, anaplan bulk api, anaplan integration",
"author": null,
"author_email": "Vinzenz Klass <vinzenz.klass@ba.valantic.com>",
"download_url": "https://files.pythonhosted.org/packages/1d/96/6e3142a59c01be6404ad83710edb69a85159f97367f8ba2a0098ca1dcd5f/anaplan_sdk-0.2.3.tar.gz",
"platform": null,
"description": "<p align=\"center\" style=\"margin: 0 0 10px\">\n <img width=\"200\" height=\"200\" src=\"https://vinzenzklass.github.io/anaplan-sdk/img/anaplan-sdk.webp\" alt='Python' style=\"border-radius: 15px\">\n</p>\n\n<h1 align=\"center\" style=\"font-size: 3rem; font-weight: 400; margin: -15px 0\">\nAnaplan SDK\n</h1>\n<p align=\"center\" style=\"margin-top: 15px\">\n<a href=\"https://pepy.tech/project/anaplan-sdk\">\n<img align=\"center\" src=\"https://static.pepy.tech/badge/anaplan-sdk/month\" alt=\"Downloads Badge\"/>\n</a>\n</p>\n\n---\n\nAnaplan SDK is an independent, unofficial project providing pythonic access to\nthe [Anaplan Integration API v2](https://anaplan.docs.apiary.io/). This Project aims to provide high-level abstractions\nover the API, so you can deal with python objects and simple functions rather than implementation details like HTTP\nRequests, Authentication, JSON Parsing, Compression, Chunking and so on.\n\nThis Projects supports\nthe [Bulk API](https://help.anaplan.com/use-the-bulk-apis-93218e5e-00e5-406e-8361-09ab861889a7),\nthe [Transactional API](https://help.anaplan.com/use-the-transactional-apis-cc1c1e91-39fc-4272-a4b5-16bc91e9c313) and\nthe [ALM API](https://help.anaplan.com/application-lifecycle-management-api-2565cfa6-e0c2-4e24-884e-d0df957184d6),\nproviding both synchronous and asynchronous Clients.\n\nVisit [Anaplan SDK](https://vinzenzklass.github.io/anaplan-sdk/) for documentation.\n\n---\n\n### Install Anaplan SDK using pip\n\n```shell\npip install anaplan-sdk\n```\n\n### Instantiate a client\n\n```python\nimport anaplan_sdk\n\nanaplan = anaplan_sdk.Client(\n workspace_id=\"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\",\n model_id=\"11111111111111111111111111111111\",\n user_email=\"admin@company.com\",\n password=\"my_super_secret_password\",\n)\n```\n\n### Find workspaces and models\n\nIf you don't know the workspace and model Ids, instantiate client with authentication information only and\ncall `.list_workspaces()` and list `.list_models()`\n\n```python\nanaplan = anaplan_sdk.Client(\n user_email=\"admin@company.com\",\n password=\"my_super_secret_password\",\n)\n\nfor workspace in anaplan.list_workspaces():\n print(f\"{workspace.name}: {workspace.id}\")\n\nfor model in anaplan.list_models():\n print(f\"{model.name}: {model.id}\")\n```\n\n### Async Support\n\nThis SDK also provides an `AsyncClient` with full async support\n\n```python\nimport asyncio\n\nanaplan = anaplan_sdk.AsyncClient(\n workspace_id=\"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\",\n model_id=\"11111111111111111111111111111111\",\n user_email=\"admin@company.com\",\n password=\"my_super_secret_password\",\n)\nworkspaces, models = await asyncio.gather(\n anaplan.list_workspaces(), anaplan.list_models()\n)\nfor workspace in workspaces:\n print(f\"{workspace.name}: {workspace.id}\")\nfor model in models:\n print(f\"{model.name}: {model.id}\")\n```\n\nFor more information, API reference and detailed guides,\nvisit [Anaplan SDK](https://vinzenzklass.github.io/anaplan-sdk/).\n",
"bugtrack_url": null,
"license": null,
"summary": "Provides pythonic access to the Anaplan API",
"version": "0.2.3",
"project_urls": null,
"split_keywords": [
"anaplan",
" anaplan alm api",
" anaplan api",
" anaplan bulk api",
" anaplan integration"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9f5bda889355b4ebeebed65d71cdf4e015f1faaabc31103316385f90c7e6e90d",
"md5": "ef8b6944e14cee308912b77a998be3d5",
"sha256": "e30174621bbf806f828b7a015287c17477eb3b2a41ca7487e0516305fbab0f38"
},
"downloads": -1,
"filename": "anaplan_sdk-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ef8b6944e14cee308912b77a998be3d5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10.4",
"size": 30287,
"upload_time": "2025-02-20T08:38:07",
"upload_time_iso_8601": "2025-02-20T08:38:07.885881Z",
"url": "https://files.pythonhosted.org/packages/9f/5b/da889355b4ebeebed65d71cdf4e015f1faaabc31103316385f90c7e6e90d/anaplan_sdk-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1d966e3142a59c01be6404ad83710edb69a85159f97367f8ba2a0098ca1dcd5f",
"md5": "7c083ffd8f0bfed280791ca2a5797dbb",
"sha256": "51a71af044c3b7758b2fd1d4bf293f3fea2d1d5e930c544201c659e4047e893e"
},
"downloads": -1,
"filename": "anaplan_sdk-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "7c083ffd8f0bfed280791ca2a5797dbb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10.4",
"size": 167476,
"upload_time": "2025-02-20T08:38:10",
"upload_time_iso_8601": "2025-02-20T08:38:10.099996Z",
"url": "https://files.pythonhosted.org/packages/1d/96/6e3142a59c01be6404ad83710edb69a85159f97367f8ba2a0098ca1dcd5f/anaplan_sdk-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-20 08:38:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "anaplan-sdk"
}
JSON