Deep Lynx Python SDK

This is an SDK for the Deep Lynx data warehouse that supports Python projects. It is used for creating API requests and sending and receiving data from Deep Lynx.

This is an autogenerated file
Please see the official README for information on contributing, testing, installing, uploading to PyPi, as well as correctly formatted examples.

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Package version: 0.1.6
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Contributing

When running the swagger-codgen command to generate this code base, please supply the following language-specific options:
--additional-properties packageName=deep_lynx projectName=deep_lynx

Testing

Please provide the Deep Lynx API key and secret when performing testing. To do so, copy the .env-sample file and rename to .env and supply the needed values. Basic testing is currently performed within test/test_create_manual_import.py.

Requirements.

Python 2.7 or 3.4+

Installation & Usage

pip/poetry install

pip: pip install deep_lynx
poetry: poetry add deep_lynx

GitHub

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import deep_lynx 

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 deep_lynx

Uploading this Distribution to PyPi

Follow these steps for uploading the latest distribution to PyPI (requires maintainer access to the deep_lynx package). See the official docs for more information.

• Ensure both the build and twine packages have been installed
• Update setup.py and this README as necessary to update the VERSION and whatever other metadata adjustments are necessary
• Run python -m build to generate the dist/ directory with the source archive and built distribution files
• Upload the archives to PyPI by running python -m twine upload dist/* and providing your PyPI user credentials

Getting Started

Please follow the installation procedure and then run something like the following example (Python 3):

import deep_lynx
from deep_lynx.rest import ApiException
from pprint import pprint

# initialize an ApiClient for use with deep_lynx APIs
configuration = deep_lynx.configuration.Configuration()
configuration.host = 'http://localhost:8090'
apiClient = deep_lynx.ApiClient(configuration)

# authenticate via an API key and secret
authApi = 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 container
containerApi = deep_lynx.ContainersApi(apiClient)
container = containerApi.create_container(CreateContainerRequest(
    'myContainer', 'Container description', False
))
containerId = container.value[0].id

# create a data source
datasourcesApi = deep_lynx.DataSourcesApi(apiClient)

datasource = datasourcesApi.create_data_source(CreateDataSourceRequest(
    'sdk_test_source', 'standard', True
), containerId)
datasourceId = datasource.value.id

# create manual import
importResult = datasourcesApi.create_manual_import(
    {'test': 'test import'},
    containerId,
    datasourceId
)

Documentation for API Endpoints

All URIs are relative to http://localhost:8090 (or whatever your host and port is)

Documentation For Models

• AddDataToImportResponse
• AssignRoleRequest
• BatchContainerUpdateRequest
• BatchUpdateContainerResponse
• Challenge
• ChallengeMethods
• Container
• ContainerConfig
• ContainerImportRequest
• ContainerImportResponse
• ContainerImportUpdateResponse
• ContainerInvite
• ContainersDatasourcesImportsRequest
• ContainersImportBody
• ContainersQueryResponse
• Context
• CreateContainerRequest
• CreateContainerResponse
• CreateDataSourceConfig
• CreateDataSourceRequest
• CreateDataSourcesResponse
• CreateEventResponse
• CreateImportResponse
• CreateManualImport
• CreateManualImportResponse
• CreateMetatypeKeysResponse
• CreateMetatypeRelationshipKeysResponse
• CreateMetatypeRelationshipPairsResponse
• CreateMetatypeRelationshipsResponse
• CreateMetatypesResponse
• CreateOrUpdateEdgesRequest
• CreateOrUpdateNodesRequest
• CreateRegisteredEventRequest
• CreateTransformationResponse
• CreateTypeMappingTransformationsRequest
• CredentialValidationResult
• DataExportConfig
• DataSource
• DataSourceConfig
• DataSourceIdFilesBody
• DataSourceImport
• DataStaging
• Edge
• ErrorModel
• ErrorResponse
• Event
• Exporter
• ExporterConfig
• FileInfo
• FileModel
• Generic200Response
• GetContainerResponse
• GetDataExportResponse
• GetDataSourceResponse
• GetDataTypeMappingResponse
• GetEdgeResponse
• GetEventActionResponse
• GetEventActionStatusResponse
• GetFileInfoResponse
• GetImportDataResponse
• GetMetatypeKeyResponse
• GetMetatypeRelationshipKeyResponse
• GetMetatypeRelationshipPairResponse
• GetMetatypeRelationshipResponse
• GetMetatypeResponse
• GetNodeResponse
• GetUserResponse
• ImportContainerIdBody
• ImportIdDataBody
• ImportModel
• InlineResponse200
• InlineResponse2001
• InlineResponse2001Value
• InlineResponse2002
• InlineResponse2002Value
• KeyValidation
• ListContainerInvitesResponse
• ListContainerResponse
• ListDataExportsResponse
• ListDataSourceImportsResponse
• ListDataSourcesResponse
• ListDataTypeMappingResponse
• ListEdgeFiles
• ListEdgesResponse
• ListEventActionResponse
• ListEventActionStatusResponse
• ListImportDataResponse
• ListMetatypeKeysResponse
• ListMetatypeRelationshipKeysResponse
• ListMetatypeRelationshipPairsResponse
• ListMetatypeRelationshipsResponse
• ListMetatypesResponse
• ListNodeFiles
• ListNodesResponse
• ListTransformationResponse
• ListUserInvitesResponse
• ListUserPermissionsResponse
• ListUserRoles
• ListUsersForContainerResponse
• ListUsersResponse
• MappingsImportBody
• Metatype
• MetatypeKey
• MetatypeRelationship
• NewDataExportRequest
• NewMetatypeKeyRequest
• NewMetatypeRelationshipKeyRequest
• NewMetatypeRelationshipPairRequest
• NewMetatypeRelationshipRequest
• NewMetatypeRequest
• Node
• NodeMetatypeBody
• NotFound404
• OneOfinlineResponse200
• Prompt
• RSACancelRequest
• RSAInitRequest
• RSAResponse
• RSAStatusRequest
• RSAStatusResponse
• RSAVerifyRequest
• RelationshipKey
• RelationshipPair
• RequiredMethod
• TokenExchangeRequest
• Transformation
• TransformationCondition
• TransformationKey
• TypeMapping
• TypeMappingExportPayload
• UpdateContainerRequest
• UpdateContainerResponse
• UpdateDataSourceResponse
• UpdateDataTypeMappingResponse
• UpdateImportDataResponse
• UpdateMetatypeKeyRequest
• UpdateMetatypeKeyResponse
• UpdateMetatypeRelationshipKeyResponse
• UpdateMetatypeRelationshipPairResponse
• UpdateMetatypeRelationshipRequest
• UpdateMetatypeRelationshipResponse
• UpdateMetatypeRequest
• UpdateMetatypeResponse
• UpdateRegisteredEventRequest
• UpdateTransformationResponse
• UploadFileResponse
• User
• UserKey
• ValidateMetatypePropertiesRequest
• ValidateMetatypePropertiesResponse
• Validation
• Value
• Version

Other Software

Idaho 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 Page

Supported Open Source Software

Raw Experiment Open Source Software

Unsupported Open Source Software

License

Copyright 2021 Battelle Energy Alliance, LLC

Licensed 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 at

https://opensource.org/licenses/MIT

Unless 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.

Licensing

This software is licensed under the terms you may find in the file named "LICENSE" in this directory.

Developers

By 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.