SuRF – Object RDF mapper

SuRF is an Object - RDF Mapper based on the popular rdflib python library. It exposes the RDF triple sets as sets of resources and seamlessly integrates them into the Object Oriented paradigm of python in a similar manner as ActiveRDF does for ruby.

Quick start:

from surf import *

store = Store(  reader='rdflib',
            writer='rdflib',
            rdflib_store = 'IOMemory')

session = Session(store)

print 'Load RDF data'
store.load_triples(source='http://www.w3.org/People/Berners-Lee/card.rdf')

Person = session.get_class(ns.FOAF['Person'])

all_persons = Person.all()

print 'Found %d persons that Tim Berners-Lee knows'%(len(all_persons))
for person in all_persons:
    print person.foaf_name.first

#create a person object
somebody = Person()
somebody_else = Person()

somebody.foaf_knows = somebody_else

Documentation

• Installing SuRF
  • Installing rdflib
  • Installing SuRF plugins
  • Loading plugins from path or running SuRF in embedded mode
  • Setting up SuRF in development mode
• Quick Start examples
  • Using the public SPARQL-endpoint from DBpedia
  • Loading a public remote RDF file using rdflib
  • Connecting surf.store.Store to MySQL
  • Connecting surf.store.Store to AllegroGraph
  • Creating a Pylons Blog, on SuRF
• The Store and the Session
  • What do surf.store.Store and surf.session.Session do?
  • Preparing the store and the session
• Resources and Classes
  • Getting a single Resource object
  • Loading multiple resources
  • Using resource attributes
  • Saving, deleting resources
  • Extending SuRF resource classes
• Queries
  • Executing arbitrary SPARQL queries
  • Constructing queries in a programmatic way
• Data Access Methods
  • The allegro_franz Plugin
  • The rdflib Plugin
  • The sesame2 Plugin
  • The sparql_protocol Plugin
  • Setting up OpenLink Virtuoso RDF Store
• Using SuRF with RDF triple stores
  • Install and Configure OpenLink Virtuoso RDF Store
  • Install and Configure AllegroGraph RDF Store

API reference

• The surf.exc Module
• The surf.namespace Module
  • Registered general purpose namespaces
• The surf.rdf module
• The surf.plugin Module
  • Contents
  • The surf.plugin.Plugin Base Class
• The surf.query Module
• The surf.resource Module
  • Contents
• The surf.resource base Module
• The surf.rest Module
• The surf.serializer Module
  • Serialization Example
• The surf.session Module
• The surf.store Module
• The surf.util Module

Acknowledgements

A great deal of thanks go to:

• Peteris Caune
• Christoph Burgmer

for their contributions and ideas put into SuRF.

Indices and tables

• Index
• Module Index
• Search Page