Skip to main content

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

Project description

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"

## Contributing

Run tests using python test.

Change Log


  • Correctly deserialise embedded documents: #25
  • Support python test syntax: #24


  • Multiple links with the same relation will be put into an array


  • self links now take into account SERVER_NAME configuration


  • A list can be used in data for Embedded object


  • Initial release including the core feature set

Project details

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
Flask-HAL-1.0.4.tar.gz (6.1 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