hubmap-sdk


Namehubmap-sdk JSON
Version 1.0.10 PyPI version JSON
download
home_pageNone
SummaryPython Client Libary to use HuBMAP web services
upload_time2024-10-04 18:28:22
maintainerNone
docs_urlNone
authorHubmap
requires_python>=3.9
licenseNone
keywords hubmap sdk python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # hubmap-sdk

---
A Python interface to the various HuBMAP web services

### Overview

The hubmap sdk is a client library that allows for easy integration of the API's associated with HuBMAP. 

### Using hubmap-sdk

The hubmap-sdk library is available through PyPi via the command:

```bash
pip3 install hubmap-sdk
```
hubmap-sdk requirements can be found [here](requirements.txt)

## Documentation
Documentation and examples can be found here

* [hubmapsdk](https://docs.hubmapconsortium.org/sdk/hubmapsdk.html)
* [entitysdk](https://docs.hubmapconsortium.org/sdk/entitysdk.html)
* [searchsdk](https://docs.hubmapconsortium.org/sdk/searchsdk.html)

### Building and Publishing hubmap-sdk

<a href="https://pypi.org/project/setuptools/">SetupTools</a> and <a href="https://pypi.org/project/wheel/">Wheel</a> is required to build the sdk distribution. <a href="https://pypi.org/project/twine/">Twine</a> is required to publish to Pypi

Build the distribution directory with: 

```bash
python3 setup.py sdist bdist_wheel
```

from within the python-sdk project directory

To publish, from inside the project directory, run:

```bash
twine upload dist/*
```

A prompt to enter login information to the hubmap Pypi account will appear


### Files 

This code contains:

**collection.py** Contains the Collection class. This is used for creation and modification of Collection objects.

**dataset.py** Contains the Dataset class. This is used for creation and modification of Dataset objects.

**donor.py** Contains the Donor class. This is used for creation and modification of Donor objects.

**entity.py** Contains the Entity class. This is the base class for the Donor, Dataset, Upload, Collection, and Sample classes

**entitysdk.py** This file contains the primary methods used to interface with the Entity Api. These methods are part of the EntitySdk class. An instance of this class is needed to use the various methods in this class. For a detailed breakdown of the various methods within entitysdk.py, visit <a href="https://api.docs.hubmapconsortium.org">api.docs.hubmapconsortium.org</a>  

**sample.py** Contains the Sample class. This is used for creation and modification of Sample objects.

**sdk_helper.py** This helper function contains various functions used frequently throughout the sdk. These include make_entity() and make_request()

**searchsdk.py** This file contains the primary methods used to interface with the Search Api. These methods are part of the EntitySdk class. An instance of this class is needed to use the various methods in this class. For a detailed breakdown of the various methods within searchsdk.py, visit <a href="https://api.docs.hubmapconsortium.org">api.docs.hubmapconsortium.org</a>  

**upload.py** Contains the Upload class. This is used for creation and modification of Upload objects.

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "hubmap-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "HuBMAP Sdk, python",
    "author": "Hubmap",
    "author_email": "api-developers@hubmapconsortium.org",
    "download_url": "https://files.pythonhosted.org/packages/6c/8d/b951352bbdcc967fbd9770a4b58e02cd05e9ac9758339333aa6fbf07f2fc/hubmap_sdk-1.0.10.tar.gz",
    "platform": null,
    "description": "# hubmap-sdk\n\n---\nA Python interface to the various HuBMAP web services\n\n### Overview\n\nThe hubmap sdk is a client library that allows for easy integration of the API's associated with HuBMAP. \n\n### Using hubmap-sdk\n\nThe hubmap-sdk library is available through PyPi via the command:\n\n```bash\npip3 install hubmap-sdk\n```\nhubmap-sdk requirements can be found [here](requirements.txt)\n\n## Documentation\nDocumentation and examples can be found here\n\n* [hubmapsdk](https://docs.hubmapconsortium.org/sdk/hubmapsdk.html)\n* [entitysdk](https://docs.hubmapconsortium.org/sdk/entitysdk.html)\n* [searchsdk](https://docs.hubmapconsortium.org/sdk/searchsdk.html)\n\n### Building and Publishing hubmap-sdk\n\n<a href=\"https://pypi.org/project/setuptools/\">SetupTools</a> and <a href=\"https://pypi.org/project/wheel/\">Wheel</a> is required to build the sdk distribution. <a href=\"https://pypi.org/project/twine/\">Twine</a> is required to publish to Pypi\n\nBuild the distribution directory with: \n\n```bash\npython3 setup.py sdist bdist_wheel\n```\n\nfrom within the python-sdk project directory\n\nTo publish, from inside the project directory, run:\n\n```bash\ntwine upload dist/*\n```\n\nA prompt to enter login information to the hubmap Pypi account will appear\n\n\n### Files \n\nThis code contains:\n\n**collection.py** Contains the Collection class. This is used for creation and modification of Collection objects.\n\n**dataset.py** Contains the Dataset class. This is used for creation and modification of Dataset objects.\n\n**donor.py** Contains the Donor class. This is used for creation and modification of Donor objects.\n\n**entity.py** Contains the Entity class. This is the base class for the Donor, Dataset, Upload, Collection, and Sample classes\n\n**entitysdk.py** This file contains the primary methods used to interface with the Entity Api. These methods are part of the EntitySdk class. An instance of this class is needed to use the various methods in this class. For a detailed breakdown of the various methods within entitysdk.py, visit <a href=\"https://api.docs.hubmapconsortium.org\">api.docs.hubmapconsortium.org</a>  \n\n**sample.py** Contains the Sample class. This is used for creation and modification of Sample objects.\n\n**sdk_helper.py** This helper function contains various functions used frequently throughout the sdk. These include make_entity() and make_request()\n\n**searchsdk.py** This file contains the primary methods used to interface with the Search Api. These methods are part of the EntitySdk class. An instance of this class is needed to use the various methods in this class. For a detailed breakdown of the various methods within searchsdk.py, visit <a href=\"https://api.docs.hubmapconsortium.org\">api.docs.hubmapconsortium.org</a>  \n\n**upload.py** Contains the Upload class. This is used for creation and modification of Upload objects.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Python Client Libary to use HuBMAP web services",
    "version": "1.0.10",
    "project_urls": null,
    "split_keywords": [
        "hubmap sdk",
        " python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "afbf4a346046ad88078eb5d1f741a3b0daf775ef404944a703fde644c61e892b",
                "md5": "135228e7b79bc19773cfd714137550fa",
                "sha256": "3b1786229c7e6496eae056bd86228efdffae53c1a1190b2362532fb81f2a200a"
            },
            "downloads": -1,
            "filename": "hubmap_sdk-1.0.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "135228e7b79bc19773cfd714137550fa",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 12128,
            "upload_time": "2024-10-04T18:28:20",
            "upload_time_iso_8601": "2024-10-04T18:28:20.419640Z",
            "url": "https://files.pythonhosted.org/packages/af/bf/4a346046ad88078eb5d1f741a3b0daf775ef404944a703fde644c61e892b/hubmap_sdk-1.0.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6c8db951352bbdcc967fbd9770a4b58e02cd05e9ac9758339333aa6fbf07f2fc",
                "md5": "09f9c10354ae4c3baea2f3966acaec2b",
                "sha256": "445789c847f0a6947b3ae1ebfeb945dc42296fb1005cf4b3731e60e930b8bafa"
            },
            "downloads": -1,
            "filename": "hubmap_sdk-1.0.10.tar.gz",
            "has_sig": false,
            "md5_digest": "09f9c10354ae4c3baea2f3966acaec2b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 10322,
            "upload_time": "2024-10-04T18:28:22",
            "upload_time_iso_8601": "2024-10-04T18:28:22.007445Z",
            "url": "https://files.pythonhosted.org/packages/6c/8d/b951352bbdcc967fbd9770a4b58e02cd05e9ac9758339333aa6fbf07f2fc/hubmap_sdk-1.0.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-04 18:28:22",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "hubmap-sdk"
}
Hubmap
Elapsed time: 0.86412s