turbinia-api-lib

Turbinia is an open-source framework for deploying, managing, and running distributed forensic workloads

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

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.7.0
• Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

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

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 turbinia_api_lib

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 turbinia_api_lib

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import turbinia_api_lib
from turbinia_api_lib.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = turbinia_api_lib.Configuration(
    host = "http://localhost"
)

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

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with turbinia_api_lib.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = turbinia_api_lib.TurbiniaConfigurationApi(api_client)

    try:
        # Download Configuration
        api_response = api_instance.download_config()
        print("The response of TurbiniaConfigurationApi->download_config:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling TurbiniaConfigurationApi->download_config: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation For Models

• BaseRequestOptions
• CompleteTurbiniaStats
• HTTPValidationError
• LocationInner
• Request
• ValidationError

Documentation For Authorization

Authentication schemes defined for the API:

oAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://accounts.google.com/o/oauth2/v2/auth
• Scopes: N/A

Author