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.

Contents:

• mantlebio
  • mantlebio package
    • Subpackages
      • mantlebio.core package
        • Subpackages
          • mantlebio.core.analysis package
            • Subpackages
            • Submodules
              • mantlebio.core.analysis.client module
                • AnalysisClient
                  • AnalysisClient.create()
                  • AnalysisClient.get()
                  • AnalysisClient.load()
                  • AnalysisClient.load_analysis()
              • 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
          • mantlebio.core.auth package
            • Subpackages
            • Submodules
              • mantlebio.core.auth.creds module
                • AuthMethod
                  • AuthMethod.authenticate()
                  • AuthMethod.get_token()
                • JwtCredentials
                  • JwtCredentials.authenticate()
                  • JwtCredentials.get_token()
                • PasswordCredentials
                  • PasswordCredentials.authenticate()
                  • PasswordCredentials.get_token()
              • mantlebio.core.auth.mantle_auth module
                • MantleAuth
                  • MantleAuth.access_token
                  • MantleAuth.authenticate()
                  • MantleAuth.get_token()
                  • MantleAuth.mantle_api
                  • MantleAuth.sign_out()
                • _IAuth
                  • _IAuth.authenticate()
                  • _IAuth.get_token()
                  • _IAuth.sign_out()
            • Module contents
          • 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
                  • _IDatasetClient.create()
                  • _IDatasetClient.get()
                  • _IDatasetClient.get_datasets()
                  • _IDatasetClient.get_entities()
                  • _IDatasetClient.list()
              • 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
                  • _IDataset.add_s3_file_property()
                  • _IDataset.download_s3()
                  • _IDataset.entity
                  • _IDataset.entity_pb2
                  • _IDataset.get_id()
                  • _IDataset.get_property()
                  • _IDataset.push()
                  • _IDataset.set_data_type()
                  • _IDataset.set_name()
                  • _IDataset.set_property()
                  • _IDataset.to_proto()
                  • _IDataset.upload_s3()
                • _IEntity
            • Module contents
          • mantlebio.core.pipeline package
            • Subpackages
            • Submodules
              • mantlebio.core.pipeline.client module
                • PipelineClient
                  • PipelineClient.get()
                  • PipelineClient.get_pipeline()
              • mantlebio.core.pipeline.mantle_pipeline module
                • MantlePipeline
                  • MantlePipeline._wrap_method()
                  • MantlePipeline.pipeline_pb2
                • _IPipeline
                  • _IPipeline.pipeline_pb2
            • Module contents
          • mantlebio.core.pipeline_run package
            • Submodules
              • mantlebio.core.pipeline_run.client module
                • PipelineRunClient
                  • PipelineRunClient.get()
                  • PipelineRunClient.kickoff()
                  • PipelineRunClient.kickoff_run()
                  • PipelineRunClient.load_run()
                  • PipelineRunClient.update_status()
              • 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.constants module
        • Module contents
      • mantlebio.types package
        • Subpackages
          • mantlebio.types.query package
            • Subpackages
            • Submodules
              • mantlebio.types.query.query_builder module
                • QueryBuilder
                  • QueryBuilder.client
                  • QueryBuilder.query_params
                  • QueryBuilder._add_query_condition()
                  • QueryBuilder._validate_condition()
                  • QueryBuilder._validate_field()
                  • QueryBuilder.and_()
                  • QueryBuilder.execute()
                  • QueryBuilder.or_()
                  • QueryBuilder.where()
              • mantlebio.types.query.queryable_client module
                • QueryableClient
                  • QueryableClient.build_query()
                  • QueryableClient.list()
            • Module contents
          • mantlebio.types.response package
            • Submodules
              • mantlebio.types.response.list_reponse module
                • ListResponse
                  • ListResponse._get_item_type()
                  • ListResponse.append()
                  • ListResponse.extend()
                  • ListResponse.to_dataframe()
              • mantlebio.types.response.response_item module
                • ResponseItem
                  • ResponseItem.to_proto()
                  • ResponseItem.to_series()
            • Module contents
        • Module contents
    • 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
    • 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