Skip to content

VitexSoftware/libpython-semaphore-client

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
.github/workflows
.github/workflows
 
 
.openapi-generator
.openapi-generator
 
 
.vscode
.vscode
 
 
docs
docs
 
 
semaphore_client
semaphore_client
 
 
test
test
 
 
.gitignore
.gitignore
 
 
.gitlab-ci.yml
.gitlab-ci.yml
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.travis.yml
.travis.yml
 
 
LICENSE
LICENSE
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
ansible-semaphore-openapi3.yaml
ansible-semaphore-openapi3.yaml
 
 
git_push.sh
git_push.sh
 
 
pyproject.toml
pyproject.toml
 
 
requirements.txt
requirements.txt
 
 
setup.cfg
setup.cfg
 
 
setup.py
setup.py
 
 
test-requirements.txt
test-requirements.txt
 
 
tox.ini
tox.ini
 
 

Repository files navigation

semaphore_client

Semaphore API provides endpoints for managing and interacting with the Semaphore UI. This documentation outlines the available operations and data models.

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

  • API version: 2.16.14
  • Package version: 1.0.0
  • Generator version: 7.17.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

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

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import semaphore_client
from semaphore_client.rest import ApiException
from pprint import pprint

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



# 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 = semaphore_client.AuthenticationApi(api_client)

    try:
        # Fetches login metadata
        api_response = api_instance.auth_login_get()
        print("The response of AuthenticationApi->auth_login_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthenticationApi->auth_login_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /api

Class Method HTTP request Description
AuthenticationApi auth_login_get GET /auth/login Fetches login metadata
AuthenticationApi auth_login_post POST /auth/login Performs Login
AuthenticationApi auth_logout_post POST /auth/logout Destroys current session
AuthenticationApi auth_oidc_provider_id_login_get GET /auth/oidc/{provider_id}/login Begin OIDC authentication flow and redirect to OIDC provider
AuthenticationApi auth_oidc_provider_id_redirect_get GET /auth/oidc/{provider_id}/redirect Finish OIDC authentication flow, upon succes you will be logged in
AuthenticationApi user_tokens_api_token_id_delete DELETE /user/tokens/{api_token_id} Expires API token
AuthenticationApi user_tokens_get GET /user/tokens Fetch API tokens for user
AuthenticationApi user_tokens_post POST /user/tokens Create an API token
DefaultApi apps_get GET /apps Get apps
DefaultApi debug_gc_post POST /debug/gc Garbage collector
DefaultApi events_get GET /events Get Events related to Semaphore and projects you are part of
DefaultApi events_last_get GET /events/last Get last 200 Events related to Semaphore and projects you are part of
DefaultApi info_get GET /info Fetches information about semaphore
DefaultApi ping_get GET /ping PING test
DefaultApi ws_get GET /ws Websocket handler
IntegrationApi project_project_id_integrations_get GET /project/{project_id}/integrations get all integrations
IntegrationApi project_project_id_integrations_integration_id_delete DELETE /project/{project_id}/integrations/{integration_id} Remove integration
IntegrationApi project_project_id_integrations_integration_id_get GET /project/{project_id}/integrations/{integration_id} Get Integration
IntegrationApi project_project_id_integrations_integration_id_matchers_get GET /project/{project_id}/integrations/{integration_id}/matchers Get Integration Matcher linked to integration extractor
IntegrationApi project_project_id_integrations_integration_id_matchers_matcher_id_delete DELETE /project/{project_id}/integrations/{integration_id}/matchers/{matcher_id} Removes integration matcher
IntegrationApi project_project_id_integrations_integration_id_matchers_matcher_id_put PUT /project/{project_id}/integrations/{integration_id}/matchers/{matcher_id} Updates Integration Matcher
IntegrationApi project_project_id_integrations_integration_id_matchers_post POST /project/{project_id}/integrations/{integration_id}/matchers Add Integration Matcher
IntegrationApi project_project_id_integrations_integration_id_put PUT /project/{project_id}/integrations/{integration_id} Update Integration
IntegrationApi project_project_id_integrations_integration_id_values_extractvalue_id_delete DELETE /project/{project_id}/integrations/{integration_id}/values/{extractvalue_id} Removes integration extract value
IntegrationApi project_project_id_integrations_integration_id_values_extractvalue_id_put PUT /project/{project_id}/integrations/{integration_id}/values/{extractvalue_id} Updates Integration ExtractValue
IntegrationApi project_project_id_integrations_integration_id_values_get GET /project/{project_id}/integrations/{integration_id}/values Get Integration Extracted Values linked to integration extractor
IntegrationApi project_project_id_integrations_integration_id_values_post POST /project/{project_id}/integrations/{integration_id}/values Add Integration Extracted Value
IntegrationApi project_project_id_integrations_post POST /project/{project_id}/integrations create a new integration
InventoryApi project_project_id_inventory_get GET /project/{project_id}/inventory Get inventory
InventoryApi project_project_id_inventory_inventory_id_delete DELETE /project/{project_id}/inventory/{inventory_id} Removes inventory
InventoryApi project_project_id_inventory_inventory_id_get GET /project/{project_id}/inventory/{inventory_id} Get inventory
InventoryApi project_project_id_inventory_inventory_id_put PUT /project/{project_id}/inventory/{inventory_id} Updates inventory
InventoryApi project_project_id_inventory_post POST /project/{project_id}/inventory create inventory
KeyStoreApi project_project_id_keys_get GET /project/{project_id}/keys Get access keys linked to project
KeyStoreApi project_project_id_keys_key_id_delete DELETE /project/{project_id}/keys/{key_id} Removes access key
KeyStoreApi project_project_id_keys_key_id_put PUT /project/{project_id}/keys/{key_id} Updates access key
KeyStoreApi project_project_id_keys_post POST /project/{project_id}/keys Add access key
ProjectApi project_project_id_backup_get GET /project/{project_id}/backup Backup A Project
ProjectApi project_project_id_delete DELETE /project/{project_id}/ Delete project
ProjectApi project_project_id_events_get GET /project/{project_id}/events Get Events related to this project
ProjectApi project_project_id_get GET /project/{project_id}/ Fetch project
ProjectApi project_project_id_notifications_test_post POST /project/{project_id}/notifications/test Send test notification
ProjectApi project_project_id_put PUT /project/{project_id}/ Update project
ProjectApi project_project_id_role_get GET /project/{project_id}/role Fetch permissions of the current user for project
ProjectApi project_project_id_users_get GET /project/{project_id}/users Get users linked to project
ProjectApi project_project_id_users_post POST /project/{project_id}/users Link user to project
ProjectApi project_project_id_users_user_id_delete DELETE /project/{project_id}/users/{user_id} Removes user from project
ProjectApi project_project_id_users_user_id_put PUT /project/{project_id}/users/{user_id} Update user role
ProjectApi project_project_id_views_get GET /project/{project_id}/views Get view
ProjectApi project_project_id_views_post POST /project/{project_id}/views create view
ProjectApi project_project_id_views_view_id_delete DELETE /project/{project_id}/views/{view_id} Removes view
ProjectApi project_project_id_views_view_id_get GET /project/{project_id}/views/{view_id} Get view
ProjectApi project_project_id_views_view_id_put PUT /project/{project_id}/views/{view_id} Updates view
ProjectApi projects_get GET /projects Get projects
ProjectApi projects_post POST /projects Create a new project
ProjectApi projects_restore_post POST /projects/restore Restore Project
RepositoryApi project_project_id_repositories_get GET /project/{project_id}/repositories Get repositories
RepositoryApi project_project_id_repositories_post POST /project/{project_id}/repositories Add repository
RepositoryApi project_project_id_repositories_repository_id_delete DELETE /project/{project_id}/repositories/{repository_id} Removes repository
RepositoryApi project_project_id_repositories_repository_id_get GET /project/{project_id}/repositories/{repository_id} Get repository
RepositoryApi project_project_id_repositories_repository_id_put PUT /project/{project_id}/repositories/{repository_id} Updates repository
ScheduleApi project_project_id_schedules_post POST /project/{project_id}/schedules create schedule
ScheduleApi project_project_id_schedules_schedule_id_delete DELETE /project/{project_id}/schedules/{schedule_id} Deletes schedule
ScheduleApi project_project_id_schedules_schedule_id_get GET /project/{project_id}/schedules/{schedule_id} Get schedule
ScheduleApi project_project_id_schedules_schedule_id_put PUT /project/{project_id}/schedules/{schedule_id} Updates schedule
TaskApi project_project_id_tasks_get GET /project/{project_id}/tasks Get Tasks related to current project
TaskApi project_project_id_tasks_last_get GET /project/{project_id}/tasks/last Get last 200 Tasks related to current project
TaskApi project_project_id_tasks_post POST /project/{project_id}/tasks Starts a job
TaskApi project_project_id_tasks_task_id_delete DELETE /project/{project_id}/tasks/{task_id} Deletes task (including output)
TaskApi project_project_id_tasks_task_id_get GET /project/{project_id}/tasks/{task_id} Get a single task
TaskApi project_project_id_tasks_task_id_output_get GET /project/{project_id}/tasks/{task_id}/output Get task output
TaskApi project_project_id_tasks_task_id_raw_output_get GET /project/{project_id}/tasks/{task_id}/raw_output Get task raw output
TaskApi project_project_id_tasks_task_id_stop_post POST /project/{project_id}/tasks/{task_id}/stop Stop a job
TemplateApi project_project_id_templates_get GET /project/{project_id}/templates Get template
TemplateApi project_project_id_templates_post POST /project/{project_id}/templates create template
TemplateApi project_project_id_templates_template_id_delete DELETE /project/{project_id}/templates/{template_id} Removes template
TemplateApi project_project_id_templates_template_id_get GET /project/{project_id}/templates/{template_id} Get template
TemplateApi project_project_id_templates_template_id_put PUT /project/{project_id}/templates/{template_id} Updates template
TemplateApi project_project_id_templates_template_id_stop_all_tasks_post POST /project/{project_id}/templates/{template_id}/stop_all_tasks Stop all active tasks of template
UserApi user_get GET /user/ Fetch logged in user
UserApi user_tokens_api_token_id_delete DELETE /user/tokens/{api_token_id} Expires API token
UserApi user_tokens_get GET /user/tokens Fetch API tokens for user
UserApi user_tokens_post POST /user/tokens Create an API token
UserApi users_get GET /users Fetches all users
UserApi users_post POST /users Creates a user
UserApi users_user_id_delete DELETE /users/{user_id}/ Deletes user
UserApi users_user_id_get GET /users/{user_id}/ Fetches a user profile
UserApi users_user_id_password_post POST /users/{user_id}/password Updates user password
UserApi users_user_id_put PUT /users/{user_id}/ Updates user details
VariableGroupApi project_project_id_environment_environment_id_delete DELETE /project/{project_id}/environment/{environment_id} Removes environment
VariableGroupApi project_project_id_environment_environment_id_get GET /project/{project_id}/environment/{environment_id} Get environment
VariableGroupApi project_project_id_environment_environment_id_put PUT /project/{project_id}/environment/{environment_id} Update environment
VariableGroupApi project_project_id_environment_get GET /project/{project_id}/environment Get environment
VariableGroupApi project_project_id_environment_post POST /project/{project_id}/environment Add environment

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

cookie

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

bearer

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

Author

About

Ansible Semaphore client library for python

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

4 stars

Watchers

2 watching

Forks

3 forks
Report repository

Releases 1

Dependency Fix Latest
Dec 11, 2022

Packages

No packages published

Languages