platypush.plugins.http.request

class platypush.plugins.http.request.HttpRequestPlugin(**kwargs)

Plugin for executing custom HTTP requests.

Requires:

• requests (pip install requests)

Some example usages:

# Execute a GET request on a JSON endpoint
{
    "type": "request",
    "action": "http.request.get",
    "args": {
        "url": "http://remote-host/api/v1/entity",
        "params": {
            "start": "2000-01-01"
        }
    }
}

# Execute an action on another Platypush host through HTTP interface
{
    "type": "request",
    "action": "http.request.post",
    "args": {
        "url": "http://remote-host:8008/execute",
        "json": {
            "type": "request",
            "target": "remote-host",
            "action": "music.mpd.play"
        }
    }
}

__init__(**kwargs)

Initialize self. See help(type(self)) for accurate signature.

delete(url, **kwargs)

Perform a DELETE request

Parameters

• url (str) – Target URL

• kwargs (dict) – Additional arguments that will be transparently provided to the requests object, including but not limited to query params, data, JSON, headers etc. (see http://docs.python-requests.org/en/master/user/quickstart/#make-a-request)

download(url: str, path: str, **kwargs)

Locally download the content of a remote URL.

Parameters

• url – URL to be downloaded.

• path – Path where the content will be downloaded on the local filesystem - must be a file name.

get(url, **kwargs)

Perform a GET request

Parameters

• url (str) – Target URL

• kwargs (dict) – Additional arguments that will be transparently provided to the requests object, including but not limited to query params, data, JSON, headers etc. (see http://docs.python-requests.org/en/master/user/quickstart/#make-a-request)

head(url, **kwargs)

Perform an HTTP HEAD request

Parameters

• url (str) – Target URL

• kwargs (dict) – Additional arguments that will be transparently provided to the requests object, including but not limited to query params, data, JSON, headers etc. (see http://docs.python-requests.org/en/master/user/quickstart/#make-a-request)

options(url, **kwargs)

Perform an HTTP OPTIONS request

Parameters

• url (str) – Target URL

• kwargs (dict) – Additional arguments that will be transparently provided to the requests object, including but not limited to query params, data, JSON, headers etc. (see http://docs.python-requests.org/en/master/user/quickstart/#make-a-request)

post(url, **kwargs)

Perform a POST request

Parameters

• url (str) – Target URL

• kwargs (dict) – Additional arguments that will be transparently provided to the requests object, including but not limited to query params, data, JSON, headers etc. (see http://docs.python-requests.org/en/master/user/quickstart/#make-a-request)

put(url, **kwargs)

Perform a PUT request

Parameters

• url (str) – Target URL

• kwargs (dict) – Additional arguments that will be transparently provided to the requests object, including but not limited to query params, data, JSON, headers etc. (see http://docs.python-requests.org/en/master/user/quickstart/#make-a-request)