Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Package for implementing Dorset remote agent API

Project description

Dorset remote agent library

https://secure.travis-ci.org/DorsetProject/dorset-python.png?branch=master

This library provides components for implementing the remote agent web service API for Dorset conversational interface project.

Installation

Install using pip:

$ pip install dorset

Usage

This library handles the encoding and decoding of requests and responses from a Dorset application. This supports the creation of remote agents written in Python. Use this library with a python framework for RESTful APIs like Flask, Bottle, or Django.

The web framework will handle HTTP requests and response and this library will decode the request as an AgentRequest object and will encode an AgentResponse.

With Flask, this will look like:

app = Flask("dorset_hello")

# required endpoint for the application to test if the agent is alive
@app.route('/ping', methods=['GET'])
def ping():
    return json.dumps("pong")

# primary endpoint
@app.route('/request', methods=['POST'])
def process():
    agent_request = Dorset.decode_request(request.data)

    print(agent_request.text)

    return Dorset.encode_response(text="hello, world!")

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
dorset-0.4.0.tar.gz (4.0 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page