Added usage and split out keys() and key_details()

Author: dlrust

README.md

@@ -1,3 +1,30 @@
 # python-memcached-stats
 
 Python class to gather stats and slab keys from memcached via the memcached telnet interface
+
+## Usage
+
+Usage is simple:
+
+    from memcached_stats import MemcachedStats
+    mem = MemcachedStats()
+
+By default, it connects to localhost on port 11211. If you need to specify a host and/or port:
+
+    mem = MemcachedStats('1.2.3.4', '11211')
+
+Retrieve a dict containing the current stats from memcached:
+
+    >>> mem.stats()
+    {'accepting_conns': '1',
+     'auth_cmds': '0',
+     'auth_errors': '0',
+     ... }
+
+Retrieve a list of keys currently in use:
+
+    >>> mem.keys()
+    ['key-1',
+     'key-2',
+     'key-3',
+     ... ]

src/memcached_stats.py

@@ -14,8 +14,8 @@ def client(self):
             self._client = telnetlib.Telnet(self._host, self._port)
         return self._client
 
-    def keys(self, sort=True):
-        ' Return a list of keys in use '
+    def key_details(self, sort=True):
+        ' Return a list of tuples containing keys and details '
         keys = []
         slab_ids = self.slab_ids()
         for id in slab_ids:
@@ -26,6 +26,10 @@ def keys(self, sort=True):
             return sorted(keys)
         return keys
 
+    def keys(self, sort=True):
+        ' Return a list of keys in use '
+        return [key[0] for key in self.key_details(sort=sort)]
+
     def slab_ids(self):
         ' Return a list of slab ids in use '
         self.client.write("stats items\n")