Metadata-Version: 1.0
Name: neo4jdb
Version: 0.0.1
Summary: DB API 2.0 driver for the Neo4j graph database.
Home-page: https://github.com/jakewins/neo4jdb-python
Author: Jacob Hansson
Author-email: jakewins@gmail.com
License: UNKNOWN
Description: # Neo4jDB
        
        Implements the [Python DB API 2.0 for Neo4j](http://legacy.python.org/dev/peps/pep-0249/).
        
        ## Minimum viable snippet
        
            import neo4j
        
            connection = neo4j.connect("http://localhost:7474")
        
            cursor = connection.cursor()
            for name, age in cursor.execute("MATCH (n:User) RETURN n.name, n.age"):
                print name, age
        
        ## Usage
        
        The library generally adheres to the DB API, please refer to the documentation
        for the DB API for detailed usage.
        
            # Write statements
            cursor.execute("CREATE (n:User {name:'Stevie Brook'}")
            connection.commit() # Or connection.rollback()
        
            # With positional parameters
            cursor.execute("CREATE (n:User {name:{0}})", "Bob")
        
            # With named parameters
            cursor.execute("CREATE (n:User {name:{name}})", name="Bob")   
        
        
        ## Building & Testing
        
        Neo4jDB uses paver as its build system. To install paver:
        
            pip install paver
        
        Then you can build Neo4jDB with:
        
            paver build
        
        And install it with:
        
            paver install
        
        
        Running tests requires a Neo4j server running on localhost. Paver can handle
        this for you:
            
            paver start_server
            paver nosetests
            paver stop_server
        
            
        ## Incompliance with the spec
        
        ### Parameters
        
        The library delegates to Neo4j for parameter substitution, which means it does
        not use any of the standard parameter substitution types defined in the spec. 
        
        Instead it uses curly brackets with named and/or positional parameters:
        
            {0} or {identifier}
        
        
        ### Type system
        
        Because the wire format for Neo4j is JSON, the library does not support the 
        date or binary value types. This may change in the future as the wire format
        for Neo4j evolves.
        
        In a similar vein, because Neo4j is a schema-optional database, it may return
        arbitrary types in each cell in the result table. As such, the description of the
        result table always marks each column type as neo4j.MIXED.
        
        
        ## License
        
        http://opensource.org/licenses/MIT
        
Platform: UNKNOWN
