Skip to content

Latest commit

 

History

History
170 lines (123 loc) · 4.78 KB

README.rst

File metadata and controls

170 lines (123 loc) · 4.78 KB
Raw

dlrnapi-client

This is a Python client and command-line interface for the DLRN API.

It has been automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 or 3.6+

Installation & Usage

You can install directly from Github

pip install git+https://github.com/softwarefactory-project/dlrnapi_client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/softwarefactory-project/dlrnapi_client.git)

Then import the package:

import dlrnapi_client

Or you can run the client directly:

$ dlrnapi -h

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 dlrnapi_client

Or you can run the client directly:

$ dlrnapi -h

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import dlrnapi_client
from dlrnapi_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = dlrnapi_client.DefaultApi()
params = dlrnapi_client.Params() # Params | The JSON params to post

try:
    api_response = api_instance.api_last_tested_repo_get(params)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->api_last_tested_repo_get: %s\n" % e)

Documentation for command-line

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:5000

Class Method HTTP request Description

DefaultApi DefaultApi DefaultApi DefaultApi DefaultApi DefaultApi DefaultApi DefaultApi DefaultApi DefaultApi

api_last_tested_repo_get api_last_tested_repo_post api_promote_post api_promote_batch_post api_promotions_get api_build_metrics_get api_remote_import_post api_repo_status_get api_report_result_post api_agg_status_get

GET /api/last_tested_repo POST /api/last_tested_repo POST /api/promote POST /api/promote-batch POST /api/promotions GET /api/metrics/builds POST /api/remote/import GET /api/repo_status POST/api/report_result GET/api/agg_status

Documentation For Models

Documentation For Authorization

basicAuth

  • Type: HTTP basic authentication

Environment variables

  • DLRNAPI_PASSWORD: set the password to authenticate against the DLRN API.
  • SSL_VERIFY: set to ‘0’ to deactivate SSL verification when talking to the DLRN API.
  • SSL_CA_BUNDLE: when set to a value, it will instruct the client to use that file to verify SSL certificates, instead of the default CA bundle provided by certifi.

Author

Javier Peña (jpena@redhat.com)