Merge lp:~sil/u1db/testing-inmemory into lp:u1db

[Sidnei da Silva]

Add a note to the tutorial documentation explaining how to use inmemory implementations of u1db for test suites.

Add a note to the tutorial documentation explaining how to use inmemory implementations of u1db for test suites.

[Sidnei da Silva (sidnei)]

review: Approve

=== modified file 'html-docs/tutorial.rst'
--- html-docs/tutorial.rst	2012-09-26 07:11:08 +0000
+++ html-docs/tutorial.rst	2012-12-05 15:12:39 +0000
@@ -7,6 +7,8 @@
 in the u1db source tree.  It comes with a user interface, but we will only
 focus on the code that interacts with u1db here.
 
+This tutorial demonstrates the Python implementation of u1db.
+
 Defining the Task Object
 ------------------------
 
@@ -394,7 +396,46 @@
             # refresh the UI to show the resolved version
             self.refresh_filter()
 
-Full Cosas Documentation and Source Code 
+Testing your programs
+---------------------
+
+When building tests for programs which use u1db, you may not want to create a real database
+file in your test suite. U1DB can be run entirely in-memory; this makes test suites easier
+to write and much faster to run!
+
+Python
+======
+
+For Python u1db-using programs, there are two ways to create an in-memory U1DB. The Python
+implementation of u1db has its own in-memory implementation:
+
+.. code-block:: python
+
+        # db = u1db.open(somepath, create=True) # this is how your program will normally use u1db
+
+        # Use the in-memory implementation instead:
+        from u1db.backends import inmemory
+        db = inmemory.InMemoryDatabase("test")
+
+Alternatively, you can take advantage of the Python implementation being backed by SQLite, and
+use SQLite's in-memory implementation:
+
+.. code-block:: python
+
+        db = u1db.open(":memory:", create=True) # create a SQLite database in memory
+
+C
+=
+
+The C implementation of u1db does not have its own in-memory implementation, but you can
+use SQLite's:
+
+.. code-block:: c
+
+        #include <u1db/u1db.h>
+        u1database *db = u1db_open(":memory:");
+
+Full Cosas Documentation and Source Code
 ----------------------------------------
 
 .. automodule:: cosas.cosas
@@ -403,3 +444,4 @@
 .. automodule:: cosas.ui
     :members:
 
+