# anaplan-api
Anaplan-API is a Python library wrapper for [Anaplan Bulk API](https://anaplanbulkapi20.docs.apiary.io/) and [Anaplan Authentication API](https://anaplanauthentication.docs.apiary.io/).
## Installation
Use the package manager [pip](https://pypi.org/project/anaplan-api/) to install Anaplan-API.
```bash
pip3 install anaplan_api
```
## Usage
```python
import logging
from anaplan_api.anaplan import anaplan
from anaplan_api.anaplan.models.AnaplanConnection import AnaplanConnection
from anaplan_api.anaplan.KeystoreManager import KeystoreManager
logging.basicConfig(format='%(asctime)s,%(msecs)d %(name)s %(levelname)s %(message)s',
datefmt='%H:%M:%S',
level=logging.INFO)
logger = logging.getLogger(__name__)
if __name__ == '__main__':
keys = KeystoreManager(path='/keystore.jks', passphrase='', alias='', key_pass='')
auth = anaplan.authorize("Basic", email="user@mail.com", password="password")
auth = anaplan.authorize("Certificate", private_key=keys.get_key(), certificate=keys.get_cert())
conn = AnaplanConnection(auth, "WorkspaceID", "ModelID")
anaplan.file_upload(conn=conn, file_id="", chunk_size=5, data='/Users.csv')
results = anaplan.execute_action(conn=conn, action_id="", retry_count=3)
for result in results:
if result: # Boolean check of ParserResponse object, true if failure dump is available
print(result.error_dump)
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[BSD](https://opensource.org/licenses/BSD-2-Clause)
Raw data
{
"_id": null,
"home_page": "https://github.com/jeswils-ap/anaplan-api",
"name": "anaplan-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "anaplan",
"author": "Jesse Wilson",
"author_email": "jeswils@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/19/58/d84f16439676f7866564cbd227240a8164237d2a0e4357af41ee9069c71d/anaplan-api-0.2.8.tar.gz",
"platform": null,
"description": "# anaplan-api\n\nAnaplan-API is a Python library wrapper for [Anaplan Bulk API](https://anaplanbulkapi20.docs.apiary.io/) and [Anaplan Authentication API](https://anaplanauthentication.docs.apiary.io/).\n\n## Installation\n\nUse the package manager [pip](https://pypi.org/project/anaplan-api/) to install Anaplan-API.\n\n```bash\npip3 install anaplan_api\n```\n\n## Usage\n\n```python\nimport logging\nfrom anaplan_api.anaplan import anaplan\nfrom anaplan_api.anaplan.models.AnaplanConnection import AnaplanConnection\nfrom anaplan_api.anaplan.KeystoreManager import KeystoreManager\n\nlogging.basicConfig(format='%(asctime)s,%(msecs)d %(name)s %(levelname)s %(message)s',\n datefmt='%H:%M:%S',\n level=logging.INFO)\n\nlogger = logging.getLogger(__name__)\n\nif __name__ == '__main__':\n keys = KeystoreManager(path='/keystore.jks', passphrase='', alias='', key_pass='')\n \n auth = anaplan.authorize(\"Basic\", email=\"user@mail.com\", password=\"password\")\n auth = anaplan.authorize(\"Certificate\", private_key=keys.get_key(), certificate=keys.get_cert())\n conn = AnaplanConnection(auth, \"WorkspaceID\", \"ModelID\")\n\n anaplan.file_upload(conn=conn, file_id=\"\", chunk_size=5, data='/Users.csv')\n\n results = anaplan.execute_action(conn=conn, action_id=\"\", retry_count=3)\n\n for result in results:\n if result: # Boolean check of ParserResponse object, true if failure dump is available\n print(result.error_dump)\n```\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n## License\n[BSD](https://opensource.org/licenses/BSD-2-Clause)\n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "A Python wrapper for the Anaplan Bulk API",
"version": "0.2.8",
"project_urls": {
"Homepage": "https://github.com/jeswils-ap/anaplan-api"
},
"split_keywords": [
"anaplan"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cace50283d09b1469c833cf16834e568b9cb662ca1896d8809df34f6a5eb9f70",
"md5": "085e641d435186a200aa05f5c86e64ee",
"sha256": "5507ce3b1fe58dc824b3723dc48dce454a5d7ce4156f1a93585c78ea6c6aff68"
},
"downloads": -1,
"filename": "anaplan_api-0.2.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "085e641d435186a200aa05f5c86e64ee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 66093,
"upload_time": "2024-03-27T03:57:29",
"upload_time_iso_8601": "2024-03-27T03:57:29.816423Z",
"url": "https://files.pythonhosted.org/packages/ca/ce/50283d09b1469c833cf16834e568b9cb662ca1896d8809df34f6a5eb9f70/anaplan_api-0.2.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1958d84f16439676f7866564cbd227240a8164237d2a0e4357af41ee9069c71d",
"md5": "8eb28a0838d22a9fd591b0667e081af2",
"sha256": "4f052055c63d2f6e7e7dcfcf1b30fa53e13bfd24a1284161edfaec16bc56131f"
},
"downloads": -1,
"filename": "anaplan-api-0.2.8.tar.gz",
"has_sig": false,
"md5_digest": "8eb28a0838d22a9fd591b0667e081af2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 44063,
"upload_time": "2024-03-27T03:57:32",
"upload_time_iso_8601": "2024-03-27T03:57:32.170551Z",
"url": "https://files.pythonhosted.org/packages/19/58/d84f16439676f7866564cbd227240a8164237d2a0e4357af41ee9069c71d/anaplan-api-0.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 03:57:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jeswils-ap",
"github_project": "anaplan-api",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "anaplan-api"
}
JSON
