[![Build Status](https://travis-ci.com/IBM/container-registry-python-sdk.svg?branch=main)](https://travis-ci.com/IBM/container-registry-python-sdk)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
# IBM Cloud Container Registry Python SDK
Python client library to interact with the [IBM Cloud Container Registry API](https://cloud.ibm.com/apidocs/container-registry), and [IBM Cloud Container Registry Vulnerability Advisor API](https://cloud.ibm.com/apidocs/container-registry/va)
Disclaimer: this SDK is being released initially as a **pre-release** version.
Changes might occur which impact applications that use this SDK.
## Table of Contents
<!--
The TOC below is generated using the `markdown-toc` node package.
https://github.com/jonschlinkert/markdown-toc
You should regenerate the TOC after making changes to this file.
npx markdown-toc -i README.md
-->
<!-- toc -->
- [Overview](#overview)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Using the SDK](#using-the-sdk)
- [Questions](#questions)
- [Issues](#issues)
- [Open source @ IBM](#open-source--ibm)
- [Contributing](#contributing)
- [License](#license)
<!-- tocstop -->
## Overview
The IBM Cloud Container Registry Python SDK allows developers to programmatically interact with the following
IBM Cloud services:
Service Name | Imported Class Name
--- | ---
[Container Registry image management API](https://cloud.ibm.com/apidocs/container-registry) | ibm_container_registry.container_registry_v1
[Container Registry Vulnerability Advisor API](https://cloud.ibm.com/apidocs/container-registry/va) | ibm_container_registry.vulnerability_advisor_v3
## Prerequisites
[ibm-cloud-onboarding]: https://cloud.ibm.com/registration
* An [IBM Cloud][ibm-cloud-onboarding] account.
* An IAM API key to allow the SDK to access your account. Create one [here](https://cloud.ibm.com/iam/apikeys).
* Python 3.7 or above.
## Installation
To install, use `pip` or `easy_install`:
```bash
pip install --upgrade "ibm-container-registry>=1.1.0"
```
or
```bash
easy_install --upgrade "ibm-container-registry>=1.1.0"
```
## Using the SDK
For general SDK usage information, please see [this link](https://github.com/IBM/ibm-cloud-sdk-common/blob/main/README.md)
## Questions
If you are having difficulties using this SDK or have a question about the IBM Cloud services,
please ask a question
[Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-cloud).
## Issues
If you encounter an issue with the project, you are welcome to submit a
[bug report](https://github.com/IBM/container-registry-python-sdk/issues).
Before that, please search for similar issues. It's possible that someone has already reported the problem.
## Open source @ IBM
Find more open source projects on the [IBM Github Page](http://ibm.github.io/)
## Contributing
See [CONTRIBUTING.md](https://github.com/IBM/container-registry-python-sdk/blob/main/CONTRIBUTING.md).
## License
This SDK is released under the Apache 2.0 license.
The license's full text can be found in [LICENSE](https://github.com/IBM/container-registry-python-sdk/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/IBM/container-registry-python-sdk",
"name": "ibm-container-registry",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ibm_container_registry",
"author": "IBM",
"author_email": "alchemy.registry.squad@uk.ibm.com",
"download_url": "https://files.pythonhosted.org/packages/70/85/c3101d7f4e08f5e2dcf74a54cc2e9e61c70e1fce9fa92145d2322e43d63a/ibm-container-registry-1.1.0.tar.gz",
"platform": null,
"description": "[![Build Status](https://travis-ci.com/IBM/container-registry-python-sdk.svg?branch=main)](https://travis-ci.com/IBM/container-registry-python-sdk)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n# IBM Cloud Container Registry Python SDK\n\nPython client library to interact with the [IBM Cloud Container Registry API](https://cloud.ibm.com/apidocs/container-registry), and [IBM Cloud Container Registry Vulnerability Advisor API](https://cloud.ibm.com/apidocs/container-registry/va)\n\nDisclaimer: this SDK is being released initially as a **pre-release** version.\nChanges might occur which impact applications that use this SDK.\n\n## Table of Contents\n\n<!--\n The TOC below is generated using the `markdown-toc` node package.\n\n https://github.com/jonschlinkert/markdown-toc\n\n You should regenerate the TOC after making changes to this file.\n\n npx markdown-toc -i README.md\n -->\n\n<!-- toc -->\n\n- [Overview](#overview)\n- [Prerequisites](#prerequisites)\n- [Installation](#installation)\n- [Using the SDK](#using-the-sdk)\n- [Questions](#questions)\n- [Issues](#issues)\n- [Open source @ IBM](#open-source--ibm)\n- [Contributing](#contributing)\n- [License](#license)\n\n<!-- tocstop -->\n\n## Overview\n\nThe IBM Cloud Container Registry Python SDK allows developers to programmatically interact with the following\nIBM Cloud services:\n\nService Name | Imported Class Name\n--- | ---\n[Container Registry image management API](https://cloud.ibm.com/apidocs/container-registry) | ibm_container_registry.container_registry_v1\n[Container Registry Vulnerability Advisor API](https://cloud.ibm.com/apidocs/container-registry/va) | ibm_container_registry.vulnerability_advisor_v3\n\n## Prerequisites\n\n[ibm-cloud-onboarding]: https://cloud.ibm.com/registration\n\n* An [IBM Cloud][ibm-cloud-onboarding] account.\n* An IAM API key to allow the SDK to access your account. Create one [here](https://cloud.ibm.com/iam/apikeys).\n* Python 3.7 or above.\n\n## Installation\n\nTo install, use `pip` or `easy_install`:\n\n```bash\npip install --upgrade \"ibm-container-registry>=1.1.0\"\n```\n\nor\n\n```bash\neasy_install --upgrade \"ibm-container-registry>=1.1.0\"\n```\n\n## Using the SDK\nFor general SDK usage information, please see [this link](https://github.com/IBM/ibm-cloud-sdk-common/blob/main/README.md)\n\n## Questions\n\nIf you are having difficulties using this SDK or have a question about the IBM Cloud services,\nplease ask a question\n[Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-cloud).\n\n## Issues\nIf you encounter an issue with the project, you are welcome to submit a\n[bug report](https://github.com/IBM/container-registry-python-sdk/issues).\nBefore that, please search for similar issues. It's possible that someone has already reported the problem.\n\n## Open source @ IBM\nFind more open source projects on the [IBM Github Page](http://ibm.github.io/)\n\n## Contributing\nSee [CONTRIBUTING.md](https://github.com/IBM/container-registry-python-sdk/blob/main/CONTRIBUTING.md).\n\n## License\n\nThis SDK is released under the Apache 2.0 license.\nThe license's full text can be found in [LICENSE](https://github.com/IBM/container-registry-python-sdk/blob/main/LICENSE).\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "IBM Cloud Container Registry Python SDK",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/IBM/container-registry-python-sdk"
},
"split_keywords": [
"ibm_container_registry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7085c3101d7f4e08f5e2dcf74a54cc2e9e61c70e1fce9fa92145d2322e43d63a",
"md5": "0d0755931f83a99a7b351c6baf84386d",
"sha256": "d85392c549d994296d38c12d35e76d9e4d19ce4fa14323f59f3a278e952a5522"
},
"downloads": -1,
"filename": "ibm-container-registry-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "0d0755931f83a99a7b351c6baf84386d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 33404,
"upload_time": "2023-07-21T14:16:58",
"upload_time_iso_8601": "2023-07-21T14:16:58.200520Z",
"url": "https://files.pythonhosted.org/packages/70/85/c3101d7f4e08f5e2dcf74a54cc2e9e61c70e1fce9fa92145d2322e43d63a/ibm-container-registry-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-21 14:16:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IBM",
"github_project": "container-registry-python-sdk",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "ibm-container-registry"
}