| Name | aiobastion JSON |
| Version |
0.1.8
JSON |
| download |
| home_page | None |
| Summary | Manage your Cyberark implementation |
| upload_time | 2024-11-13 09:02:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | Copyright (c) 2018 The Python Packaging Authority Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
cyberark
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# aiobastion
**aiobastion** is a simple and fully asynchronous framework for [Cyberark API](https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/WebServices/Implementing%20Privileged%20Account%20Security%20Web%20Services%20.htm) written in Python 3.11 with [asyncio](https://docs.python.org/3/library/asyncio.html) and [aiohttp](https://github.com/aio-libs/aiohttp).
It helps you to manage your Cyberark implementation faster and in an intuitive way.
## Examples
See [examples of usage](https://aiobastion.readthedocs.io/en/latest/started.html#examples) in the [documentation](https://aiobastion.readthedocs.io/en/latest/index.html)
## Quick (and dirty) start
### List safes
Here's a minimal python snippet to list safes
```python
import aiobastion
import asyncio
from aiobastion import GetTokenException
async def main():
# Define your PVWA host here
pvwa_host = "pvwa.mycompany.fr"
vault = aiobastion.EPV(serialized={'api_host': pvwa_host})
# Define login and password
login = input("Login: ")
password = input("Password: ")
# Login to the PVWA
try:
await vault.login(login, password)
except GetTokenException as err:
print(f"An error occured while login : {err}")
await vault.close_session()
exit(0)
# Working with PVWA
async with vault as epv:
# For example, listing all safes
safes = await epv.safe.list()
for s in safes:
print(s)
if __name__ == '__main__':
asyncio.run(main())
```
## Getting started
[Define a config file](https://aiobastion.readthedocs.io/en/latest/login.html#define-a-configuration-file), and start using functions to avoid spending hours in annoying tasks in the PVWA :
* [Accounts manipulation](https://aiobastion.readthedocs.io/en/latest/accounts.html)
* [Safe manipulation](https://aiobastion.readthedocs.io/en/latest/safe.html)
* [User manipulation](https://aiobastion.readthedocs.io/en/latest/users.html)
* Check the documentation for more
## Documentation
The documention is hosted on readthedocs : https://aiobastion.readthedocs.io/en/latest/index.html
## Rationale
I've been working on Cyberark projects for years and I see everywhere a profusion of scripts, very often complicated and long to execute for very simple tasks (sometimes even with a "do not turn off" post-it on the screen).
This package makes it quick and easy to accomplish without having to deal with the specifics of the Cyberark API.
The acquisition time may be longer than for other well-known libraries, but, believe me, you will save this time very quickly.
Raw data
{
"_id": null,
"home_page": null,
"name": "aiobastion",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "cyberark",
"author": null,
"author_email": "Gautier Leveille <gleveille@pm.me>",
"download_url": "https://files.pythonhosted.org/packages/a3/be/f3bf964e0342d5a43354d487b8fa85c3f3e15661f4431d7df8a892c05f16/aiobastion-0.1.8.tar.gz",
"platform": null,
"description": "# aiobastion\n\n**aiobastion** is a simple and fully asynchronous framework for [Cyberark API](https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/WebServices/Implementing%20Privileged%20Account%20Security%20Web%20Services%20.htm) written in Python 3.11 with [asyncio](https://docs.python.org/3/library/asyncio.html) and [aiohttp](https://github.com/aio-libs/aiohttp). \nIt helps you to manage your Cyberark implementation faster and in an intuitive way.\n\n\n## Examples\nSee [examples of usage](https://aiobastion.readthedocs.io/en/latest/started.html#examples) in the [documentation](https://aiobastion.readthedocs.io/en/latest/index.html)\n\n## Quick (and dirty) start\n### List safes\n\nHere's a minimal python snippet to list safes\n\n```python \nimport aiobastion\nimport asyncio\n\nfrom aiobastion import GetTokenException\n\n\nasync def main():\n # Define your PVWA host here\n pvwa_host = \"pvwa.mycompany.fr\"\n vault = aiobastion.EPV(serialized={'api_host': pvwa_host})\n \n # Define login and password\n login = input(\"Login: \")\n password = input(\"Password: \")\n\n # Login to the PVWA\n try:\n await vault.login(login, password)\n except GetTokenException as err:\n print(f\"An error occured while login : {err}\")\n await vault.close_session()\n exit(0)\n\n # Working with PVWA\n async with vault as epv:\n # For example, listing all safes\n safes = await epv.safe.list()\n for s in safes:\n print(s)\n\nif __name__ == '__main__':\n asyncio.run(main())\n\n```\n\n\n\n## Getting started\n[Define a config file](https://aiobastion.readthedocs.io/en/latest/login.html#define-a-configuration-file), and start using functions to avoid spending hours in annoying tasks in the PVWA :\n\n* [Accounts manipulation](https://aiobastion.readthedocs.io/en/latest/accounts.html)\n* [Safe manipulation](https://aiobastion.readthedocs.io/en/latest/safe.html)\n* [User manipulation](https://aiobastion.readthedocs.io/en/latest/users.html)\n* Check the documentation for more\n\n\n## Documentation\nThe documention is hosted on readthedocs : https://aiobastion.readthedocs.io/en/latest/index.html\n\n## Rationale\n\nI've been working on Cyberark projects for years and I see everywhere a profusion of scripts, very often complicated and long to execute for very simple tasks (sometimes even with a \"do not turn off\" post-it on the screen).\nThis package makes it quick and easy to accomplish without having to deal with the specifics of the Cyberark API.\nThe acquisition time may be longer than for other well-known libraries, but, believe me, you will save this time very quickly.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2018 The Python Packaging Authority Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Manage your Cyberark implementation",
"version": "0.1.8",
"project_urls": {
"Bug Reports": "https://github.com/labanquepostale/aiobastion/issues",
"Homepage": "https://github.com/labanquepostale/aiobastion",
"Source": "https://github.com/labanquepostale/aiobastion/"
},
"split_keywords": [
"cyberark"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e7fd8ea24b7b1c3ff5fe77d585652ba019e888d2b39ce5df9771b71b208b0452",
"md5": "ca20413737b93a4e2f06b679c0f6d166",
"sha256": "a7769cfa978ff78508e8a555a35db339d4479dfdced5bc5e1637d7dd3a6a3787"
},
"downloads": -1,
"filename": "aiobastion-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca20413737b93a4e2f06b679c0f6d166",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 60963,
"upload_time": "2024-11-13T09:02:37",
"upload_time_iso_8601": "2024-11-13T09:02:37.226490Z",
"url": "https://files.pythonhosted.org/packages/e7/fd/8ea24b7b1c3ff5fe77d585652ba019e888d2b39ce5df9771b71b208b0452/aiobastion-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a3bef3bf964e0342d5a43354d487b8fa85c3f3e15661f4431d7df8a892c05f16",
"md5": "5bc701a040154a3fdaca6f823c02b432",
"sha256": "5506ac10dc50e7ff3c6c43c1071d95d22e4242916f21113bc729821d226b4ea0"
},
"downloads": -1,
"filename": "aiobastion-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "5bc701a040154a3fdaca6f823c02b432",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 76135,
"upload_time": "2024-11-13T09:02:39",
"upload_time_iso_8601": "2024-11-13T09:02:39.070974Z",
"url": "https://files.pythonhosted.org/packages/a3/be/f3bf964e0342d5a43354d487b8fa85c3f3e15661f4431d7df8a892c05f16/aiobastion-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 09:02:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "labanquepostale",
"github_project": "aiobastion",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "aiobastion"
}
