Package: ansible-semaphore-client
semaphore_clientNo description provided (generated by Openapi Generatorhttps://github.com/openapitools/openapi-generator)This Python package is automatically generated by theOpenAPI Generatorproject:API version: 2.8.34Package version: 1.0.0Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirements.Python >=3.6Installation & Usagepip installIf the python package is hosted on a repository, you can install directly using:pipinstallgit+https://github.com/VitexSoftware/libpython-semaphore-client.git(you may need to runpipwith root permission:sudo pip install git+https://github.com/VitexSoftware/libpython-semaphore-client.git)Then import the package:importsemaphore_clientSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importsemaphore_clientGetting StartedPlease follow theinstallation procedureand then run the following:importtimeimportsemaphore_clientfrompprintimportpprintfromsemaphoreimportauthentication_apifromsemaphore_client.model.api_tokenimportAPITokenfromsemaphore_client.model.loginimportLogin# Defining the host is optional and defaults to https://demo.ansible-semaphore.com/api# See configuration.py for a list of all supported configuration parameters.configuration=semaphore_client.Configuration(host="https://demo.ansible-semaphore.com/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 API key authorization: bearerconfiguration.api_key['bearer']='YOUR_API_KEY'# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['bearer'] = 'Bearer'# Configure API key authorization: cookieconfiguration.api_key['cookie']='YOUR_API_KEY'# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['cookie'] = 'Bearer'# Enter a context with an instance of the API clientwithsemaphore_client.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=authentication_api.AuthenticationApi(api_client)login_body=Login(auth="auth_example",password="password_example",)# Login |try:# Performs Loginapi_instance.auth_login_post(login_body)exceptsemaphore_client.ApiExceptionase:print("Exception when calling AuthenticationApi->auth_login_post:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttps://demo.ansible-semaphore.com/apiClassMethodHTTP requestDescriptionAuthenticationApiauth_login_postPOST/auth/loginPerforms LoginAuthenticationApiauth_logout_postPOST/auth/logoutDestroys current sessionAuthenticationApiuser_tokens_api_token_id_deleteDELETE/user/tokens/{api_token_id}Expires API tokenAuthenticationApiuser_tokens_getGET/user/tokensFetch API tokens for userAuthenticationApiuser_tokens_postPOST/user/tokensCreate an API tokenDefaultApievents_getGET/eventsGet Events related to Semaphore and projects you are part ofDefaultApievents_last_getGET/events/lastGet last 200 Events related to Semaphore and projects you are part ofDefaultApiinfo_getGET/infoFetches information about semaphoreDefaultApiping_getGET/pingPING testDefaultApiws_getGET/wsWebsocket handlerProjectApiproject_project_id_deleteDELETE/project/{project_id}/Delete projectProjectApiproject_project_id_environment_environment_id_deleteDELETE/project/{project_id}/environment/{environment_id}Removes environmentProjectApiproject_project_id_environment_environment_id_putPUT/project/{project_id}/environment/{environment_id}Update environmentProjectApiproject_project_id_environment_getGET/project/{project_id}/environmentGet environmentProjectApiproject_project_id_environment_postPOST/project/{project_id}/environmentAdd environmentProjectApiproject_project_id_events_getGET/project/{project_id}/eventsGet Events related to this projectProjectApiproject_project_id_getGET/project/{project_id}/Fetch projectProjectApiproject_project_id_inventory_getGET/project/{project_id}/inventoryGet inventoryProjectApiproject_project_id_inventory_inventory_id_deleteDELETE/project/{project_id}/inventory/{inventory_id}Removes inventoryProjectApiproject_project_id_inventory_inventory_id_putPUT/project/{project_id}/inventory/{inventory_id}Updates inventoryProjectApiproject_project_id_inventory_postPOST/project/{project_id}/inventorycreate inventoryProjectApiproject_project_id_keys_getGET/project/{project_id}/keysGet access keys linked to projectProjectApiproject_project_id_keys_key_id_deleteDELETE/project/{project_id}/keys/{key_id}Removes access keyProjectApiproject_project_id_keys_key_id_putPUT/project/{project_id}/keys/{key_id}Updates access keyProjectApiproject_project_id_keys_postPOST/project/{project_id}/keysAdd access keyProjectApiproject_project_id_putPUT/project/{project_id}/Update projectProjectApiproject_project_id_repositories_getGET/project/{project_id}/repositoriesGet repositoriesProjectApiproject_project_id_repositories_postPOST/project/{project_id}/repositoriesAdd repositoryProjectApiproject_project_id_repositories_repository_id_deleteDELETE/project/{project_id}/repositories/{repository_id}Removes repositoryProjectApiproject_project_id_tasks_getGET/project/{project_id}/tasksGet Tasks related to current projectProjectApiproject_project_id_tasks_last_getGET/project/{project_id}/tasks/lastGet last 200 Tasks related to current projectProjectApiproject_project_id_tasks_postPOST/project/{project_id}/tasksStarts a jobProjectApiproject_project_id_tasks_task_id_deleteDELETE/project/{project_id}/tasks/{task_id}Deletes task (including output)ProjectApiproject_project_id_tasks_task_id_getGET/project/{project_id}/tasks/{task_id}Get a single taskProjectApiproject_project_id_tasks_task_id_output_getGET/project/{project_id}/tasks/{task_id}/outputGet task outputProjectApiproject_project_id_templates_getGET/project/{project_id}/templatesGet templateProjectApiproject_project_id_templates_postPOST/project/{project_id}/templatescreate templateProjectApiproject_project_id_templates_template_id_deleteDELETE/project/{project_id}/templates/{template_id}Removes templateProjectApiproject_project_id_templates_template_id_getGET/project/{project_id}/templates/{template_id}Get templateProjectApiproject_project_id_templates_template_id_putPUT/project/{project_id}/templates/{template_id}Updates templateProjectApiproject_project_id_users_getGET/project/{project_id}/usersGet users linked to projectProjectApiproject_project_id_users_postPOST/project/{project_id}/usersLink user to projectProjectApiproject_project_id_users_user_id_admin_deleteDELETE/project/{project_id}/users/{user_id}/adminRevoke admin privilegesProjectApiproject_project_id_users_user_id_admin_postPOST/project/{project_id}/users/{user_id}/adminMakes user adminProjectApiproject_project_id_users_user_id_deleteDELETE/project/{project_id}/users/{user_id}Removes user from projectProjectApiproject_project_id_views_getGET/project/{project_id}/viewsGet viewProjectApiproject_project_id_views_postPOST/project/{project_id}/viewscreate viewProjectApiproject_project_id_views_view_id_deleteDELETE/project/{project_id}/views/{view_id}Removes viewProjectApiproject_project_id_views_view_id_getGET/project/{project_id}/views/{view_id}Get viewProjectApiproject_project_id_views_view_id_putPUT/project/{project_id}/views/{view_id}Updates viewProjectsApiprojects_getGET/projectsGet projectsProjectsApiprojects_postPOST/projectsCreate a new projectScheduleApiproject_project_id_schedules_postPOST/project/{project_id}/schedulescreate scheduleScheduleApiproject_project_id_schedules_schedule_id_deleteDELETE/project/{project_id}/schedules/{schedule_id}Deletes scheduleScheduleApiproject_project_id_schedules_schedule_id_getGET/project/{project_id}/schedules/{schedule_id}Get scheduleScheduleApiproject_project_id_schedules_schedule_id_putPUT/project/{project_id}/schedules/{schedule_id}Updates scheduleUserApiuser_getGET/user/Fetch logged in userUserApiuser_tokens_api_token_id_deleteDELETE/user/tokens/{api_token_id}Expires API tokenUserApiuser_tokens_getGET/user/tokensFetch API tokens for userUserApiuser_tokens_postPOST/user/tokensCreate an API tokenUserApiusers_getGET/usersFetches all usersUserApiusers_postPOST/usersCreates a userUserApiusers_user_id_deleteDELETE/users/{user_id}/Deletes userUserApiusers_user_id_getGET/users/{user_id}/Fetches a user profileUserApiusers_user_id_password_postPOST/users/{user_id}/passwordUpdates user passwordUserApiusers_user_id_putPUT/users/{user_id}/Updates user detailsDocumentation For ModelsAPITokenAccessKeyAccessKeyRequestEnvironmentEnvironmentRequestEventInfoTypeInfoTypeUpdateInventoryInventoryRequestLoginProjectProjectProjectIdDeleteRequestProjectProjectIdTasksGetRequestProjectProjectIdUsersGetRequestProjectRequestRepositoryRepositoryRequestScheduleScheduleRequestTaskTaskOutputTemplateTemplateRequestUserUserPutRequestUserRequestUsersUserIdPasswordPostRequestViewViewRequestDocumentation For AuthorizationbearerType: API keyAPI key parameter name: AuthorizationLocation: HTTP headercookieType: API keyAPI key parameter name: CookieLocation: HTTP headerAuthorNotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in semaphore_client.apis and semaphore_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 semaphore_client.api.default_api import DefaultApifrom semaphore_client.model.pet import PetSolution 2:
Before importing the package, adjust the maximum recursion limit as shown below:import sys
sys.setrecursionlimit(1500)
import semaphore_client
from semaphore_client.apis import *
from semaphore_client.models import *