Skip to main content

Flask decorator to output RDF using content negotiation

Project description

A Flask decorator to output RDF using content negotiation.

Apply the @flask_rdf decorator to a view function and return an rdflib Graph object. Flask_rdf will automatically format it into an RDF output format, depending on what the request’s Accept header says. If the view function returns something besides an rdflib graph, it will be passed through without modification.

Custom formats can be registered easily. After registering the new serializer with rdflib’s plugin support, use the decide_format method to register a new mimetype request to use the new formatter.

API

  • add_format

    Registers a new format to be recognized for content negotiation. It accepts a (mimetype, serialize_format) pair, and is used to add any custom rdflib serializer plugins to be used for the content negotiation.

  • decide_format

    Given an Accept header, return a (mimetype, format) tuple that would best satisfy the client’s request.

  • flask_rdf

    Decorator for a Flask view function to use the Flask request’s Accept header. It handles converting an rdflib Graph object to the proper Flask response, depending on the content negotiation. Other content is returned without modification.

Example

#!/usr/bin/env python
from rdflib import Graph, BNode, Literal, URIRef
from rdflib.namespace import FOAF
from flask import Flask
from flask_rdf import flask_rdf
import random

app = Flask(__name__)

@app.route('/')
@app.route('/<path:path>')
@flask_rdf
def random_age(path=''):
    graph = Graph('IOMemory', BNode())
    graph.add((URIRef(path), FOAF.age, Literal(random.randint(20, 50))))
    return graph

if __name__ == '__main__':
    app.run(host='0.0.0.0', debug=True)
Build Status

Project details


Release history Release notifications

History Node

0.2.1

History Node

0.2.0

History Node

0.1.8

History Node

0.1.7

This version
History Node

0.1.6

History Node

0.1.5

Supported by

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