summaryrefslogtreecommitdiff
path: root/fs/__init__.py
diff options
context:
space:
mode:
Diffstat (limited to 'fs/__init__.py')
-rw-r--r--fs/__init__.py16
1 files changed, 14 insertions, 2 deletions
diff --git a/fs/__init__.py b/fs/__init__.py
index cd8a13b..3872617 100644
--- a/fs/__init__.py
+++ b/fs/__init__.py
@@ -1,12 +1,24 @@
"""
-A filesystem abstraction.
+
+ fs: a filesystem abstraction.
+
+This module provides an abstract base class 'FS' that defines a consistent
+interface to different kinds of filesystem, along with a range of concrete
+implementations of this interface such as:
+
+ OSFS: access the local filesystem, through the 'os' module
+ TempFS: a temporary filesystem that's automatically cleared on exit
+ MemoryFS: a filesystem that exists only in memory
+ ZipFS: access a zipfile like a filesystem
+ S3FS: access files stored in Amazon S3
"""
__version__ = "0.1.1dev"
__author__ = "Will McGugan (will@willmcgugan.com)"
-# 'base' imports * from 'path' and 'errors'
+# 'base' imports * from 'path' and 'errors', so they'll
+# be available here as well
from base import *
import errors