From 07f65cc1d1e0414dbd57e1dfd308a310b2985670 Mon Sep 17 00:00:00 2001
From: Mike Dirolf <mike@10gen.com>
Date: Thu, 22 Jan 2009 16:27:57 -0500
Subject: [PATCH] add a simple example and update the README to reflect it

---
 README.rst              | 10 +++---
 examples/simple_demo.py | 77 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 83 insertions(+), 4 deletions(-)
 create mode 100644 examples/simple_demo.py

diff --git a/README.rst b/README.rst
index c13d3a7ce..eec23158d 100644
--- a/README.rst
+++ b/README.rst
@@ -12,15 +12,17 @@ The ``pymongo`` module is a native Python driver for the Mongo database.
 
 Installation
 ============
-If you have `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_ installed you should be able to do ``easy_install pymongo`` to install PyMongo. Otherwise you can download the project source and do ``python setup.py install`` to install.
+If you have `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_ installed you should be able to do **easy_install pymongo** to install PyMongo. Otherwise you can download the project source and do **python setup.py install** to install.
 
 Dependencies
 ============
 - `ElementTree <http://effbot.org/zone/element-index.htm>`_
 - (to generate documentation) `epydoc <http://epydoc.sourceforge.net/>`_
 
-Example
+Examples
 =======
+Here's a basic example (for more see the *examples/* directory):
+
 >>> from pymongo.connection import Connection
 >>> connection = Connection("localhost", 27017)
 >>> db = connection.test
@@ -57,8 +59,8 @@ ObjectId('\x03\x1c\x06\x8d|\x9d}O\x8b\xaf!\xa0'))])
 
 Documentation
 =============
-You will need `epydoc <http://epydoc.sourceforge.net/>`_ installed to generate the documentation. Documentation can be generated by running ``epydoc --config=epydoc-config``.
+You will need `epydoc <http://epydoc.sourceforge.net/>`_ installed to generate the documentation. Documentation can be generated by running **epydoc --config=epydoc-config**.
 
 Testing
 =======
-The easiest way to run the tests is to install `nose <http://somethingaboutorange.com/mrl/projects/nose/>`_ (``easy_install nose``) and run ``python setup.py test`` in the root of the distribution. Tests are located in the ``test/`` directory.
+The easiest way to run the tests is to install `nose <http://somethingaboutorange.com/mrl/projects/nose/>`_ (**easy_install nose**) and run **python setup.py test** in the root of the distribution. Tests are located in the *test/* directory.
diff --git a/examples/simple_demo.py b/examples/simple_demo.py
new file mode 100644
index 000000000..fd8701f23
--- /dev/null
+++ b/examples/simple_demo.py
@@ -0,0 +1,77 @@
+# Copyright 2009 10gen, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""A simple demo of pymongo - the Python Mongo driver.
+
+To run this, make sure that you are running an instance of Mongo on
+localhost:27017 and that you have the pymongo package installed:
+
+$ easy_install pymongo
+
+Then do:
+
+$ python simple_demo.py
+
+You should see a friendly message!
+"""
+import sys
+import datetime
+
+from pymongo.connection import Connection
+from pymongo.errors import ConnectionFailure
+
+# Make a connection to Mongo.
+try:
+    connection = Connection("localhost", 27017)
+except ConnectionFailure:
+    print "couldn't connect: be sure that Mongo is running on localhost:27017"
+    sys.exit(1)
+
+# Get the database "test".
+db = connection["test"]
+
+# Drop the collection just to be sure we are starting from a clean state.
+db.drop_collection("pymongo")
+
+# Now insert some documents into the "pymongo" collection.
+db.pymongo.insert({"x": 1})
+
+# Mongo is schema-free, so we can just add more fields on the fly.
+db.pymongo.insert({"x": 20, "y": 100})
+
+# We can also save other cool things, like booleans, strings
+db.pymongo.insert({"greeting": True, "hello": u"world"})
+
+# floats and dates.
+db.pymongo.insert({"name": u"mike", "account balance": 0.01, "time": datetime.datetime.now()})
+
+# The find_one method returns a single document, or None.
+doc = db.pymongo.find_one({"x": 20})
+assert doc["y"] == 100
+
+# The find method returns an iterable pymongo.cursor.Cursor over all the results.
+all_docs = db.pymongo.find()
+sum = 0
+for doc in all_docs:
+    sum += doc.get("x", 0)
+assert sum == 21
+
+# Get the first greeting and print it!
+key = "hello"
+print "%s, %s!" % (key, db.pymongo.find_one({"greeting": True})[key])
+
+print """\
+There is lot's more that you can do with Mongo and pymongo.
+Checkout http://www.mongodb.org for more!
+"""