requests-mv-integrations

Introduction

Extension of Python HTTP requests with verbose logging using logging-mv-integrations.

Badges

docs Documentation Status License Status
info Hit Count Contributors
tests Travis-CI Build Status Code Coverage Status
package PyPI Package latest release Supported versions
other Requirements Status

Install

pip install requests_mv_integrations

Architecture

requests-mv-integrations is an extension of the Python package requests and it is used for TUNE Multiverse Integrations for handling all HTTP requests including APIs in REST and SOAP, screen scrapping, and handling response downloads in JSON, XML, and CSV.

UML requests-mv-integrations

Usage

URL_TUNE_MAT_API_COUNTRIES = \
    'https://api.mobileapptracking.com/v2/countries/find.json'

from requests_mv_integrations import (
    RequestMvIntegrationDownload,
)
request_download = RequestMvIntegrationDownload(logger_level=logging.DEBUG)

result = \
    request_download.request(
        request_method='GET',
        request_url=URL_TUNE_MAT_API_COUNTRIES,
        request_params=None,
        request_retry=None,
        request_headers=HEADER_CONTENT_TYPE_APP_JSON,
        request_label="TMC Countries"
    )

json_tune_mat_countries = result.json()

pprint(json_tune_mat_countries)

Example

$ python3 examples/example_request.py

{
    "asctime": "2017-10-13 12:02:53 -0700",
    "levelname": "INFO",
    "name": "__main__",
    "version": "00.05.04",
    "message": "Start"
}
{
    "asctime": "2017-10-13 12:02:53 -0700",
    "levelname": "DEBUG",
    "name": "requests_mv_integrations",
    "version": "00.05.04",
    "message": "TMC Countries: Start"
}
...
{
    "asctime": "2017-10-13 12:02:53 -0700",
    "levelname": "DEBUG",
    "name": "requests_mv_integrations",
    "version": "00.05.04",
    "message": "TMC Countries: Details",
    "request_data": "",
    "request_headers": {
        "Content-Type": "application/json",
        "User-Agent": "(requests-mv-integrations/00.05.04, Python/3.6.2)"},
        "request_label": "TMC Countries",
        "request_method": "GET",
        "request_params": {},
        "request_url": "https://api.mobileapptracking.com/v2/countries/find.json",
        "timeout": 60
}
{
    "asctime": "2017-10-13 12:02:53 -0700",
    "levelname": "DEBUG",
    "name": "requests_mv_integrations",
    "version": "00.05.04",
    "message": "TMC Countries: Curl",
    "request_curl": "curl --verbose
        -X GET
        -H 'Content-Type: application/json'
        -H 'User-Agent: (requests-mv-integrations/00.05.04, Python/3.6.2)'
        --connect-timeout 60
        -L 'https://api.mobileapptracking.com/v2/countries/find.json'",
    "request_label": "TMC Countries",
    "request_method": "GET"
}
...
{
    'data': [
        {'id': 0, 'name': 'International (Generic)'},
        {'id': 4, 'name': 'Afghanistan'},
        {'id': 8, 'name': 'Albania'},
        {'id': 10, 'name': 'Antarctica'},
        {'id': 12, 'name': 'Algeria'},
        {'id': 16, 'name': 'American Samoa'},
        {'id': 20, 'name': 'Andorra'},
        {'id': 24, 'name': 'Angola'},
        {'id': 28, 'name': 'Antigua And Barbuda'},
        {'id': 31, 'name': 'Azerbaijan'},
    ],
    'response_size': '845',
    'status_code': 200,
}

Classes

  • class RequestMvIntegration – Base class using requests with retry functionality and verbose logging.
  • class RequestMvIntegrationDownload – Download file handling.
  • class RequestMvIntegrationUpload – Upload file handling.

Requirements

requests-mv-integrations module is built upon Python 3 and has dependencies upon several Python modules available within Python Package Index PyPI.

make install

or

python3 -m pip uninstall --yes --no-input -r requirements.txt
python3 -m pip install --upgrade -r requirements.txt