Commits

dan mackinlay committed d0d588c

more useful documents

Comments (0)

Files changed (2)

 News
 ====
 
-0.1
----
+0.1dev
+------
 
 *Release date: 9-May-2011*
 
-* I spin this package off possumpalace_kit
+* I spin this package off https://bitbucket.org/howthebodyworks/possumpalace_kit/src/23e924ba53e8/_lib/citeulike/
 pythonic file tagging
 ==========================
 
-Simple-to-trivial wrapper for OpenMeta. Rather than re-implementing OpenMeta
+Simple-to-trivial wrapper for OpenMeta_. Rather than re-implementing OpenMeta
 using, say, Bob Ippolito's excellent xattr_, I decided to do it by wrapping
 the already-functional CLI binary, on advice from those more experienced than
 myself who suggested that the pain in getting OpenMeta working as advertised
-was great and terrible.
+from the direct xattr business was great and terrible.
 
 Warning - this thing does rely on parsing the output of CLI apps, with the
 flakiness and performance troubles that implies. However, it's working
 reliably for me.
 
+Usage
+-----
+    
+    >>> import openmeta
+    >>> open('./test.txt', 'w').close()
+    >>> openmeta.set_tags('./test.txt', ['foo', 'bar'])
+    >>> openmeta.get_meta('./test.txt')['tags']
+    ['foo', 'bar']
+
 Credits
 -------
 
-- openmeta_
+- OpenMeta_
 - xattr_
 
-.. _openmeta: http://code.google.com/p/openmeta/
+.. _OpenMeta: http://code.google.com/p/openmeta/
 .. _xattr: http://undefined.org/python/#xattr