ibutsu-client

A system to store and query test results

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

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

Requirements.

Python >=3.6

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

Class	Method	HTTP request	Description
AdminProjectManagementApi	admin_add_project	POST /admin/project	Administration endpoint to manually add a project. Only accessible to superadmins.
AdminProjectManagementApi	admin_delete_project	DELETE /admin/project/{id}	Administration endpoint to delete a project. Only accessible to superadmins.
AdminProjectManagementApi	admin_get_project	GET /admin/project/{id}	Administration endpoint to return a project. Only accessible to superadmins.
AdminProjectManagementApi	admin_get_project_list	GET /admin/project	Administration endpoint to return a list of projects. Only accessible to superadmins.
AdminProjectManagementApi	admin_update_project	PUT /admin/project/{id}	Administration endpoint to update a project. Only accessible to superadmins.
AdminUserManagementApi	admin_add_user	POST /admin/user	Administration endpoint to manually add a user. Only accessible to superadmins.
AdminUserManagementApi	admin_delete_user	DELETE /admin/user/{id}	Administration endpoint to delete a user. Only accessible to superadmins.
AdminUserManagementApi	admin_get_user	GET /admin/user/{id}	Administration endpoint to return a user. Only accessible to superadmins.
AdminUserManagementApi	admin_get_user_list	GET /admin/user	Administration endpoint to return a list of users. Only accessible to superadmins.
AdminUserManagementApi	admin_update_user	PUT /admin/user/{id}	Administration endpoint to update a user. Only accessible to superadmins.
ArtifactApi	delete_artifact	DELETE /artifact/{id}	Delete an artifact
ArtifactApi	download_artifact	GET /artifact/{id}/download	Download an artifact
ArtifactApi	get_artifact	GET /artifact/{id}	Get a single artifact
ArtifactApi	get_artifact_list	GET /artifact	Get a (filtered) list of artifacts
ArtifactApi	upload_artifact	POST /artifact	Uploads a test run artifact
ArtifactApi	view_artifact	GET /artifact/{id}/view	Stream an artifact directly to the client/browser
DashboardApi	add_dashboard	POST /dashboard	Create a dashboard
DashboardApi	delete_dashboard	DELETE /dashboard/{id}	Delete a dashboard
DashboardApi	get_dashboard	GET /dashboard/{id}	Get a single dashboard by ID
DashboardApi	get_dashboard_list	GET /dashboard	Get a list of dashboards
DashboardApi	update_dashboard	PUT /dashboard/{id}	Update a dashboard
GroupApi	add_group	POST /group	Create a new group
GroupApi	get_group	GET /group/{id}	Get a group
GroupApi	get_group_list	GET /group	Get a list of groups
GroupApi	update_group	PUT /group/{id}	Update a group
HealthApi	get_database_health	GET /health/database	Get a health report for the database
HealthApi	get_health	GET /health	Get a general health report
HealthApi	get_health_info	GET /health/info	Get information about the server
ImportApi	add_import	POST /import	Import a file into Ibutsu. This can be either a JUnit XML file, or an Ibutsu archive
ImportApi	get_import	GET /import/{id}	Get the status of an import
LoginApi	activate	GET /login/activate/{activation_code}
LoginApi	auth	GET /login/auth/{provider}
LoginApi	config	GET /login/config/{provider}
LoginApi	login	POST /login
LoginApi	recover	POST /login/recover
LoginApi	register	POST /login/register
LoginApi	reset_password	POST /login/reset-password
LoginApi	support	GET /login/support
ProjectApi	add_project	POST /project	Create a project
ProjectApi	get_project	GET /project/{id}	Get a single project by ID
ProjectApi	get_project_list	GET /project	Get a list of projects
ProjectApi	update_project	PUT /project/{id}	Update a project
ReportApi	add_report	POST /report	Create a new report
ReportApi	delete_report	DELETE /report/{id}	Delete a report
ReportApi	download_report	GET /report/{id}/download/{filename}	Download a report
ReportApi	get_report	GET /report/{id}	Get a report
ReportApi	get_report_list	GET /report	Get a list of reports
ReportApi	get_report_types	GET /report/types	Get a list of report types
ReportApi	view_report	GET /report/{id}/view/{filename}	View a report
ResultApi	add_result	POST /result	Create a test result
ResultApi	get_result	GET /result/{id}	Get a single result
ResultApi	get_result_list	GET /result	Get the list of results.
ResultApi	update_result	PUT /result/{id}	Updates a single result
RunApi	add_run	POST /run	Create a run
RunApi	bulk_update	POST /runs/bulk-update	Update multiple runs with common metadata
RunApi	get_run	GET /run/{id}	Get a single run by ID (uuid required)
RunApi	get_run_list	GET /run	Get a list of the test runs
RunApi	update_run	PUT /run/{id}	Update a single run
TaskApi	get_task	GET /task/{id}	Get the status or result of a task
UserApi	add_token	POST /user/token	Create a token for the current user
UserApi	delete_token	DELETE /user/token/{id}	Delete the token
UserApi	get_current_user	GET /user	Return the user details for the current user
UserApi	get_token	GET /user/token/{id}	Retrieve a single token for the current user
UserApi	get_token_list	GET /user/token	Return the tokens for the user
UserApi	update_current_user	PUT /user	Return the user details for the current user
WidgetApi	get_widget	GET /widget/{id}	Generate data for a dashboard widget
WidgetApi	get_widget_types	GET /widget/types	Get a list of widget types
WidgetConfigApi	add_widget_config	POST /widget-config	Create a widget configuration
WidgetConfigApi	delete_widget_config	DELETE /widget-config/{id}	Delete a widget configuration
WidgetConfigApi	get_widget_config	GET /widget-config/{id}	Get a single widget configuration
WidgetConfigApi	get_widget_config_list	GET /widget-config	Get the list of widget configurations
WidgetConfigApi	update_widget_config	PUT /widget-config/{id}	Updates a single widget configuration

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

jwt

• Type: Bearer authentication (JWT)

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in ibutsu_client.apis and ibutsu_client.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from ibutsu_client.api.default_api import DefaultApi
• from ibutsu_client.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import ibutsu_client
from ibutsu_client.apis import *
from ibutsu_client.models import *