semaphore_client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

• API version: 2.8.34
• Package version: 1.0.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/VitexSoftware/libpython-semaphore-client.git

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

Then import the package:

import semaphore_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 semaphore_client

Getting Started

Please follow the installation procedure and then run the following:

import time
import semaphore_client
from pprint import pprint
from semaphore import authentication_api
from semaphore_client.model.api_token import APIToken
from semaphore_client.model.login import Login
# 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: bearer
configuration.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: cookie
configuration.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 client
with semaphore_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentication_api.AuthenticationApi(api_client)
    login_body = Login(
        auth="auth_example",
        password="password_example",
    ) # Login | 

    try:
        # Performs Login
        api_instance.auth_login_post(login_body)
    except semaphore_client.ApiException as e:
        print("Exception when calling AuthenticationApi->auth_login_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://demo.ansible-semaphore.com/api

Documentation For Models

• APIToken
• AccessKey
• AccessKeyRequest
• Environment
• EnvironmentRequest
• Event
• InfoType
• InfoTypeUpdate
• Inventory
• InventoryRequest
• Login
• Project
• ProjectProjectIdDeleteRequest
• ProjectProjectIdTasksGetRequest
• ProjectProjectIdUsersGetRequest
• ProjectRequest
• Repository
• RepositoryRequest
• Schedule
• ScheduleRequest
• Task
• TaskOutput
• Template
• TemplateRequest
• User
• UserPutRequest
• UserRequest
• UsersUserIdPasswordPostRequest
• View
• ViewRequest

Documentation For Authorization

bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

cookie

• Type: API key
• API key parameter name: Cookie
• Location: HTTP header

Author

Notes for Large OpenAPI documents

If 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 DefaultApi
• from semaphore_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 semaphore_client
from semaphore_client.apis import *
from semaphore_client.models import *