phc-sdk-py


Namephc-sdk-py JSON
Version 0.33.1 PyPI version JSON
download
home_pagehttps://github.com/lifeomic/phc-sdk-py
SummaryPython SDK for the LifeOmic platform
upload_time2023-08-03 14:51:42
maintainer
docs_urlNone
authorLifeOmic
requires_python>=3.8,<4.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # PHC SDK for Python

The phc-sdk-py is a developer kit for interfacing with the [PHC API](https://api.docs.lifeomic.com/) on Python 3.7 and above.

## Project Status

![GitHub](https://img.shields.io/github/license/lifeomic/phc-sdk-py.svg?style=for-the-badge)
![PyPI status](https://img.shields.io/pypi/status/phc.svg?style=for-the-badge)
![Downloads](https://img.shields.io/pypi/dw/phc?style=for-the-badge)
![GitHub release](https://img.shields.io/github/release/lifeomic/phc-sdk-py.svg?style=for-the-badge)
[![Docs](https://img.shields.io/badge/DOCS-PASSING-green?style=for-the-badge)](https://lifeomic.github.io/phc-sdk-py/)
[![User Guides](https://img.shields.io/badge/DOCS-PASSING-green?style=for-the-badge)](https://devcenter.docs.lifeomic.com/guides/python-sdk)

## Getting Started

### Dependencies

- [Python 3](https://www.python.org/download/releases/3.0/) version >= 3.8

### Getting the Source

This project is [hosted on GitHub](https://github.com/lifeomic/phc-sdk-py).

### Usage

A `Session` needs to be created first that stores the token and account information needed to access the PHC API. One can currently using API Key tokens generated from the PHC Account, or OAuth tokens generated using the [CLI](https://github.com/lifeomic/cli).

```python
from phc import Session

session = Session(token=<TOKEN VALUE>, account="myaccount")
```

Once a `Session` is created, you can then access the different parts of the platform.

```python
from phc.services import Accounts

accounts = Accounts(session)
myaccounts = accounts.get_list()
```

## Contributing

We encourage public contributions! Please review [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details on our code of conduct and development process.

## License

This project is licensed under the MIT License - see [LICENSE](LICENSE) file for details.

## Authors

See the list of [contributors](https://github.com/lifeomic/phc-sdk-py/contributors) who participate in this project.

## Acknowledgements

This project is built with the following:

- [aiohttp](https://aiohttp.readthedocs.io/en/stable/) - Asynchronous HTTP Client/Server for asyncio and Python.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/lifeomic/phc-sdk-py",
    "name": "phc-sdk-py",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "LifeOmic",
    "author_email": "development@lifeomic.com",
    "download_url": "https://files.pythonhosted.org/packages/af/df/67e5bf9b52044fd7fc6527d1933537c05cdcf77400e3ec5b35a33fe41c66/phc_sdk_py-0.33.1.tar.gz",
    "platform": null,
    "description": "# PHC SDK for Python\n\nThe phc-sdk-py is a developer kit for interfacing with the [PHC API](https://api.docs.lifeomic.com/) on Python 3.7 and above.\n\n## Project Status\n\n![GitHub](https://img.shields.io/github/license/lifeomic/phc-sdk-py.svg?style=for-the-badge)\n![PyPI status](https://img.shields.io/pypi/status/phc.svg?style=for-the-badge)\n![Downloads](https://img.shields.io/pypi/dw/phc?style=for-the-badge)\n![GitHub release](https://img.shields.io/github/release/lifeomic/phc-sdk-py.svg?style=for-the-badge)\n[![Docs](https://img.shields.io/badge/DOCS-PASSING-green?style=for-the-badge)](https://lifeomic.github.io/phc-sdk-py/)\n[![User Guides](https://img.shields.io/badge/DOCS-PASSING-green?style=for-the-badge)](https://devcenter.docs.lifeomic.com/guides/python-sdk)\n\n## Getting Started\n\n### Dependencies\n\n- [Python 3](https://www.python.org/download/releases/3.0/) version >= 3.8\n\n### Getting the Source\n\nThis project is [hosted on GitHub](https://github.com/lifeomic/phc-sdk-py).\n\n### Usage\n\nA `Session` needs to be created first that stores the token and account information needed to access the PHC API. One can currently using API Key tokens generated from the PHC Account, or OAuth tokens generated using the [CLI](https://github.com/lifeomic/cli).\n\n```python\nfrom phc import Session\n\nsession = Session(token=<TOKEN VALUE>, account=\"myaccount\")\n```\n\nOnce a `Session` is created, you can then access the different parts of the platform.\n\n```python\nfrom phc.services import Accounts\n\naccounts = Accounts(session)\nmyaccounts = accounts.get_list()\n```\n\n## Contributing\n\nWe encourage public contributions! Please review [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details on our code of conduct and development process.\n\n## License\n\nThis project is licensed under the MIT License - see [LICENSE](LICENSE) file for details.\n\n## Authors\n\nSee the list of [contributors](https://github.com/lifeomic/phc-sdk-py/contributors) who participate in this project.\n\n## Acknowledgements\n\nThis project is built with the following:\n\n- [aiohttp](https://aiohttp.readthedocs.io/en/stable/) - Asynchronous HTTP Client/Server for asyncio and Python.\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python SDK for the LifeOmic platform",
    "version": "0.33.1",
    "project_urls": {
        "Documentation": "https://lifeomic.github.io/phc-sdk-py/",
        "Homepage": "https://github.com/lifeomic/phc-sdk-py",
        "Repository": "https://github.com/lifeomic/phc-sdk-py"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dabf28d0b87236c8258704819d05195aaf1d73a905ca547f2c4d044841f874f3",
                "md5": "dfa36f48103cd8cc42e2098ae77d35ec",
                "sha256": "35832a3b407f2b7d84a832e69489148b784f54ab5c8cfff7e43688b3e1fa1800"
            },
            "downloads": -1,
            "filename": "phc_sdk_py-0.33.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "dfa36f48103cd8cc42e2098ae77d35ec",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 117907,
            "upload_time": "2023-08-03T14:51:40",
            "upload_time_iso_8601": "2023-08-03T14:51:40.800431Z",
            "url": "https://files.pythonhosted.org/packages/da/bf/28d0b87236c8258704819d05195aaf1d73a905ca547f2c4d044841f874f3/phc_sdk_py-0.33.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "afdf67e5bf9b52044fd7fc6527d1933537c05cdcf77400e3ec5b35a33fe41c66",
                "md5": "a2a4ca932faffbfb9a80394e09810dad",
                "sha256": "48c9a824c032f24a9466eeb66ff719eca72155918b0930defe57b45ae1c23af1"
            },
            "downloads": -1,
            "filename": "phc_sdk_py-0.33.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a2a4ca932faffbfb9a80394e09810dad",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 72535,
            "upload_time": "2023-08-03T14:51:42",
            "upload_time_iso_8601": "2023-08-03T14:51:42.530021Z",
            "url": "https://files.pythonhosted.org/packages/af/df/67e5bf9b52044fd7fc6527d1933537c05cdcf77400e3ec5b35a33fe41c66/phc_sdk_py-0.33.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-03 14:51:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "lifeomic",
    "github_project": "phc-sdk-py",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "phc-sdk-py"
}
        
Elapsed time: 0.20290s