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.9.1.tar.gz (42.0 kB view details)

Uploaded Source

Built Distribution

dlrnapi_client-0.9.1-py2.py3-none-any.whl (49.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: dlrnapi_client-0.9.1.tar.gz
  • Upload date:
  • Size: 42.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.19.6 CPython/2.7.5

File hashes

Hashes for dlrnapi_client-0.9.1.tar.gz
Algorithm Hash digest
SHA256 a11915391435f14d1d6bb3fb89f49ec7f156a1c9558bdf00513c679fa1127751
MD5 75520ff7f74897ba04bb1a6a55da4483
BLAKE2b-256 0634176e1dd60b337e8258ac66ca1c1e12b00c54954bdbd121d6270e892578a9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dlrnapi_client-0.9.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 49.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.19.6 CPython/2.7.5

File hashes

Hashes for dlrnapi_client-0.9.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6257a9883e9fa473bdd4fa2c8c9d2706ac6e14f954d1339dba3fe39d88be7837
MD5 31dddb957bef0bcd13ad758ff89dd48d
BLAKE2b-256 c8324250993e2b897728eae74b391e8137169b0a6a34b9c96b24c45e68e034c4

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