Client for DLRN REST API
Project description
# dlrnapi-client
This is a Python client and command-line interface for the [DLRN](https://github.com/openstack-packages/DLRN) API.
It has been automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
You can install directly from Github
```sh
pip install git+https://github.com/javierpena/dlrnapi_client.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/javierpena/dlrnapi_client.git`)
Then import the package:
```python
import dlrnapi_client
```
Or you can run the client directly:
```bash
$ dlrnapi -h
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import dlrnapi_client
```
Or you can run the client directly:
```bash
$ dlrnapi -h
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```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 = swagger_client.DefaultApi()
params = swagger_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](docs/command-line.md)
## 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**](docs/DefaultApi.md#api_last_tested_repo_get)|**GET** /api/last_tested_repo|
*DefaultApi*|[**api_last_tested_repo_post**](docs/DefaultApi.md#api_last_tested_repo_post)|**POST** /api/last_tested_repo|
*DefaultApi*|[**api_promote_post**](docs/DefaultApi.md#api_promote_post)|**POST** /api/promote|
*DefaultApi*|[**api_remote_import_post**](docs/DefaultApi.md#api_remote_import_post)|**POST** /api/remote/import|
*DefaultApi*|[**api_repo_status_get**](docs/DefaultApi.md#api_repo_status_get)|**GET** /api/repo_status|
*DefaultApi*|[**api_report_result_post**](docs/DefaultApi.md#api_report_result_post)|**POST**/api/report_result|
## Documentation For Models
- [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)
## Documentation For Authorization
## basicAuth
- **Type**: HTTP basic authentication
## Author
Javier Peña (jpena@redhat.com)
This is a Python client and command-line interface for the [DLRN](https://github.com/openstack-packages/DLRN) API.
It has been automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
You can install directly from Github
```sh
pip install git+https://github.com/javierpena/dlrnapi_client.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/javierpena/dlrnapi_client.git`)
Then import the package:
```python
import dlrnapi_client
```
Or you can run the client directly:
```bash
$ dlrnapi -h
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import dlrnapi_client
```
Or you can run the client directly:
```bash
$ dlrnapi -h
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```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 = swagger_client.DefaultApi()
params = swagger_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](docs/command-line.md)
## 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**](docs/DefaultApi.md#api_last_tested_repo_get)|**GET** /api/last_tested_repo|
*DefaultApi*|[**api_last_tested_repo_post**](docs/DefaultApi.md#api_last_tested_repo_post)|**POST** /api/last_tested_repo|
*DefaultApi*|[**api_promote_post**](docs/DefaultApi.md#api_promote_post)|**POST** /api/promote|
*DefaultApi*|[**api_remote_import_post**](docs/DefaultApi.md#api_remote_import_post)|**POST** /api/remote/import|
*DefaultApi*|[**api_repo_status_get**](docs/DefaultApi.md#api_repo_status_get)|**GET** /api/repo_status|
*DefaultApi*|[**api_report_result_post**](docs/DefaultApi.md#api_report_result_post)|**POST**/api/report_result|
## Documentation For Models
- [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)
## Documentation For Authorization
## basicAuth
- **Type**: HTTP basic authentication
## Author
Javier Peña (jpena@redhat.com)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file dlrnapi_client-0.0.1.dev12.tar.gz
.
File metadata
- Download URL: dlrnapi_client-0.0.1.dev12.tar.gz
- Upload date:
- Size: 33.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 943957ae05c83b1e29735120342852f0f27e7ea757734c987bf14b1a37eab4d0 |
|
MD5 | bad481d03298b58949471be38a28c09e |
|
BLAKE2b-256 | 4176c9d8e64a40bf24ab4b7f2abfe095a98209276b504bef289798fb30b24aef |