[](https://travis-ci.com/IBM/vpc-python-sdk)
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/semantic-release/semantic-release)
# IBM Cloud Virtual Private Cloud (VPC) Python SDK Version 0.21.0
Python client library to interact with various [IBM Cloud Virtual Private Cloud (VPC) Service APIs](https://cloud.ibm.com/apidocs/vpc).
This SDK uses [Semantic Versioning](https://semver.org), and as such there may be backward-incompatible changes for any new `0.y.z` version.
## 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)
- [Setting up VPC service](#setting-up-vpc-service)
- [Questions](#questions)
- [Issues](#issues)
- [Open source @ IBM](#open-source--ibm)
- [Contributing](#contributing)
- [License](#license)
<!-- tocstop -->
## Overview
The IBM Cloud Virtual Private Cloud (VPC) Python SDK allows developers to programmatically interact with the following
IBM Cloud services:
Service Name | Imported Class Name
--- | ---
[VPC](https://cloud.ibm.com/apidocs/vpc) | VpcV1
## 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 an apikey [here](https://cloud.ibm.com/iam/apikeys).
* Python version 3.8 or above.
## Installation
To install, use `pip` or `easy_install`:
```bash
pip install --upgrade "ibm-vpc>=0.21.0"
```
or
```bash
easy_install --upgrade "ibm-vpc>=0.21.0"
```
## Using the SDK
For general SDK usage information, see the [IBM Cloud SDK Common README](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md).
## Setting up VPC service
```python
from ibm_vpc import VpcV1
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
from ibm_cloud_sdk_core import ApiException
authenticator = IAMAuthenticator('apikey')
service = VpcV1(authenticator=authenticator)
# Listing VPCs
print("List VPCs")
try:
vpcs = service.list_vpcs().get_result()['vpcs']
except ApiException as e:
print("List VPC failed with status code " + str(e.code) + ": " + e.message)
for vpc in vpcs:
print(vpc['id'], "\t", vpc['name'])
# Listing Subnets
print("List Subnets")
try:
subnets = service.list_subnets().get_result()['subnets']
except ApiException as e:
print("List subnets failed with status code " + str(e.code) + ": " + e.message)
for subnet in subnets:
print(subnet['id'], "\t", subnet['name'])
# Listing Instances
print("List Instances")
try:
instances = service.list_instances().get_result()['instances']
except ApiException as e:
print("List instances failed with status code " + str(e.code) + ": " + e.message)
for instance in instances:
print(instance['id'], "\t", instance['name'])
instanceId = instances[0]['id']
instanceName = instances[0]['name']
# Updating Instance
print("Updated Instance")
try:
newInstanceName = instanceName + "-1"
instance = service.update_instance(
id=instanceId,
name=newInstanceName,
).get_result()
except ApiException as e:
print("Update instance failed with status code " + str(e.code) + ": " + e.message)
print(instance['id'], "\t", instance['name'])
```
## Questions
If you have difficulties using this SDK or you have a question about the IBM Cloud services,
ask a question at [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/vpc-python-sdk/issues).
Before you create a new issue, 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](https://github.com/IBM/vpc-python-sdk/blob/master/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/vpc-python-sdk/blob/master/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/IBM/vpc-python-sdk",
"name": "ibm-vpc",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ibm_vpc",
"author": "IBM",
"author_email": "vpcui@us.ibm.com",
"download_url": "https://files.pythonhosted.org/packages/2b/53/d1c8d8f8074f05a25cde41f4e11adef49436cd4f6168c758588f283ef351/ibm-vpc-0.21.0.tar.gz",
"platform": null,
"description": "[](https://travis-ci.com/IBM/vpc-python-sdk)\n[](https://opensource.org/licenses/Apache-2.0)\n[](https://github.com/semantic-release/semantic-release)\n\n# IBM Cloud Virtual Private Cloud (VPC) Python SDK Version 0.21.0\n\nPython client library to interact with various [IBM Cloud Virtual Private Cloud (VPC) Service APIs](https://cloud.ibm.com/apidocs/vpc).\n\nThis SDK uses [Semantic Versioning](https://semver.org), and as such there may be backward-incompatible changes for any new `0.y.z` version.\n\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- [Setting up VPC service](#setting-up-vpc-service)\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 Virtual Private Cloud (VPC) Python SDK allows developers to programmatically interact with the following\nIBM Cloud services:\n\nService Name | Imported Class Name\n--- | ---\n[VPC](https://cloud.ibm.com/apidocs/vpc) | VpcV1\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 an apikey [here](https://cloud.ibm.com/iam/apikeys).\n* Python version 3.8 or above.\n\n## Installation\n\nTo install, use `pip` or `easy_install`:\n\n```bash\npip install --upgrade \"ibm-vpc>=0.21.0\"\n```\n\nor\n\n```bash\neasy_install --upgrade \"ibm-vpc>=0.21.0\"\n```\n\n## Using the SDK\nFor general SDK usage information, see the [IBM Cloud SDK Common README](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/README.md).\n\n## Setting up VPC service\n```python\nfrom ibm_vpc import VpcV1\nfrom ibm_cloud_sdk_core.authenticators import IAMAuthenticator\nfrom ibm_cloud_sdk_core import ApiException\n\nauthenticator = IAMAuthenticator('apikey')\nservice = VpcV1(authenticator=authenticator)\n\n# Listing VPCs\nprint(\"List VPCs\")\ntry:\n vpcs = service.list_vpcs().get_result()['vpcs']\nexcept ApiException as e:\n print(\"List VPC failed with status code \" + str(e.code) + \": \" + e.message)\nfor vpc in vpcs:\n print(vpc['id'], \"\\t\", vpc['name'])\n\n# Listing Subnets\nprint(\"List Subnets\")\ntry:\n subnets = service.list_subnets().get_result()['subnets']\nexcept ApiException as e:\n print(\"List subnets failed with status code \" + str(e.code) + \": \" + e.message)\nfor subnet in subnets:\n print(subnet['id'], \"\\t\", subnet['name'])\n\n# Listing Instances\nprint(\"List Instances\")\ntry:\n instances = service.list_instances().get_result()['instances']\nexcept ApiException as e:\n print(\"List instances failed with status code \" + str(e.code) + \": \" + e.message)\nfor instance in instances:\n print(instance['id'], \"\\t\", instance['name'])\n\ninstanceId = instances[0]['id']\ninstanceName = instances[0]['name']\n\n# Updating Instance\nprint(\"Updated Instance\")\ntry:\n newInstanceName = instanceName + \"-1\"\n instance = service.update_instance(\n id=instanceId,\n name=newInstanceName,\n ).get_result()\nexcept ApiException as e:\n print(\"Update instance failed with status code \" + str(e.code) + \": \" + e.message)\nprint(instance['id'], \"\\t\", instance['name'])\n\n```\n\n\n## Questions\nIf you have difficulties using this SDK or you have a question about the IBM Cloud services,\nask a question at [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/vpc-python-sdk/issues).\nBefore you create a new issue, 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](https://github.com/IBM/vpc-python-sdk/blob/master/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/vpc-python-sdk/blob/master/LICENSE).\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Python client library for IBM Cloud VPC Services",
"version": "0.21.0",
"project_urls": {
"Homepage": "https://github.com/IBM/vpc-python-sdk"
},
"split_keywords": [
"ibm_vpc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b53d1c8d8f8074f05a25cde41f4e11adef49436cd4f6168c758588f283ef351",
"md5": "7cc0a80a4e852920b169c9d53e61370c",
"sha256": "ae7c0fd65ca0c6cb0cf06f2b7c753d9c7dde68fa0ef7939cc1abc1ce3a5710d2"
},
"downloads": -1,
"filename": "ibm-vpc-0.21.0.tar.gz",
"has_sig": false,
"md5_digest": "7cc0a80a4e852920b169c9d53e61370c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 460499,
"upload_time": "2024-03-05T02:03:22",
"upload_time_iso_8601": "2024-03-05T02:03:22.956479Z",
"url": "https://files.pythonhosted.org/packages/2b/53/d1c8d8f8074f05a25cde41f4e11adef49436cd4f6168c758588f283ef351/ibm-vpc-0.21.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-05 02:03:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IBM",
"github_project": "vpc-python-sdk",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "ibm-vpc"
}
JSON
