Package: deep-lynx
Deep Lynx Python SDKThis is an SDK for theDeep Lynxdata warehouse that supports Python projects. It is used for creating API requests and sending and receiving data from Deep Lynx.This is an autogenerated filePlease seethe official READMEfor information on contributing, testing, installing, uploading to PyPi, as well as correctly formatted examples.This Python package is automatically generated by theSwagger Codegenproject:API version: 1.0Package version: 0.1.6Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegenContributingWhen running the swagger-codgen command to generate this code base, please supply the following language-specific options:--additional-properties packageName=deep_lynx projectName=deep_lynxTestingPlease provide the Deep Lynx API key and secret when performing testing. To do so, copy the.env-samplefile and rename to.envand supply the needed values. Basic testing is currently performed withintest/test_create_manual_import.py.Requirements.Python 2.7 or 3.4+Installation & Usagepip/poetry installpip:pip install deep_lynxpoetry:poetry add deep_lynxGitHubIf the python package is hosted on Github, you can install directly from Githubpipinstallgit+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to runpipwith root permission:sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)Then import the package:importdeep_lynxSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importdeep_lynxUploading this Distribution to PyPiFollow these steps for uploading the latest distribution to PyPI (requires maintainer access to thedeep_lynxpackage). See theofficial docsfor more information.Ensure both thebuildandtwinepackages have been installedUpdatesetup.pyand this README as necessary to update theVERSIONand whatever other metadata adjustments are necessaryRunpython -m buildto generate thedist/directory with the source archive and built distribution filesUpload the archives to PyPI by runningpython -m twine upload dist/*and providing your PyPI user credentialsGetting StartedPlease follow theinstallation procedureand then run something like the following example (Python 3):importdeep_lynxfromdeep_lynx.restimportApiExceptionfrompprintimportpprint# initialize an ApiClient for use with deep_lynx APIsconfiguration=deep_lynx.configuration.Configuration()configuration.host='http://localhost:8090'apiClient=deep_lynx.ApiClient(configuration)# authenticate via an API key and secretauthApi=deep_lynx.AuthenticationApi(apiClient)apiKey='myKey'apiSecret='mySecret'token=authApi.retrieve_o_auth_token(x_api_key=apiKey,x_api_secret=apiSecret,x_api_expiry='1h')# create a containercontainerApi=deep_lynx.ContainersApi(apiClient)container=containerApi.create_container(CreateContainerRequest('myContainer','Container description',False))containerId=container.value[0].id# create a data sourcedatasourcesApi=deep_lynx.DataSourcesApi(apiClient)datasource=datasourcesApi.create_data_source(CreateDataSourceRequest('sdk_test_source','standard',True),containerId)datasourceId=datasource.value.id# create manual importimportResult=datasourcesApi.create_manual_import({'test':'test import'},containerId,datasourceId)Documentation for API EndpointsAll URIs are relative tohttp://localhost:8090(or whatever your host and port is)ClassMethodHTTP requestDescriptionAuthenticationApiexchange_o_auth_tokenPOST/oauth/exchangeExchange OAuth TokenAuthenticationApiretrieve_o_auth_tokenGET/oauth/tokenRetrieve OAuth TokenAuthenticationApirsa_cancelPOST/rsa/cancelRSA CancelAuthenticationApirsa_initializePOST/rsa/initializeRSA InitializeAuthenticationApirsa_statusPOST/rsa/statusRSA StatusAuthenticationApirsa_verifyPOST/rsa/verifyRSA VerifyContainersApiacknowledge_container_alertPOST/containers/{container_id}/alerts/{alert_id}Acknowledge Container AlertContainersApiapprove_ontology_versionPUT/containers/{container_id}/ontology/versions/{ontology_version_id}/approveApprove Ontology VersionContainersApiarchive_containerDELETE/containers/{container_id}Archive ContainerContainersApicontainer_batch_updatePUT/containersContainer Batch UpdateContainersApicreate_containerPOST/containersCreate ContainerContainersApiimport_containerPOST/containers/importImport ContainerContainersApilist_container_alertsGET/containers/{container_id}/alertsList Container AlertsContainersApilist_containersGET/containersList ContainersContainersApilist_ontology_versionsGET/containers/{container_id}/ontology/versionsList Ontology VersionsContainersApipublish_ontology_versionPOST/containers/{container_id}/ontology/versions/{ontology_version_id}/publishPublish Ontology VersionContainersApireject_ontology_version_approvalDELETE/containers/{container_id}/ontology/versions/{ontology_version_id}/approveReject Ontology Version ApprovalContainersApirepair_container_permissionsPOST/containers/{container_id}/permissionsRepair Container PermissionsContainersApiretrieve_containerGET/containers/{container_id}Retrieve ContainerContainersApiretrieve_ontology_versionGET/containers/{container_id}/ontology/versions/{version_id}Retrieve Ontology VersionContainersApirollback_ontology_versionPOST/containers/{container_id}/ontology/versions/{version_id}/rollbackRollback Ontology VersionContainersApisend_ontology_version_for_approvalPOST/containers/{container_id}/ontology/versions/{ontology_version_id}/approveSend Ontology Version for ApprovalContainersApiset_container_activePOST/containers/{container_id}/activeSet Container ActiveContainersApiupdate_containerPUT/containers/{container_id}Update ContainerContainersApiupdate_container_importPUT/containers/import/{container_id}Update Container ImportDataExportApicreate_data_exportPOST/containers/{container_id}/data/exportCreate Data ExportDataExportApidelete_data_exportDELETE/containers/{container_id}/data/export/{export_id}Delete Data ExportDataExportApilist_data_exportsGET/containers/{container_id}/data/exportList Data ExportsDataExportApiretrieve_data_exportGET/containers/{container_id}/data/export/{export_id}Retrieve Data ExportDataExportApistart_data_exportPOST/containers/{container_id}/data/export/{export_id}Start Data ExportDataExportApistop_data_exportPUT/containers/{container_id}/data/export/{export_id}Stop Data ExportDataQueryApiquery_graphPOST/containers/{container_id}/queryQuery GraphDataSourcesApiarchive_data_sourceDELETE/containers/{container_id}/import/datasources/{data_source_id}Archive Data SourceDataSourcesApicreate_data_sourcePOST/containers/{container_id}/import/datasourcesCreate Data SourceDataSourcesApicreate_manual_importPOST/containers/{container_id}/import/datasources/{data_source_id}/importsCreate Manual ImportDataSourcesApidownload_fileGET/containers/{container_id}/files/{file_id}/downloadDownload FileDataSourcesApilist_data_sourcesGET/containers/{container_id}/import/datasourcesList Data SourcesDataSourcesApilist_imports_for_data_sourceGET/containers/{container_id}/import/datasources/{data_source_id}/importsList Imports for Data SourceDataSourcesApiretrieve_data_sourceGET/containers/{container_id}/import/datasources/{data_source_id}Retrieve Data SourceDataSourcesApiretrieve_fileGET/containers/{container_id}/files/{file_id}Retrieve FileDataSourcesApiset_data_source_activePOST/containers/{container_id}/import/datasources/{data_source_id}/activeSet Data Source ActiveDataSourcesApiset_data_source_configurationPUT/containers/{container_id}/import/datasources/{data_source_id}Set Data Source ConfigurationDataSourcesApiset_data_source_inactiveDELETE/containers/{container_id}/import/datasources/{data_source_id}/activeSet Data Source InactiveDataSourcesApiupload_filePOST/containers/{container_id}/import/datasources/{data_source_id}/filesUpload FileDataTypeMappingsApicreate_transformationPOST/containers/{container_id}/import/datasources/{data_source_id}/mappings/{mapping_id}/transformationsCreate Data Type Mapping's TransformationsDataTypeMappingsApidelete_data_type_mappingDELETE/containers/{container_id}/import/datasources/{data_source_id}/mappings/{mapping_id}Delete Data Type MappingDataTypeMappingsApidelete_transformationDELETE/containers/{container_id}/import/datasources/{data_source_id}/mappings/{mapping_id}/transformations/{transformation_id}Delete Data Type Mapping's TransformationsDataTypeMappingsApiexport_type_mappingsPOST/containers/{container_id}/import/datasources/{data_source_id}/mappings/exportExport Type MappingsDataTypeMappingsApiimport_data_type_mappingsPOST/containers/{container_id}/import/datasources/{data_source_id}/mappings/importImport Data Type MappingsDataTypeMappingsApilist_data_type_mappingsGET/containers/{container_id}/import/datasources/{data_source_id}/mappingsList Data Type MappingsDataTypeMappingsApilist_transformationsGET/containers/{container_id}/import/datasources/{data_source_id}/mappings/{mapping_id}/transformationsList Data Type Mapping's TransformationsDataTypeMappingsApiretrieve_data_type_mappingGET/containers/{container_id}/import/datasources/{data_source_id}/mappings/{mapping_id}Retrieve Data Type MappingDataTypeMappingsApiupdate_data_type_mappingPUT/containers/{container_id}/import/datasources/{data_source_id}/mappings/{mapping_id}Update Data Type MappingDataTypeMappingsApiupdate_transformationPUT/containers/{container_id}/import/datasources/{data_source_id}/mappings/{mapping_id}/transformations/{transformation_id}Update Data Type Mapping's TransformationsEventsApicreate_eventPOST/eventsCreate EventEventsApicreate_event_actionPOST/event_actionsCreate Event ActionEventsApidelete_event_actionDELETE/event_actions/{action_id}Delete Event ActionEventsApilist_event_action_statusesGET/event_action_statusList Event Action StatusesEventsApilist_event_actionsGET/event_actionsList Event ActionsEventsApiretrieve_event_actionGET/event_actions/{action_id}Retrieve Event ActionEventsApiretrieve_event_action_statusGET/event_action_status/{status_id}Retrieve Event Action StatusEventsApiupdate_event_actionPUT/event_actions/{action_id}Update Event ActionEventsApiupdate_event_action_statusPUT/event_action_status/{status_id}Update Event Action StatusGraphApiarchive_edgeDELETE/containers/{container_id}/graphs/edges/{edge_id}Archive EdgeGraphApiarchive_nodeDELETE/containers/{container_id}/graphs/nodes/{node_id}Archive NodeGraphApiattach_edge_filePUT/containers/{container_id}/graphs/edges/{edge_id}/files/{file_id}Attach Edge FileGraphApiattach_node_filePUT/containers/{container_id}/graphs/nodes/{node_id}/files/{file_id}Attach Node FileGraphApicreate_or_update_edgesPOST/containers/{container_id}/graphs/edgesCreate or Update EdgesGraphApicreate_or_update_nodesPOST/containers/{container_id}/graphs/nodesCreate Or Update NodesGraphApidelete_node_fileDELETE/containers/{container_id}/graphs/nodes/{node_id}/files/{file_id}Detach Node FileGraphApidetach_node_fileDELETE/containers/{container_id}/graphs/edges/{edge_id}/files/{file_id}Detach Node FileGraphApilist_edge_filesGET/containers/{container_id}/graphs/edges/{edge_id}/filesList Edge FilesGraphApilist_edgesGET/containers/{container_id}/graphs/edgesList EdgesGraphApilist_node_filesGET/containers/{container_id}/graphs/nodes/{node_id}/filesList Node FilesGraphApilist_nodesGET/containers/{container_id}/graphs/nodesList NodesGraphApilist_nodes_by_metatype_idGET/containers/{container_id}/graphs/nodes/metatype/{metatype_id}List Nodes By Metatype IDGraphApiretrieve_edgeGET/containers/{container_id}/graphs/edges/{edge_id}Retrieve EdgeGraphApiretrieve_nodeGET/containers/{container_id}/graphs/nodes/{node_id}Retrieve NodeImportsApiadd_data_to_importPOST/containers/{container_id}/datasources/{data_source_id}/imports/{import_id}/dataAdd Data to ImportImportsApicreate_importPOST/containers/{container_id}/datasources/{data_source_id}/importsCreate ImportImportsApidelete_importDELETE/containers/{container_id}/import/imports/{import_id}Delete ImportImportsApidelete_import_dataDELETE/containers/{container_id}/import/imports/{import_id}/data/{data_id}Delete Import DataImportsApilist_imports_dataGET/containers/{container_id}/import/imports/{import_id}/dataList Import's DataImportsApiretrieve_import_dataGET/containers/{container_id}/import/imports/{import_id}/data/{data_id}Retrieve Import DataImportsApiupdate_import_dataPUT/containers/{container_id}/import/imports/{import_id}/data/{data_id}Update Import DataMetatypeKeysApiarchive_metatype_keyDELETE/containers/{container_id}/metatypes/{metatype_id}/keys/{key_id}Archive Metatype KeyMetatypeKeysApicreate_metatype_keyPOST/containers/{container_id}/metatypes/{metatype_id}/keysCreate Metatype KeyMetatypeKeysApilist_metatypes_keysGET/containers/{container_id}/metatypes/{metatype_id}/keysList Metatype's KeysMetatypeKeysApiretrieve_metatype_keyGET/containers/{container_id}/metatypes/{metatype_id}/keys/{key_id}Retrieve Metatype KeyMetatypeKeysApiupdate_metatype_keyPUT/containers/{container_id}/metatypes/{metatype_id}/keys/{key_id}Update Metatype KeyMetatypeRelationshipKeysApiarchive_metatype_relationship_keyDELETE/containers/{container_id}/metatype_relationships/{relationship_id}/keys/{key_id}Archive Metatype Relationship KeyMetatypeRelationshipKeysApicreate_metatype_relationship_keyPOST/containers/{container_id}/metatype_relationships/{relationship_id}/keysCreate Metatype Relationship KeyMetatypeRelationshipKeysApilist_metatype_relationship_keysGET/containers/{container_id}/metatype_relationships/{relationship_id}/keysList Metatype Relationship KeysMetatypeRelationshipKeysApiretrieve_metatype_relationship_keyGET/containers/{container_id}/metatype_relationships/{relationship_id}/keys/{key_id}Retrieve Metatype Relationship KeyMetatypeRelationshipKeysApiupdate_metatype_relationship_keyPUT/containers/{container_id}/metatype_relationships/{relationship_id}/keys/{key_id}Update Metaype Relationship KeyMetatypeRelationshipPairsApiarchive_metatype_relationship_pairDELETE/containers/{container_id}/metatype_relationship_pairs/{pair_id}Archive Metatype Relationship PairMetatypeRelationshipPairsApicreate_metatype_relationship_pairPOST/containers/{container_id}/metatype_relationship_pairsCreate Metatype Relationship PairMetatypeRelationshipPairsApilist_metatype_relationship_pairsGET/containers/{container_id}/metatype_relationship_pairsList Metatype Relationship PairsMetatypeRelationshipPairsApiretrieve_metatype_relationship_pairGET/containers/{container_id}/metatype_relationship_pairs/{pair_id}Retrieve Metatype Relationship PairMetatypeRelationshipPairsApiupdate_metatype_relationship_pairPUT/containers/{container_id}/metatype_relationship_pairs/{pair_id}Update Metaype Relationship PairMetatypeRelationshipsApiarchive_metatype_relationshipDELETE/containers/{container_id}/metatype_relationships/{relationship_id}Archive Metatype RelationshipMetatypeRelationshipsApicreate_metatype_relationshipPOST/containers/{container_id}/metatype_relationshipsCreate Metatype RelationshipMetatypeRelationshipsApilist_metatype_relationshipsGET/containers/{container_id}/metatype_relationshipsList Metatype RelationshipsMetatypeRelationshipsApiretrieve_metatype_relationshipGET/containers/{container_id}/metatype_relationships/{relationship_id}Retrieve Metatype RelationshipMetatypeRelationshipsApiupdate_metatype_relationshipPUT/containers/{container_id}/metatype_relationships/{relationship_id}Update Metatype RelationshipMetatypesApiarchive_metatypeDELETE/containers/{container_id}/metatypes/{metatype_id}Archive MetatypeMetatypesApicreate_metatypePOST/containers/{container_id}/metatypesCreate MetatypeMetatypesApilist_metatypesGET/containers/{container_id}/metatypesList MetatypesMetatypesApiretrieve_metaypeGET/containers/{container_id}/metatypes/{metatype_id}Retrieve MetatypeMetatypesApiupdate_metatypePUT/containers/{container_id}/metatypes/{metatype_id}Update MetatypeMetatypesApivalidate_metatype_propertiesPOST/containers/{container_id}/metatypes/{metatype_id}Validate Metatype PropertiesMiscApihealthGET/healthHealthUsersApiaccept_container_inviteGET/users/inviteAcceptContainerInviteUsersApiassign_user_rolePOST/containers/{container_id}/users/rolesAssignUserRoleUsersApidelete_userDELETE/users/{user_id}DeleteUserUsersApiinvite_user_to_containerPOST/containers/{container_id}/users/inviteInviteUserToContainerUsersApilist_invited_users_for_containerGET/containers/{container_id}/users/inviteListInvitedUsersForContainerUsersApilist_outstanding_invitesGET/users/invitesListOutstandingInvitesUsersApilist_user_permissionsGET/users/permissionsListUserPermissionsUsersApilist_usersGET/usersListUsersUsersApilist_users_for_containerGET/containers/{container_id}/usersListUsersForContainerUsersApilist_users_rolesGET/containers/{container_id}/users/{user_id}/rolesListUsersRolesUsersApiretrieve_userGET/containers/{container_id}/users/{user_id}RetrieveUserUsersApiupdate_userPUT/users/{user_id}UpdateUserDocumentation For ModelsAddDataToImportResponseAssignRoleRequestBatchContainerUpdateRequestBatchUpdateContainerResponseChallengeChallengeMethodsContainerContainerConfigContainerImportRequestContainerImportResponseContainerImportUpdateResponseContainerInviteContainersDatasourcesImportsRequestContainersImportBodyContainersQueryResponseContextCreateContainerRequestCreateContainerResponseCreateDataSourceConfigCreateDataSourceRequestCreateDataSourcesResponseCreateEventResponseCreateImportResponseCreateManualImportCreateManualImportResponseCreateMetatypeKeysResponseCreateMetatypeRelationshipKeysResponseCreateMetatypeRelationshipPairsResponseCreateMetatypeRelationshipsResponseCreateMetatypesResponseCreateOrUpdateEdgesRequestCreateOrUpdateNodesRequestCreateRegisteredEventRequestCreateTransformationResponseCreateTypeMappingTransformationsRequestCredentialValidationResultDataExportConfigDataSourceDataSourceConfigDataSourceIdFilesBodyDataSourceImportDataStagingEdgeErrorModelErrorResponseEventExporterExporterConfigFileInfoFileModelGeneric200ResponseGetContainerResponseGetDataExportResponseGetDataSourceResponseGetDataTypeMappingResponseGetEdgeResponseGetEventActionResponseGetEventActionStatusResponseGetFileInfoResponseGetImportDataResponseGetMetatypeKeyResponseGetMetatypeRelationshipKeyResponseGetMetatypeRelationshipPairResponseGetMetatypeRelationshipResponseGetMetatypeResponseGetNodeResponseGetUserResponseImportContainerIdBodyImportIdDataBodyImportModelInlineResponse200InlineResponse2001InlineResponse2001ValueInlineResponse2002InlineResponse2002ValueKeyValidationListContainerInvitesResponseListContainerResponseListDataExportsResponseListDataSourceImportsResponseListDataSourcesResponseListDataTypeMappingResponseListEdgeFilesListEdgesResponseListEventActionResponseListEventActionStatusResponseListImportDataResponseListMetatypeKeysResponseListMetatypeRelationshipKeysResponseListMetatypeRelationshipPairsResponseListMetatypeRelationshipsResponseListMetatypesResponseListNodeFilesListNodesResponseListTransformationResponseListUserInvitesResponseListUserPermissionsResponseListUserRolesListUsersForContainerResponseListUsersResponseMappingsImportBodyMetatypeMetatypeKeyMetatypeRelationshipNewDataExportRequestNewMetatypeKeyRequestNewMetatypeRelationshipKeyRequestNewMetatypeRelationshipPairRequestNewMetatypeRelationshipRequestNewMetatypeRequestNodeNodeMetatypeBodyNotFound404OneOfinlineResponse200PromptRSACancelRequestRSAInitRequestRSAResponseRSAStatusRequestRSAStatusResponseRSAVerifyRequestRelationshipKeyRelationshipPairRequiredMethodTokenExchangeRequestTransformationTransformationConditionTransformationKeyTypeMappingTypeMappingExportPayloadUpdateContainerRequestUpdateContainerResponseUpdateDataSourceResponseUpdateDataTypeMappingResponseUpdateImportDataResponseUpdateMetatypeKeyRequestUpdateMetatypeKeyResponseUpdateMetatypeRelationshipKeyResponseUpdateMetatypeRelationshipPairResponseUpdateMetatypeRelationshipRequestUpdateMetatypeRelationshipResponseUpdateMetatypeRequestUpdateMetatypeResponseUpdateRegisteredEventRequestUpdateTransformationResponseUploadFileResponseUserUserKeyValidateMetatypePropertiesRequestValidateMetatypePropertiesResponseValidationValueVersionOther SoftwareIdaho National Laboratory is a cutting edge research facility which is a constantly producing high quality research and software. Feel free to take a look at our other software and scientific offerings at:Primary Technology Offerings PageSupported Open Source SoftwareRaw Experiment Open Source SoftwareUnsupported Open Source SoftwareLicenseCopyright 2021 Battelle Energy Alliance, LLCLicensed under the MIT License (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License athttps://opensource.org/licenses/MITUnless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.LicensingThis software is licensed under the terms you may find in the file named "LICENSE" in this directory.DevelopersBy contributing to this software project, you are agreeing to the following terms and conditions for your contributions:You agree your contributions are submitted under the MIT license. You represent you are authorized to make the contributions and grant the license. If your employer has rights to intellectual property that includes your contributions, you represent that you have received permission to make contributions and grant the required license on behalf of that employer.