| Name | ipe-client JSON |
| Version |
1.2.0
JSON |
| download |
| home_page | None |
| Summary | A modern, asynchronous Python SDK for the IPE API. |
| upload_time | 2025-07-23 05:41:43 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License
Copyright (c) 2025 4Good.ai
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 |
ipe
api
sdk
async
client
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# IPE Python Client
A modern, asynchronous, and easy-to-use Python SDK for the IPE API.
## Installation
Install the package directly from PyPI:
```bash
pip install ipe-client
```
## Usage
Here is a basic example of how to instantiate the client and check a job status. The client should be used in an `async` context.
```python
import asyncio
import os
from ipe_client import IPEClient
async def main():
# Load configuration securely from environment variables
client = IIPSClient(
base_url=os.environ.get("IPE_BASE_URL"),
username=os.environ.get("IPE_USERNAME"),
password=os.environ.get("IPE_PASSWORD")
)
try:
job_ids = ["some-job-id-from-a-previous-submission"]
status = await client.check_iips_job_status(job_ids)
print(status)
except Exception as e:
print(f"An error occurred: {e}")
finally:
# It's important to close the client to release connections.
await client.close()
if __name__ == "__main__":
asyncio.run(main())
```
Raw data
{
"_id": null,
"home_page": null,
"name": "ipe-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "ipe, api, sdk, async, client",
"author": null,
"author_email": "Tejas Rajesh <tejasr@4gd.ai>",
"download_url": "https://files.pythonhosted.org/packages/74/02/fe9348bb3fe085238ab4b3d9f944d7a93e0d8f4f93c63f6bce6c5007c98c/ipe_client-1.2.0.tar.gz",
"platform": null,
"description": "# IPE Python Client\n\nA modern, asynchronous, and easy-to-use Python SDK for the IPE API.\n\n## Installation\n\nInstall the package directly from PyPI:\n\n```bash\npip install ipe-client\n```\n\n## Usage\n\nHere is a basic example of how to instantiate the client and check a job status. The client should be used in an `async` context.\n\n```python\nimport asyncio\nimport os\nfrom ipe_client import IPEClient\n\nasync def main():\n # Load configuration securely from environment variables\n client = IIPSClient(\n base_url=os.environ.get(\"IPE_BASE_URL\"),\n username=os.environ.get(\"IPE_USERNAME\"),\n password=os.environ.get(\"IPE_PASSWORD\")\n )\n\n try:\n job_ids = [\"some-job-id-from-a-previous-submission\"]\n status = await client.check_iips_job_status(job_ids)\n print(status)\n except Exception as e:\n print(f\"An error occurred: {e}\")\n finally:\n # It's important to close the client to release connections.\n await client.close()\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n```\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 4Good.ai\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "A modern, asynchronous Python SDK for the IPE API.",
"version": "1.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/your-username/ipe-python-sdk/issues",
"Homepage": "https://github.com/4gd-ai/4gd-image-processing-engine-SDK"
},
"split_keywords": [
"ipe",
" api",
" sdk",
" async",
" client"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5cfa89d8e23bf9eb265cd1bce0598d04aac22840379b19bb6cdcc39a41b0712f",
"md5": "bd54c0aff751c5db3890d2a5a637eef7",
"sha256": "896152252e7ef1bb9679c580d1265ffd6a0b08e795d07cb40f0ca2c0f5614d9b"
},
"downloads": -1,
"filename": "ipe_client-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bd54c0aff751c5db3890d2a5a637eef7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4798,
"upload_time": "2025-07-23T05:41:41",
"upload_time_iso_8601": "2025-07-23T05:41:41.987533Z",
"url": "https://files.pythonhosted.org/packages/5c/fa/89d8e23bf9eb265cd1bce0598d04aac22840379b19bb6cdcc39a41b0712f/ipe_client-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7402fe9348bb3fe085238ab4b3d9f944d7a93e0d8f4f93c63f6bce6c5007c98c",
"md5": "4d639c74dc55e6e5feb99db4664cf7cf",
"sha256": "0a9ba9e9151b88edd4e9aabd3263b072232201dabd357e105117a4d0735526fc"
},
"downloads": -1,
"filename": "ipe_client-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "4d639c74dc55e6e5feb99db4664cf7cf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 3901,
"upload_time": "2025-07-23T05:41:43",
"upload_time_iso_8601": "2025-07-23T05:41:43.464092Z",
"url": "https://files.pythonhosted.org/packages/74/02/fe9348bb3fe085238ab4b3d9f944d7a93e0d8f4f93c63f6bce6c5007c98c/ipe_client-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-23 05:41:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "your-username",
"github_project": "ipe-python-sdk",
"github_not_found": true,
"lcname": "ipe-client"
}
