nexus-sdk

As part of Atinary™ Nexus, we offer a downloadable software development kit (SDK) client, which facilitates the access to the application programming interface (API) entry point. This API allows users to manage their project subscriptions and to share files among collaborators involved in the same project(s). The api usage requires an API KEY, associated to your Atinary™ Nexus account. You can generate your API KEY on your account information page.

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

• API version: 1.1.0
• Package version: 1.1.0
• Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen For more information, please visit https://scientia.atinary.com/nexus

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

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

pip install git+https://github.com/Atinary-technologies/nexus_sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/Atinary-technologies/nexus_sdk.git)

Then import the package:

import nexus_sdk

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 nexus_sdk

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import nexus_sdk
from nexus_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://scientia.atinary.com/nexus/api/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = nexus_sdk.Configuration(
    host = "https://scientia.atinary.com/nexus/api/latest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: api_key
configuration.api_key['api_key'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Configure Bearer authorization (JWT): tokens
configuration = nexus_sdk.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)


# Enter a context with an instance of the API client
with nexus_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nexus_sdk.AdminApi(api_client)
    
    try:
        # Health check
        api_response = api_instance.health_check()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdminApi->health_check: %s\n" % e)
    

Documentation for API Endpoints

All URIs are relative to https://scientia.atinary.com/nexus/api/latest

Class	Method	HTTP request	Description
AdminApi	health_check	GET /Healthcheck	Health check
AdminApi	service_information	GET /ServiceInfo	Service information.
FilesApi	delete_file	DELETE /Files/{file_id}	Delete a file
FilesApi	delete_files	POST /Files/delete
FilesApi	download_file	GET /Files/{file_id}	Download a file
FilesApi	list_files	GET /Files	List available files for a project
FilesApi	upload_file	POST /Files	Upload a file under a project
ProjectsApi	create_project	POST /Projects	Create a new project
ProjectsApi	create_tutorial_project	POST /Tutorial	Create the tutorial project
ProjectsApi	delete_project	DELETE /Projects/{project_id}	Delete a project
ProjectsApi	get_project	GET /Projects/{project_id}	Get project information
ProjectsApi	list_projects	GET /Projects	List project subscriptions
ProjectsApi	subscribe_users	POST /Projects/{project_id}/Subscribe	Add users to a project
ProjectsApi	unsubscribe	POST /Projects/{project_id}/Unsubscribe	Unsubscribe from a project
ProjectsApi	update_project	PUT /Projects/{project_id}	Update project name, description and owner

Documentation For Models

• AvailableFile
• AvailableFilesSummary
• AvailableProject
• CreateProjectResponse
• DeleteFilesReq
• GenericResponse
• HealthCheckReport
• ListFilesResponse
• ListProjectsResponse
• ProjectCreateReq
• ProjectDetail
• ProjectDetailResponse
• ProjectSubscribeReq
• ProjectUnsubscribeReq
• ProjectUpdateReq
• Result
• ServiceInfo
• ServiceInfoResponse
• UploadResponse

Documentation For Authorization

api_key

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header

tokens

• Type: Bearer authentication (JWT)

Author

[email protected]