API Documentation

General

pyramid_skosprovider.get_skos_registry(registry)[source]

Get the skosprovider.registry.Registry attached to this pyramid application.

Return type:skosprovider.registry.Registry

Utils

This module contains a few utility functions.

pyramid_skosprovider.utils.parse_range_header(range)[source]

Parse a range header as used by the dojo Json Rest store.

Parameters:range (str) – The content of the range header to be parsed. eg. items=0-9
Returns:A dict with keys start, finish and number or False if the range is invalid.

Renderers

This module contains function for rendering SKOS objects to JSON.

pyramid_skosprovider.renderers.collection_adapter(obj, request)[source]

Adapter for rendering a skosprovider.skos.Collection to json.

Parameters:obj (skosprovider.skos.Collection) – The collection to be rendered.
Return type:dict
pyramid_skosprovider.renderers.concept_adapter(obj, request)[source]

Adapter for rendering a skosprovider.skos.Concept to json.

Parameters:obj (skosprovider.skos.Concept) – The concept to be rendered.
Return type:dict
pyramid_skosprovider.renderers.label_adapter(obj, request)[source]

Adapter for rendering a skosprovider.skos.Label to json.

Parameters:obj (skosprovider.skos.Label) – The label to be rendered.
Return type:dict
pyramid_skosprovider.renderers.note_adapter(obj, request)[source]

Adapter for rendering a skosprovider.skos.Note to json.

Parameters:obj (skosprovider.skos.Note) – The note to be rendered.
Return type:dict
pyramid_skosprovider.renderers.source_adapter(obj, request)[source]

Adapter for rendering a skosprovider.skos.Source to json.

Parameters:obj (skosprovider.skos.Source) – The source to be rendered.
Return type:dict

Views

This module contains the pyramid views that expose services.

class pyramid_skosprovider.views.ProviderView(request)[source]

A set of views that expose information from a certain provider.