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)

In order to support kerberos authentication, you need to execute this command (you need to have gcc and krb5-devel packages installed)

pip install "dlrnapi_client[kerberos] @ 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_AUTHMETHOD: set the auth method to authenticate against the DLRN API. Choices: kerberosAuth and basicAuth.

  • DLRNAPI_USERNAME: set the username to authenticate against the DLRN API when basicAuth method is selected.

  • DLRNAPI_PASSWORD: set the password to authenticate against the DLRN API when basicAuth method is selected.

  • DLRNAPI_PRINCIPAL: set the server principal used to request the token when kerberosAuth method is selected to auth against the DLRN API. API when basicAuth method is selected.

  • 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)

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

Uploaded Source

Built Distribution

dlrnapi_client-0.13.0-py2.py3-none-any.whl (53.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: dlrnapi_client-0.13.0.tar.gz
  • Upload date:
  • Size: 48.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for dlrnapi_client-0.13.0.tar.gz
Algorithm Hash digest
SHA256 5f798322fed58af82e36cc48172c71545ebcfe8c1476dc9b82f8171c8f606c34
MD5 b96b0fbd075aeb9b5ade850fc73d5cb1
BLAKE2b-256 3b37c504d25d91aa6eeff3f38f54aedb070c3b53f16d95ce56066cf170a3eda3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dlrnapi_client-0.13.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 258f982894a80a783a1e670f38bc8f929cb741862ad831e84b251a9e3a680160
MD5 b9196d87c3fce94c0ac23bfef3ef6768
BLAKE2b-256 87cdf56f2f16225d469741d5104bdb771b0fb529b2949a97df9e62cdaedc99de

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