Mantlebio SDK#
Overview#
Mantle SDK is a comprehensive SDK designed to help developers leverage data within Mantle’s platform.
For more information on the Mantle platform, visit Mantle’s website.
For more examples on Mantle SDK, visit Mantle’s documentation.
Getting Started#
Install via pip:
pip install mantlebio
For more information see the Installation page of our documentation.
- mantlebio
- mantlebio package
- Subpackages
- mantlebio.core package
- Subpackages
- mantlebio.core.analysis package
- Subpackages
- Submodules
- mantlebio.core.analysis.client module
- mantlebio.core.analysis.mantle_analysis module
MantleAnalysis
MantleAnalysis._wrap_method()
MantleAnalysis.add_file_input()
MantleAnalysis.add_file_output()
MantleAnalysis.add_input()
MantleAnalysis.add_output()
MantleAnalysis.get_input()
MantleAnalysis.get_output()
MantleAnalysis.pull_entity()
MantleAnalysis.push_input()
MantleAnalysis.push_output()
MantleAnalysis.set_inputs()
MantleAnalysis.set_name()
MantleAnalysis.set_outputs()
- Module contents
- Subpackages
- mantlebio.core.auth package
- mantlebio.core.dataset package
- Subpackages
- Submodules
- mantlebio.core.dataset.client module
DatasetClient
DatasetClient._create_cloud_dataset()
DatasetClient._create_local_dataset()
DatasetClient.build_query()
DatasetClient.create()
DatasetClient.create_cloud_entity()
DatasetClient.create_empty_entity()
DatasetClient.create_local_entity()
DatasetClient.get()
DatasetClient.get_datasets()
DatasetClient.get_entities()
DatasetClient.get_entity()
DatasetClient.list()
EntityClient
_IDatasetClient
- mantlebio.core.dataset.mantle_dataset module
MantleDataset
MantleDataset._wrap_method()
MantleDataset.add_s3_file_property()
MantleDataset.download_s3()
MantleDataset.entity
MantleDataset.entity_pb2
MantleDataset.get_id()
MantleDataset.get_property()
MantleDataset.push()
MantleDataset.set_data_type()
MantleDataset.set_name()
MantleDataset.set_property()
MantleDataset.to_dict()
MantleDataset.to_proto()
MantleDataset.to_series()
MantleDataset.upload_s3()
MantleEntity
_IDataset
_IEntity
- mantlebio.core.dataset.client module
- Module contents
- Subpackages
- mantlebio.core.pipeline package
- mantlebio.core.pipeline_run package
- Submodules
- mantlebio.core.pipeline_run.client module
- mantlebio.core.pipeline_run.mantle_pipeline_run module
MantlePipelineRun
MantlePipelineRun._build_pipeline_data()
MantlePipelineRun._build_pipeline_input()
MantlePipelineRun._build_pipeline_kickoff()
MantlePipelineRun._build_pipeline_output()
MantlePipelineRun._build_pipeline_run_value()
MantlePipelineRun._wrap_method()
MantlePipelineRun.add_entity_output()
MantlePipelineRun.add_file_output()
MantlePipelineRun.add_folder_output()
MantlePipelineRun.add_input()
MantlePipelineRun.add_output()
MantlePipelineRun.add_s3_output()
MantlePipelineRun.get_id()
MantlePipelineRun.get_input()
MantlePipelineRun.get_input_dataset()
MantlePipelineRun.get_input_dataset_list()
MantlePipelineRun.get_input_entities()
MantlePipelineRun.get_input_entity()
MantlePipelineRun.get_output()
MantlePipelineRun.get_output_dataset_list()
MantlePipelineRun.get_output_entities()
MantlePipelineRun.get_pipeline_id()
MantlePipelineRun.get_pipeline_version()
MantlePipelineRun.get_s3_input()
MantlePipelineRun.get_unique_id()
MantlePipelineRun.pipeline_run_pb2
MantlePipelineRun.post_input()
MantlePipelineRun.post_output()
MantlePipelineRun.pull_entities_input()
MantlePipelineRun.pull_entity_input()
MantlePipelineRun.pull_input()
MantlePipelineRun.pull_output()
MantlePipelineRun.pull_s3_input()
MantlePipelineRun.push_output()
MantlePipelineRun.update_status()
_IPipelineRun
_IPipelineRun._build_pipeline_data()
_IPipelineRun._build_pipeline_input()
_IPipelineRun._build_pipeline_kickoff()
_IPipelineRun._build_pipeline_output()
_IPipelineRun._build_pipeline_run_value()
_IPipelineRun.add_dataset_output()
_IPipelineRun.add_entity_output()
_IPipelineRun.add_file_output()
_IPipelineRun.add_folder_output()
_IPipelineRun.add_input()
_IPipelineRun.add_output()
_IPipelineRun.add_s3_output()
_IPipelineRun.get_id()
_IPipelineRun.get_input()
_IPipelineRun.get_input_dataset()
_IPipelineRun.get_input_dataset_list()
_IPipelineRun.get_input_entities()
_IPipelineRun.get_input_entity()
_IPipelineRun.get_output()
_IPipelineRun.get_output_dataset_list()
_IPipelineRun.get_output_entities()
_IPipelineRun.get_pipeline_id()
_IPipelineRun.get_pipeline_version()
_IPipelineRun.get_s3_input()
_IPipelineRun.get_unique_id()
_IPipelineRun.pipeline_run_pb2
_IPipelineRun.post_input()
_IPipelineRun.post_output()
_IPipelineRun.pull_entities_input()
_IPipelineRun.pull_entity_input()
_IPipelineRun.pull_input()
_IPipelineRun.pull_output()
_IPipelineRun.pull_s3_input()
_IPipelineRun.push_output()
_IPipelineRun.update_status()
- Module contents
- Submodules
- mantlebio.core.analysis package
- Submodules
- Module contents
- Subpackages
- mantlebio.types package
- mantlebio.core package
- Submodules
- mantlebio.client module
MantleClient
MantleClient.analysis
MantleClient.analysis_client
MantleClient.close()
MantleClient.create_empty_entity()
MantleClient.create_entity()
MantleClient.dataset
MantleClient.entity
MantleClient.entity_client
MantleClient.get_entities()
MantleClient.get_entity()
MantleClient.get_pipeline()
MantleClient.kick_off_pipeline_run()
MantleClient.load_analysis()
MantleClient.load_pipeline()
MantleClient.new_analysis()
MantleClient.pipeline
MantleClient.pipeline_client
MantleClient.pipeline_run
MantleClient.pipeline_run_client
MantleClient.storage
- mantlebio.exceptions module
MantleApiError
MantleAttributeError
MantleAuthenticationError
MantleClientError
MantleConfigurationError
MantleConfigurationWarning
MantleInvalidParameterError
MantleMissingParameterError
MantleProtoError
MantleQueryBuilderError
MantleResourceNotFoundError
MantleResponseError
MantleRetriesExceededError
MantleTypeError
MantlebioError
MantlebioWarning
PythonDeprecationWarning
StorageUploadError
- mantlebio.client module
- Module contents
MantleClient
MantleClient.analysis
MantleClient.analysis_client
MantleClient.close()
MantleClient.create_empty_entity()
MantleClient.create_entity()
MantleClient.dataset
MantleClient.entity
MantleClient.entity_client
MantleClient.get_entities()
MantleClient.get_entity()
MantleClient.get_pipeline()
MantleClient.kick_off_pipeline_run()
MantleClient.load_analysis()
MantleClient.load_pipeline()
MantleClient.new_analysis()
MantleClient.pipeline
MantleClient.pipeline_client
MantleClient.pipeline_run
MantleClient.pipeline_run_client
MantleClient.storage
- Subpackages
- mantlebio package