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 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.

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.

Source Distribution

dlrnapi_client-0.10.0.tar.gz (44.5 kB view details)

Uploaded Source

Built Distribution

dlrnapi_client-0.10.0-py2.py3-none-any.whl (51.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file dlrnapi_client-0.10.0.tar.gz.

File metadata

  • Download URL: dlrnapi_client-0.10.0.tar.gz
  • Upload date:
  • Size: 44.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.5

File hashes

Hashes for dlrnapi_client-0.10.0.tar.gz
Algorithm Hash digest
SHA256 917abc131fc48a7a9093a113dfa425bfa190e6daa2f83c7aa0b289a76cf0de09
MD5 a6b027d536cd03ce9943089dbef1390b
BLAKE2b-256 a7f9229f7a45a8ddea533cad47caedf5574a48d088bbe4ac6284e4ab08ea8ef7

See more details on using hashes here.

File details

Details for the file dlrnapi_client-0.10.0-py2.py3-none-any.whl.

File metadata

  • Download URL: dlrnapi_client-0.10.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 51.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.5

File hashes

Hashes for dlrnapi_client-0.10.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2df1ec35df206d6cb0ec2b56b44199271cdc501084a5a26addd4fd96148f21d6
MD5 08bbc5714c7d5a60a0d55ec8a04db977
BLAKE2b-256 02df27e9c1488afb17bcc1b6b8d01da0c6957c5a9b8380633c0854bdee71b045

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page