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
.. code:: sh
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)
.. code:: sh
pip install "dlrnapi_client[kerberos] @ git+https://github.com/softwarefactory-project/dlrnapi_client.git"
Then import the package:
.. code:: python
import dlrnapi_client
Or you can run the client directly:
.. code:: bash
$ dlrnapi -h
Setuptools
~~~~~~~~~~
Install via `Setuptools`_.
.. code:: sh
python setup.py install --user
(or ``sudo python setup.py install`` to install the package for all
users)
Then import the package:
.. code:: python
import dlrnapi_client
Or you can run the client directly:
.. code:: bash
$ dlrnapi -h
Getting Started
---------------
Please follow the `installation procedure`_ and then run the following:
.. code:: python
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
------------------------------
- `dlrnapi`_
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
------------------------
- `CIVote`_
- `Import`_
- `Params`_
- `Params1`_
- `Params2`_
- `Params3`_
- `Promotion`_
- `Repo`_
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)
.. _DLRN: https://github.com/softwarefactory-project/DLRN
.. _Swagger Codegen: https://github.com/swagger-api/swagger-codegen
.. _Setuptools: http://pypi.python.org/pypi/setuptools
.. _installation procedure: #installation--usage
.. _dlrnapi: docs/command-line.md
.. _api_last_tested_repo_get: docs/DefaultApi.md#api_last_tested_repo_get
.. _api_last_tested_repo_post: docs/DefaultApi.md#api_last_tested_repo_post
.. _api_promote_post: docs/DefaultApi.md#api_promote_post
.. _api_promote_batch_post: docs/DefaultApi.md#api_promote_batch_post
.. _api_promotions_get: docs/DefaultApi.md#api_promotions_get
.. _api_build_metrics_get: docs/DefaultApi.md#api_build_metrics_get
.. _api_remote_import_post: docs/DefaultApi.md#api_remote_import_post
.. _api_repo_status_get: docs/DefaultApi.md#api_repo_status_get
.. _api_report_result_post: docs/DefaultApi.md#api_report_result_post
.. _api_agg_status_get: docs/DefaultApi.md#api_agg_status_get
.. _CIVote: docs/CIVote.md
.. _Import: docs/ModelImport.md
.. _Params: docs/Params.md
.. _Params1: docs/Params1.md
.. _Params2: docs/Params2.md
.. _Params3: docs/Params3.md
.. _Promotion: docs/Promotion.md
.. _Repo: docs/Repo.md
Raw data
{
"_id": null,
"home_page": "http://www.rdoproject.org/",
"name": "dlrnapi-client",
"maintainer": "",
"docs_url": null,
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7",
"maintainer_email": "",
"keywords": "",
"author": "OpenStack",
"author_email": "jpena@redhat.com",
"download_url": "https://files.pythonhosted.org/packages/03/2d/7ead9e5af54a8342ae4b3ed763a8db6ee8afcc1768a307a311ec28a92e46/dlrnapi_client-0.13.1.tar.gz",
"platform": null,
"description": "dlrnapi-client\n==============\n\nThis is a Python client and command-line interface for the `DLRN`_ API.\n\nIt has been automatically generated by the `Swagger Codegen`_ project:\n\n- API version: 1.0.0\n- Package version: 1.0.0\n- Build package: io.swagger.codegen.languages.PythonClientCodegen\n\nRequirements.\n-------------\n\nPython 2.7 or 3.6+\n\nInstallation & Usage\n--------------------\n\nYou can install directly from Github\n\n.. code:: sh\n\n pip install git+https://github.com/softwarefactory-project/dlrnapi_client.git\n\n(you may need to run ``pip`` with root permission:\n``sudo pip install git+https://github.com/softwarefactory-project/dlrnapi_client.git``)\n\nIn order to support kerberos authentication, you need to execute this command (you need to have gcc and krb5-devel packages installed)\n\n.. code:: sh\n\n pip install \"dlrnapi_client[kerberos] @ git+https://github.com/softwarefactory-project/dlrnapi_client.git\"\n\nThen import the package:\n\n.. code:: python\n\n import dlrnapi_client\n\nOr you can run the client directly:\n\n.. code:: bash\n\n $ dlrnapi -h\n\nSetuptools\n~~~~~~~~~~\n\nInstall via `Setuptools`_.\n\n.. code:: sh\n\n python setup.py install --user\n\n(or ``sudo python setup.py install`` to install the package for all\nusers)\n\nThen import the package:\n\n.. code:: python\n\n import dlrnapi_client\n\nOr you can run the client directly:\n\n.. code:: bash\n\n $ dlrnapi -h\n\nGetting Started\n---------------\n\nPlease follow the `installation procedure`_ and then run the following:\n\n.. code:: python\n\n from __future__ import print_function\n import time\n import dlrnapi_client\n from dlrnapi_client.rest import ApiException\n from pprint import pprint\n # create an instance of the API class\n api_instance = dlrnapi_client.DefaultApi()\n params = dlrnapi_client.Params() # Params | The JSON params to post\n\n try:\n api_response = api_instance.api_last_tested_repo_get(params)\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DefaultApi->api_last_tested_repo_get: %s\\n\" % e)\n\nDocumentation for command-line\n------------------------------\n\n- `dlrnapi`_\n\nDocumentation for API Endpoints\n-------------------------------\n\nAll URIs are relative to http://127.0.0.1:5000\n\n============ ============================ ============================== ===========\nClass Method HTTP request Description\n============ ============================ ============================== ===========\n*DefaultApi* `api_last_tested_repo_get`_ **GET** /api/last_tested_repo\n*DefaultApi* `api_last_tested_repo_post`_ **POST** /api/last_tested_repo\n*DefaultApi* `api_promote_post`_ **POST** /api/promote\n*DefaultApi* `api_promote_batch_post`_ **POST** /api/promote-batch\n*DefaultApi* `api_promotions_get`_ **POST** /api/promotions\n*DefaultApi* `api_build_metrics_get`_ **GET** /api/metrics/builds\n*DefaultApi* `api_remote_import_post`_ **POST** /api/remote/import\n*DefaultApi* `api_repo_status_get`_ **GET** /api/repo_status\n*DefaultApi* `api_report_result_post`_ **POST**/api/report_result\n*DefaultApi* `api_agg_status_get`_ **GET**/api/agg_status\n============ ============================ ============================== ===========\n\nDocumentation For Models\n------------------------\n\n- `CIVote`_\n- `Import`_\n- `Params`_\n- `Params1`_\n- `Params2`_\n- `Params3`_\n- `Promotion`_\n- `Repo`_\n\nDocumentation For Authorization\n-------------------------------\n\nbasicAuth\n---------\n\n- **Type**: HTTP basic authentication\n\nEnvironment variables\n---------------------\n\n- *DLRNAPI_AUTHMETHOD*: set the auth method to authenticate against the\n DLRN API. Choices: kerberosAuth and basicAuth.\n- *DLRNAPI_USERNAME*: set the username to authenticate against the DLRN\n API when basicAuth method is selected.\n- *DLRNAPI_PASSWORD*: set the password to authenticate against the DLRN\n API when basicAuth method is selected.\n- *DLRNAPI_PRINCIPAL*: set the server principal used to request the token\n when kerberosAuth method is selected to auth against the DLRN API.\n API when basicAuth method is selected.\n- *SSL_VERIFY*: set to \u20180\u2019 to deactivate SSL verification when talking\n to the DLRN API.\n- *SSL_CA_BUNDLE*: when set to a value, it will instruct the client to\n use that file to verify SSL certificates, instead of the default CA\n bundle provided by `certifi`.\n\nAuthor\n------\n\nJavier Pe\u00f1a (jpena@redhat.com)\n\n.. _DLRN: https://github.com/softwarefactory-project/DLRN\n.. _Swagger Codegen: https://github.com/swagger-api/swagger-codegen\n.. _Setuptools: http://pypi.python.org/pypi/setuptools\n.. _installation procedure: #installation--usage\n.. _dlrnapi: docs/command-line.md\n.. _api_last_tested_repo_get: docs/DefaultApi.md#api_last_tested_repo_get\n.. _api_last_tested_repo_post: docs/DefaultApi.md#api_last_tested_repo_post\n.. _api_promote_post: docs/DefaultApi.md#api_promote_post\n.. _api_promote_batch_post: docs/DefaultApi.md#api_promote_batch_post\n.. _api_promotions_get: docs/DefaultApi.md#api_promotions_get\n.. _api_build_metrics_get: docs/DefaultApi.md#api_build_metrics_get\n.. _api_remote_import_post: docs/DefaultApi.md#api_remote_import_post\n.. _api_repo_status_get: docs/DefaultApi.md#api_repo_status_get\n.. _api_report_result_post: docs/DefaultApi.md#api_report_result_post\n.. _api_agg_status_get: docs/DefaultApi.md#api_agg_status_get\n.. _CIVote: docs/CIVote.md\n.. _Import: docs/ModelImport.md\n.. _Params: docs/Params.md\n.. _Params1: docs/Params1.md\n.. _Params2: docs/Params2.md\n.. _Params3: docs/Params3.md\n.. _Promotion: docs/Promotion.md\n.. _Repo: docs/Repo.md\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Client for DLRN REST API",
"version": "0.13.1",
"project_urls": {
"Bug Tracker": "https://github.com/softwarefactory-project/dlrnapi_client/issues",
"Homepage": "http://www.rdoproject.org/",
"Source Code": "https://github.com/softwarefactory-project/dlrnapi_client"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9a5114430ecbfe34f1588ed709395baaeb1fa93194861609923b26866f51e915",
"md5": "a629c3ed721f73d9edaf440bcc56e328",
"sha256": "b3858d93f5fd3513119ff4fe923dbcff58f8abc7835dc773aefff07d0aca4262"
},
"downloads": -1,
"filename": "dlrnapi_client-0.13.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "a629c3ed721f73d9edaf440bcc56e328",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7",
"size": 53414,
"upload_time": "2023-06-30T08:53:48",
"upload_time_iso_8601": "2023-06-30T08:53:48.780962Z",
"url": "https://files.pythonhosted.org/packages/9a/51/14430ecbfe34f1588ed709395baaeb1fa93194861609923b26866f51e915/dlrnapi_client-0.13.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "032d7ead9e5af54a8342ae4b3ed763a8db6ee8afcc1768a307a311ec28a92e46",
"md5": "4c6276a43ff0e96374b50e9a5315f08f",
"sha256": "5fe2c16abd7c88446b524b3d029afc6856f44ee9efaf31dcb5557f5880b44951"
},
"downloads": -1,
"filename": "dlrnapi_client-0.13.1.tar.gz",
"has_sig": false,
"md5_digest": "4c6276a43ff0e96374b50e9a5315f08f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7",
"size": 48427,
"upload_time": "2023-06-30T08:53:50",
"upload_time_iso_8601": "2023-06-30T08:53:50.580064Z",
"url": "https://files.pythonhosted.org/packages/03/2d/7ead9e5af54a8342ae4b3ed763a8db6ee8afcc1768a307a311ec28a92e46/dlrnapi_client-0.13.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-30 08:53:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "softwarefactory-project",
"github_project": "dlrnapi_client",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "certifi",
"specs": [
[
">=",
"14.05.14"
]
]
},
{
"name": "six",
"specs": [
[
">=",
"1.10"
]
]
},
{
"name": "python_dateutil",
"specs": [
[
">=",
"2.5.3"
]
]
},
{
"name": "setuptools",
"specs": [
[
">=",
"21.0.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
">=",
"1.15.1"
]
]
}
],
"tox": true,
"lcname": "dlrnapi-client"
}
JSON
