Vela Python SDK

Python SDK for Vela (Target's official Pipeline Automation Framework)

Vela is in active development and is a pre-release product.

This Python package is automatically generated by the Swagger Codegen project:

• API version: 0.6.1
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

You can install directly from Github

pip install git+https://github.com/go-vela/sdk-python.git

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

Then import the package:

import vela

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 vela

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import vela
from vela.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
configuration = vela.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'Bearer'

# Configure API endpoint
configuration.host = 'https://your-vela-server.example.com'

# create an instance of the API class
api_instance = vela.BuildsApi(vela.ApiClient(configuration))

try:
    api_response = api_instance.get_builds(org="go-vela",repo="sdk-python")
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BuildsApi->get_builds: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v1

Class	Method	HTTP request	Description
AdminApi	admin_all_builds	GET /api/v1/admin/builds
AdminApi	admin_all_deployments	GET /api/v1/admin/deployments
AdminApi	admin_all_hooks	GET /api/v1/admin/hooks
AdminApi	admin_all_repos	GET /api/v1/admin/repos
AdminApi	admin_all_secrets	GET /api/v1/admin/secrets
AdminApi	admin_all_services	GET /api/v1/admin/services
AdminApi	admin_all_steps	GET /api/v1/admin/steps
AdminApi	admin_all_users	GET /api/v1/admin/users
AdminApi	admin_update_build	PUT /api/v1/admin/build
AdminApi	admin_update_deployment	PUT /api/v1/admin/deployment
AdminApi	admin_update_hook	PUT /api/v1/admin/hook
AdminApi	admin_update_repo	PUT /api/v1/admin/repo
AdminApi	admin_update_secret	PUT /api/v1/admin/secret
AdminApi	admin_update_service	PUT /api/v1/admin/service
AdminApi	admin_update_step	PUT /api/v1/admin/step
AdminApi	admin_update_user	PUT /api/v1/admin/user
AuthenticateApi	get_authenticate	GET /authenticate
AuthenticateApi	get_login	GET /login
AuthenticateApi	logout	GET /logout
AuthenticateApi	post_authenticate	POST /authenticate
AuthenticateApi	post_login	POST /login
BuildsApi	create_build	POST /api/v1/repos/{org}/{repo}/builds
BuildsApi	delete_build	DELETE /api/v1/repos/{org}/{repo}/builds/{build}
BuildsApi	get_build	GET /api/v1/repos/{org}/{repo}/builds/{build}
BuildsApi	get_build_logs	GET /api/v1/repos/{org}/{repo}/builds/{build}/logs
BuildsApi	get_builds	GET /api/v1/repos/{org}/{repo}/builds
BuildsApi	get_org_builds	GET /api/v1/repos/{org}
BuildsApi	restart_build	POST /api/v1/repos/{org}/{repo}/builds/{build}
BuildsApi	update_build	PUT /api/v1/repos/{org}/{repo}/builds/{build}
DeploymentApi	create_deployment	POST /api/v1/deployments/{org}/{repo}
DeploymentApi	delete_hooks	DELETE /api/v1/hooks/{org}/{repo}/{hook}
DeploymentApi	get_deployment	GET /api/v1/deployments/{org}/{repo}/{deployment}
DeploymentApi	get_deployments	GET /api/v1/deployments/{org}/{repo}
DeploymentApi	get_hook	GET /api/v1/hooks/{org}/{repo}/{hook}
DeploymentApi	get_hooks	GET /api/v1/hooks/{org}/{repo}
PipelinesApi	compile_pipeline	POST /api/v1/pipelines/{org}/{repo}/compile
PipelinesApi	expand_pipeline	POST /api/v1/pipelines/{org}/{repo}/expand
PipelinesApi	get_pipeline	GET /api/v1/pipelines/{org}/{repo}
PipelinesApi	get_templates	GET /api/v1/pipelines/{org}/{repo}/templates
PipelinesApi	validate_pipeline	POST /api/v1/pipelines/{org}/{repo}/validate
ReposApi	chown_repo	PATCH /api/v1/repos/{org}/{repo}/chown
ReposApi	create_repo	POST /api/v1/repos
ReposApi	delete_repo	DELETE /api/v1/repos/{org}/{repo}
ReposApi	get_repo	GET /api/v1/repos/{org}/{repo}
ReposApi	get_repos	GET /api/v1/repos
ReposApi	repair_repo	PATCH /api/v1/repos/{org}/{repo}/repair
ReposApi	update_repo	PUT /api/v1/repos/{org}/{repo}
RouterApi	base_metrics	GET /metrics
RouterApi	get_badge	GET /badge/{org}/{repo}/status.svg
RouterApi	health	GET /health
RouterApi	post_webhook	POST /webhook
RouterApi	version	GET /version
SecretsApi	create_secret	POST /api/v1/secrets/{engine}/{type}/{org}/{name}
SecretsApi	delete_secret	DELETE /api/v1/secrets/{engine}/{type}/{org}/{name}/{secret}	Delete a secret from the configured backend.
SecretsApi	get_secret	GET /api/v1/secrets/{engine}/{type}/{org}/{name}/{secret}	Retrieve a secret from the configured backend.
SecretsApi	get_secrets	GET /api/v1/secrets/{engine}/{type}/{org}/{name}	Retrieve a list of secrets from the configured backend.
SecretsApi	update_secrets	PUT /api/v1/secrets/{engine}/{type}/{org}/{name}/{secret}	Update a secret from the configured backend.
ServicesApi	create_service	POST /api/v1/repos/{org}/{repo}/builds/{build}/services
ServicesApi	create_service_logs	POST /api/v1/repos/{org}/{repo}/builds/{build}/services/{service}/logs
ServicesApi	delete_service	DELETE /api/v1/repos/{org}/{repo}/builds/{build}/services/{service}
ServicesApi	delete_service_logs	DELETE /api/v1/repos/{org}/{repo}/builds/{build}/services/{service}/logs
ServicesApi	get_service	GET /api/v1/repos/{org}/{repo}/builds/{build}/services/{service}
ServicesApi	get_service_logs	GET /api/v1/repos/{org}/{repo}/builds/{build}/services/{service}/logs
ServicesApi	get_services	GET /api/v1/repos/{org}/{repo}/builds/{build}/services
ServicesApi	update_service	PUT /api/v1/repos/{org}/{repo}/builds/{build}/services/{service}
ServicesApi	update_service_log	PUT /api/v1/repos/{org}/{repo}/builds/{build}/services/{service}/logs
StepsApi	create_step	POST /api/v1/repos/{org}/{repo}/builds/{build}/steps
StepsApi	create_step_log	POST /api/v1/repos/{org}/{repo}/builds/{build}/steps/{step}/logs
StepsApi	delete_step	DELETE /api/v1/repos/{org}/{repo}/builds/{build}/steps/{step}
StepsApi	delete_step_log	DELETE /api/v1/repos/{org}/{repo}/builds/{build}/steps/{step}/logs
StepsApi	get_step	GET /api/v1/repos/{org}/{repo}/builds/{build}/steps/{step}
StepsApi	get_step_log	GET /api/v1/repos/{org}/{repo}/builds/{build}/steps/{step}/logs
StepsApi	get_steps	GET /api/v1/repos/{org}/{repo}/builds/{build}/steps
StepsApi	update_step	PUT /api/v1/repos/{org}/{repo}/builds/{build}/steps/{step}
StepsApi	update_step_log	PUT /api/v1/repos/{org}/{repo}/builds/{build}/steps/{step}/logs
UsersApi	create_token	POST /api/v1/user/token
UsersApi	create_user	POST /api/v1/users
UsersApi	delete_token	DELETE /api/v1/user/token
UsersApi	delete_user	DELETE /api/v1/users/{user}
UsersApi	get_current_user	GET /api/v1/user
UsersApi	get_user	GET /api/v1/users/{user}
UsersApi	get_user_source_repos	GET /api/v1/user/source/repos
UsersApi	get_users	GET /api/v1/users
UsersApi	update_current_user	PUT /api/v1/user
UsersApi	update_user	PUT /api/v1/users/{user}
WebhookApi	create_hook	POST /api/v1/hooks/{org}/{repo}
WebhookApi	update_hook	PUT /api/v1/hooks/{org}/{repo}/{hook}
WorkersApi	create_worker	POST /api/v1/workers
WorkersApi	delete_worker	DELETE /api/v1/workers/{worker}
WorkersApi	get_worker	GET /api/v1/workers/{worker}
WorkersApi	get_workers	GET /api/v1/workers
WorkersApi	update_worker	PUT /api/v1/workers/{worker}

Documentation For Models

• Build
• Container
• ContainerSlice
• Deployment
• Executor
• Log
• Login
• PipelineBuild
• PipelineMetadata
• PipelineWorker
• Repo
• Rules
• Ruleset
• Ruletype
• Secret
• SecretSlice
• Service
• Stage
• StageSlice
• Step
• StepSecret
• StepSecretSlice
• Template
• Ulimit
• UlimitSlice
• User
• Volume
• VolumeSlice
• Webhook
• Worker

Documentation For Authorization

ApiKeyAuth

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

Contributing

We are always welcome to new pull requests!

Please see our contributing documentation for further instructions.

Support

We are always here to help!

Please see our support documentation for further instructions.

Copyright and License

Copyright (c) 2022 Target Brands, Inc.

Apache License, Version 2.0