[](https://travis-ci.com/IBM/code-engine-python-sdk)
<!--
[](https://github.com/semantic-release/semantic-release)
-->
# Python SDK for IBM Cloud Code Engine 3.1.0
Python client library to interact with the [IBM Cloud Code Engine API](https://cloud.ibm.com/apidocs/codeengine).
## 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 -->
- [Python SDK for IBM Cloud Code Engine 3.1.0](#python-sdk-for-ibm-cloud-code-engine-310)
- [Table of Contents](#table-of-contents)
- [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 Code Engine Python SDK allows developers to programmatically interact with the following
IBM Cloud services:
Service Name | Imported Class Name
--- | ---
[IBM Cloud Code Engine V2](https://cloud.ibm.com/apidocs/codeengine/codeengine-v3.1.0) | CodeEngineV2
[IBM Cloud Code Engine V1](https://cloud.ibm.com/apidocs/codeengine/codeengine-v3.1.0) | IbmCloudCodeEngineV1
## 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_code_engine_sdk>=3.1.0"
```
or
```bash
easy_install --upgrade "ibm_code_engine_sdk>=3.1.0"
```
## Using the SDK
Examples and a demo are available in the [example](/example) folder.
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/code-engine-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/code-engine-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/code-engine-python-sdk/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/IBM/code-engine-python-sdk",
"name": "ibm-code-engine-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ibm_code_engine_sdk",
"author": "IBM",
"author_email": "coligo@de.ibm.com",
"download_url": "https://files.pythonhosted.org/packages/53/b4/c1fd1cc2a9847c5860f3bd333dc68f9706714a5b869cb0186083d68bf8df/ibm-code-engine-sdk-3.1.0.tar.gz",
"platform": null,
"description": "[](https://travis-ci.com/IBM/code-engine-python-sdk)\n<!-- \n[](https://github.com/semantic-release/semantic-release)\n-->\n# Python SDK for IBM Cloud Code Engine 3.1.0\n\nPython client library to interact with the [IBM Cloud Code Engine API](https://cloud.ibm.com/apidocs/codeengine).\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- [Python SDK for IBM Cloud Code Engine 3.1.0](#python-sdk-for-ibm-cloud-code-engine-310)\n - [Table of Contents](#table-of-contents)\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 Code Engine Python SDK allows developers to programmatically interact with the following\nIBM Cloud services:\n\nService Name | Imported Class Name\n--- | ---\n[IBM Cloud Code Engine V2](https://cloud.ibm.com/apidocs/codeengine/codeengine-v3.1.0) | CodeEngineV2\n[IBM Cloud Code Engine V1](https://cloud.ibm.com/apidocs/codeengine/codeengine-v3.1.0) | IbmCloudCodeEngineV1\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_code_engine_sdk>=3.1.0\"\n```\n\nor\n\n```bash\neasy_install --upgrade \"ibm_code_engine_sdk>=3.1.0\"\n```\n\n## Using the SDK\nExamples and a demo are available in the [example](/example) folder.\n\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/code-engine-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/code-engine-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/code-engine-python-sdk/blob/main/LICENSE).\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Python SDK for IBM Cloud Code Engine",
"version": "3.1.0",
"split_keywords": [
"ibm_code_engine_sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "53b4c1fd1cc2a9847c5860f3bd333dc68f9706714a5b869cb0186083d68bf8df",
"md5": "4eee715579aeaa98a4724da57486b26b",
"sha256": "e2b65cf5347e6cc41ae71228646dc84d38f77ff50ce6894a2357b8e83eebeae2"
},
"downloads": -1,
"filename": "ibm-code-engine-sdk-3.1.0.tar.gz",
"has_sig": false,
"md5_digest": "4eee715579aeaa98a4724da57486b26b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 47628,
"upload_time": "2023-03-27T21:09:21",
"upload_time_iso_8601": "2023-03-27T21:09:21.517140Z",
"url": "https://files.pythonhosted.org/packages/53/b4/c1fd1cc2a9847c5860f3bd333dc68f9706714a5b869cb0186083d68bf8df/ibm-code-engine-sdk-3.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-27 21:09:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "IBM",
"github_project": "code-engine-python-sdk",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "ibm-code-engine-sdk"
}
JSON
