ibm-dpx-services


Nameibm-dpx-services JSON
Version 0.0.5 PyPI version JSON
download
home_pagehttps://github.com/IBM/data-product-exchange-python-sdk
SummaryPython client library for DPH Services
upload_time2024-03-13 06:42:50
maintainer
docs_urlNone
authorIBM
requires_python
licenseApache 2.0
keywords ibm_dpx_services
VCS
bugtrack_url
requirements requests urllib3 python_dateutil ibm_cloud_sdk_core
Travis-CI
coveralls test coverage No coveralls.
            # Data Product Exchange Python SDK Version 0.0.5

Python client library to interact with various Data Product Exchange Service APIs.

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 ibm_dpx_services Python SDK allows developers to programmatically interact with the following service:

Service Name | Module Name | Imported Class Name
--- | --- | ---
[Data Product Exchange](https://cloud.ibm.com/apidocs/dataproducts) | dpx_v1 | DpxV1

## 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.8 or above.

## Installation

To install, use `pip`:

```bash
pip install --upgrade ibm-dpx-services
```

Then in your code, you can import the appropriate service like this:
```
from ibm_dpx_services.<service-module-name> import *
```
where `<service-module-name>` is the service's module name from the table above

## 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 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](<github-repo-url>/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.ibm.com/CloudEngineering/python-sdk-template/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.ibm.com/CloudEngineering/python-sdk-template/blob/main/LICENSE).

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/IBM/data-product-exchange-python-sdk",
    "name": "ibm-dpx-services",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "ibm_dpx_services",
    "author": "IBM",
    "author_email": "greeshma.rajendran@ibm.com",
    "download_url": "https://files.pythonhosted.org/packages/76/2f/d46c162c326afaaa63670de0466416284b02db12ae72781df14333d4f271/ibm-dpx-services-0.0.5.tar.gz",
    "platform": null,
    "description": "# Data Product Exchange Python SDK Version 0.0.5\n\nPython client library to interact with various Data Product Exchange Service APIs.\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 ibm_dpx_services Python SDK allows developers to programmatically interact with the following service:\n\nService Name | Module Name | Imported Class Name\n--- | --- | ---\n[Data Product Exchange](https://cloud.ibm.com/apidocs/dataproducts) | dpx_v1 | DpxV1\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.8 or above.\n\n## Installation\n\nTo install, use `pip`:\n\n```bash\npip install --upgrade ibm-dpx-services\n```\n\nThen in your code, you can import the appropriate service like this:\n```\nfrom ibm_dpx_services.<service-module-name> import *\n```\nwhere `<service-module-name>` is the service's module name from the table above\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 at\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](<github-repo-url>/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.ibm.com/CloudEngineering/python-sdk-template/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.ibm.com/CloudEngineering/python-sdk-template/blob/main/LICENSE).\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "Python client library for DPH Services",
    "version": "0.0.5",
    "project_urls": {
        "Homepage": "https://github.com/IBM/data-product-exchange-python-sdk"
    },
    "split_keywords": [
        "ibm_dpx_services"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "762fd46c162c326afaaa63670de0466416284b02db12ae72781df14333d4f271",
                "md5": "0dd84b05315e6109f8c127c25bc27c9b",
                "sha256": "a8bb6b30207fa0035e264470b8f503941e1feaaac0d4b41589fe1d36e02e832f"
            },
            "downloads": -1,
            "filename": "ibm-dpx-services-0.0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "0dd84b05315e6109f8c127c25bc27c9b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 27084,
            "upload_time": "2024-03-13T06:42:50",
            "upload_time_iso_8601": "2024-03-13T06:42:50.859882Z",
            "url": "https://files.pythonhosted.org/packages/76/2f/d46c162c326afaaa63670de0466416284b02db12ae72781df14333d4f271/ibm-dpx-services-0.0.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-13 06:42:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "IBM",
    "github_project": "data-product-exchange-python-sdk",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "requests",
            "specs": [
                [
                    ">=",
                    "2.31.0"
                ],
                [
                    "<",
                    "3.0.0"
                ]
            ]
        },
        {
            "name": "urllib3",
            "specs": [
                [
                    ">=",
                    "1.26.18"
                ],
                [
                    "<",
                    "2.0.0"
                ]
            ]
        },
        {
            "name": "python_dateutil",
            "specs": [
                [
                    ">=",
                    "2.5.3"
                ],
                [
                    "<",
                    "3.0.0"
                ]
            ]
        },
        {
            "name": "ibm_cloud_sdk_core",
            "specs": [
                [
                    "<",
                    "4.0.0"
                ],
                [
                    ">=",
                    "3.16.7"
                ]
            ]
        }
    ],
    "lcname": "ibm-dpx-services"
}
        
IBM
Elapsed time: 0.25648s