Permalink
Browse files

Add README file.

  • Loading branch information...
sashka committed Jun 25, 2012
1 parent b8f19dd commit c794b04b4516210b0b6e4435853ba8d4ced347c1
Showing with 19 additions and 0 deletions.
  1. +19 −0 README.rst
View
@@ -0,0 +1,19 @@
+AtomicFile
+==========
+Writeable file object that atomically updates a file.
+
+All writes will go to a temporary file. Call ``close()`` explicitly when you are done writing, and AtomicFile will rename the temporary copy to the original name, making the changes visible. If the object is destroyed without being closed, all your writes are discarded.
+
+AtomicFile is friendly to ``with`` statement. ::
+
+ from atomicfile import AtomicFile
+
+ with AtomicFile("panic.txt", "w") as f:
+ f.write(json.dumps(big_data_array_100MB, sort_keys=True, indent=4))
+
+
+Install
+-------
+To install AtomicFile, simply: ::
+
+ pip install atomicfile

0 comments on commit c794b04

Please sign in to comment.