hra-api-client

This API provides programmatic access to data registered to the Human Reference Atlas (HRA). See the HuBMAP HRA Portal for details.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.20.0
• Package version: 0.20.0
• Generator version: 7.19.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/x-atlas-consortia/hra-api.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/x-atlas-consortia/hra-api.git)

Then import the package:

import hra_api_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import hra_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import hra_api_client
from hra_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://apps.humanatlas.io/api
# See configuration.py for a list of all supported configuration parameters.
configuration = hra_api_client.Configuration(
    host = "https://apps.humanatlas.io/api"
)



# Enter a context with an instance of the API client
with hra_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hra_api_client.DsGraphApi(api_client)
    token = 'token_example' # str | Authentication token to use for authenticated searches (optional)

    try:
        # Get Atlas D2K Dataset Graph
        api_response = api_instance.atlas_d2k(token=token)
        print("The response of DsGraphApi->atlas_d2k:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DsGraphApi->atlas_d2k: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://apps.humanatlas.io/api

Documentation For Models

• AggregateCount
• CellSummaryReport
• CellSummaryReportRequest
• CellSummaryRow
• DatabaseStatus
• ErrorMessage
• ErrorMessageObject
• FTUIllustrationsJSONLDResponse
• Filter
• FlatSpatialPlacement
• GetSpatialPlacementRequest
• IdLabelPair
• JsonLdObject
• Mesh3dCellPopulationRequest
• MinMax
• OntologyTree
• OntologyTreeNode
• RUIReferenceData
• SessionToken
• SessionTokenRequest
• SourceSimilarityRow
• SpacialPlacementSource
• SpacialPlacementTarget
• SparqlQueryRequest
• SpatialEntity
• SpatialEntityCommon
• SpatialEntityCreator
• SpatialEntityDimensions
• SpatialEntityPlacement
• SpatialObjectReference
• SpatialPlacement
• SpatialPlacementCommon
• SpatialPlacementRotation
• SpatialPlacementScaling
• SpatialPlacementTranslation
• SpatialSceneNode
• SpatialSearch
• TissueBlock
• TissueCommon
• TissueDataset
• TissueDonor
• TissueSampleCommon
• TissueSection

Documentation For Authorization

Endpoints do not require authorization.

Author

help@hubmapconsortium.org