anaplan-sdk 0.4.0a1

Provides pythonic access to the Anaplan API

Anaplan SDK

---

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 APIs, the Transactional APIs and the ALM APIs, the Audit APIs, providing both synchronous and asynchronous Clients.

Visit Anaplan SDK for documentation.

If you find any issues or feel that this SDK is not adequately covering your use case, please open an issue.

---

Install Anaplan SDK using pip

pip install anaplan-sdk

Instantiate a client

import anaplan_sdk

anaplan = anaplan_sdk.Client(
    workspace_id="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    model_id="11111111111111111111111111111111",
    user_email="[e-mail]",
    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()

anaplan = anaplan_sdk.Client(
    user_email="[e-mail]",
    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

import asyncio

anaplan = anaplan_sdk.AsyncClient(
    workspace_id="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    model_id="11111111111111111111111111111111",
    user_email="[e-mail]",
    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.

Contributing

Pull Requests are welcome. For major changes, please open an issue first to discuss what you would like to change. To submit a pull request, please follow the standard Fork & Pull Request workflow.

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:

uv sync --dev

ruff check
ruff format

You can also enable pre-commit hooks to automatically format and lint your code before committing:

pre-commit install

If your PR goes beyond a simple bug fix or small changes, please add tests to cover your changes.