Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

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

Project Description

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
Release History

Release History

This version
History Node


History Node


History Node


Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
Flask-HAL-1.0.4.tar.gz (6.1 kB) Copy SHA256 Checksum SHA256 Source Oct 21, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting