Skip to main content

Client for DLRN REST API

Project description

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 api_last_tested_repo_get GET /api/last_tested_repo  
DefaultApi api_last_tested_repo_post POST /api/last_tested_repo  
DefaultApi api_promote_post POST /api/promote  
DefaultApi api_promote_batch_post POST /api/promote-batch  
DefaultApi api_promotions_get POST /api/promotions  
DefaultApi api_build_metrics_get GET /api/metrics/builds  
DefaultApi api_remote_import_post POST /api/remote/import  
DefaultApi api_repo_status_get GET /api/repo_status  
DefaultApi api_report_result_post POST/api/report_result  
DefaultApi api_agg_status_get GET/api/agg_status  

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.

Author

Javier Peña (jpena@redhat.com)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for dlrnapi-client, version 0.9.1
Filename, size File type Python version Upload date Hashes
Filename, size dlrnapi_client-0.9.1-py2.py3-none-any.whl (49.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size dlrnapi_client-0.9.1.tar.gz (42.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page