Skip to main content

Unofficial Anaplan API Python client library

Project description

APAPI

APAPI is an unofficial library that allows you to connect to Anaplan APIs using Python. Currently, you can authenticate using either Basic Authentication (email & password), or OAuth2 (client_id & refresh_token, both non-rotatable and rotatable) - Cert based authentication is on the roadmap. Use Bulk, Transactional, ALM and Audit endpoints, with more coming soon!

As an abstract example, here we export some CSV and import it back to Anaplan:

>> > import apapi
>> > with apapi.BasicAuth(f"{email}:{password}") as authentication:
    >> > my_connection = apapi.BulkConnection(authentication)
>> > my_connection.run_export(model_id, export_id)
>> > data = my_connection.get_file(model_id, export_id)
>> > print(data.decode())
Versions, Data, Text
Actual, 1, test
Budget, 2.5, ąćęłńśżź
Forecast, -3,😂
>> > my_connection.put_file(model_id, file_id, data)
>> > my_connection.run_import(model_id, import_id)

Full documentation can be found here. Check examples or tests for more examples and hints about usage.

Installing Anaplan Python API and Supported Versions

APAPI is available on PyPI:

$ python -m pip install apapi

APAPI supports Python 3.8+.

More Info

How to Contribute

Contributions are welcome, even if you can't code it - in such case, please submit an issue if you need any additional feature (preferably in the form of User Story, like "As {who} I need {what} because {why}"). If you encounter any bugs, please report the problem with a description and error log.

PyPI - Python Version PyPI - License Code style: black Imports: isort

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apapi-0.6.0.tar.gz (21.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apapi-0.6.0-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

Details for the file apapi-0.6.0.tar.gz.

File metadata

  • Download URL: apapi-0.6.0.tar.gz
  • Upload date:
  • Size: 21.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.0

File hashes

Hashes for apapi-0.6.0.tar.gz
Algorithm Hash digest
SHA256 3fb80280f5401a93d903d582c1c2dcaf0af2561d60c134285091f904dbf1d1ff
MD5 0e3dc3adeea2d5314dbc3045d7a2c2db
BLAKE2b-256 6d015638ebb61c73e67c846d46e2003d10b1f84ce8d39a8bf1ed2f9048422ed4

See more details on using hashes here.

File details

Details for the file apapi-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: apapi-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 23.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.0

File hashes

Hashes for apapi-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 64ec1c43bb12dee9e2211436130fc75c9f46aef1dcd134ef3dc65aeed2c4fdd0
MD5 a3491100d28f61b2d6612d199c54ad2c
BLAKE2b-256 6cbbe4146b0e08d89980ce4b0f9a037245f99c92c808230d9a9a1bd71aab9546

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page