Commits

Fabian Topfstedt  committed 79ba138

docs

  • Participants
  • Parent commits 37c94a0

Comments (0)

Files changed (1)

-FileChunkIO represents a chunk of an OS-level file containing bytes data. Requires Python 2.6+.
+FileChunkIO represents a chunk of an OS-level file containing bytes data.
+Python 2.6+ is required.
 
-# An example:
+BACKGROUND:
+I wrote FileChunkIO to upload huge files to Amazon S3 in multiple parts
+without having to split them physically upfront (which requires more time and
+twice the disk space) or creating in-memory chunks as StringIO instances.
+
+EXAMPLE:
 >>> from filechunkio import FileChunkIO
 >>> chunk = FileChunkIO('LICENCE', offset=646, bytes=201)
 >>> chunk.read()