circle downloads version license docs

Hello Dave...

I provide easy integration of the HAL specification for your REST Flask Applications.

Here is an example Dave...

# Third Party Libs
from flask import Flask

# First Party Libs
from flask_hal import HAL, document

app = Flask(__name__)
HAL(app)  # Initialise HAL

def hello():
    return document.Document(data={
        'message': 'Hello World'

if __name__ == "__main__":

Here is the response from the above view.

HTTP/1.1 200 OK
Content-Type: application/hal+json; charset=UTF-8
Date: Thu, 06 Aug 2015 10:24:04 GMT

    "_links": {
        "self": {
            "href": "/hello"
    "foo": "bar"

Usage Documentation

Change Log


  • A list can be used in data for Embedded object


  • Initial release including the core feature set


Special Thanks

Indices and tables