ibutsu-client

A system to store and query test results

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

• API version: 3.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Installation & Usage

pip install

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

pip install git+https://github.com/ibutsu/ibutsu-client-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/ibutsu/ibutsu-client-python.git)

Then import the package:

import ibutsu_client

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 ibutsu_client

Getting Started

Please follow the installation procedure and then run the following:

import time
import ibutsu_client
from pprint import pprint
from ibutsu_client.api import admin_project_management_api
from ibutsu_client.model.project import Project
from ibutsu_client.model.project_list import ProjectList
# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = ibutsu_client.Configuration(
    host = "/api"
)

# 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 Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)


# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = admin_project_management_api.AdminProjectManagementApi(api_client)
    project = Project(
        id="44941c55-9736-42f6-acce-ca3c4739d0f3",
        name="my-project",
        title="My project",
        owner_id="6b8b01ad-a17e-4ca1-8df5-fadb41439567",
        group_id="a16ad60e-bf23-4195-99dc-594858ad3e5e",
    ) # Project | A project (optional)

    try:
        # Administration endpoint to manually add a project. Only accessible to superadmins.
        api_response = api_instance.admin_add_project(project=project)
        pprint(api_response)
    except ibutsu_client.ApiException as e:
        print("Exception when calling AdminProjectManagementApi->admin_add_project: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /api

Documentation For Models

• AccountRecovery
• AccountRegistration
• AccountReset
• Artifact
• ArtifactList
• CreateToken
• Credentials
• Dashboard
• DashboardList
• GetReportTypes200ResponseInner
• Group
• GroupList
• Health
• HealthInfo
• LoginConfig
• LoginError
• LoginSupport
• LoginToken
• ModelImport
• Pagination
• Project
• ProjectList
• Report
• ReportList
• ReportParameters
• Result
• ResultList
• Run
• RunList
• Token
• TokenList
• UpdateRun
• User
• UserList
• WidgetConfig
• WidgetConfigList
• WidgetParam
• WidgetType
• WidgetTypeList

Documentation For Authorization

Authorization with JWT

• Type: Bearer authentication (JWT)