summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorwillmcgugan <willmcgugan@67cdc799-7952-0410-af00-57a81ceafa0f>2010-06-20 14:57:15 +0000
committerwillmcgugan <willmcgugan@67cdc799-7952-0410-af00-57a81ceafa0f>2010-06-20 14:57:15 +0000
commit38ee8158bb71e981da6cd9233c36aa8463a8774b (patch)
tree20250dd54fe85940ee6238593940e040f44a5055 /docs
parente1eeb7f174cf3a11a9fd98db52b93576143658e8 (diff)
downloadpyfilesystem-38ee8158bb71e981da6cd9233c36aa8463a8774b.tar.gz
Doc updates
git-svn-id: http://pyfilesystem.googlecode.com/svn/trunk@371 67cdc799-7952-0410-af00-57a81ceafa0f
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py6
-rw-r--r--docs/getting_started.rst12
-rw-r--r--docs/interface.rst1
-rw-r--r--docs/introduction.rst22
4 files changed, 36 insertions, 5 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 61069f3..6526577 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -38,16 +38,16 @@ master_doc = 'index'
# General information about the project.
project = u'PyFilesystem'
-copyright = u'2009, Will McGugan'
+copyright = u'2009-2010, Will McGugan, Ryan Kelly'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
-version = '0.2'
+version = '0.3'
# The full version, including alpha/beta/rc tags.
-release = '0.2'
+release = '0.3.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
index 937f52f..089706a 100644
--- a/docs/getting_started.rst
+++ b/docs/getting_started.rst
@@ -10,6 +10,10 @@ The easiest way to install PyFilesystem is with `easy_install <http://peak.telec
easy_install fs
+Add the -U switch if you want to upgrade a previous installation::
+
+ easy_install -U fs
+
This will install the latest stable release. If you would prefer to install the cutting edge release then you can get the latest copy of the source via SVN::
svn checkout http://pyfilesystem.googlecode.com/svn/trunk/ pyfilesystem-read-only
@@ -20,12 +24,12 @@ You should now have the `fs` module on your path:
>>> import fs
>>> fs.__version__
- '0.2.0a9'
+ '0.3.0'
Prerequisites
-------------
-PyFilesystem requires at least **Python 2.4**. There are a few other dependancies if you want to use some of the more advanced filesystem interfaces, but for basic use all that is needed is the Python standard library.
+PyFilesystem requires at least **Python 2.4**. There are a few other dependencies if you want to use some of the more advanced filesystem interfaces, but for basic use all that is needed is the Python standard library.
* wxPython (required for fs.browsewin) http://www.wxpython.org/
* Boto (required for fs.s3fs) http://code.google.com/p/boto/
@@ -43,6 +47,10 @@ The following will list all the files in your home directory::
>>> home_fs = OSFS('~/') # 'c:\Users\<login name>' on Windows
>>> home_fs.listdir()
+Here's how to browse your home folder with a graphical interface::
+
+ >>> home_fs.browse()
+
This will display the total number of bytes store in '.py' files your home directory::
>>> sum(home_fs.getsize(f) for f in home_fs.walkfiles(wildcard='*.py'))
diff --git a/docs/interface.rst b/docs/interface.rst
index d8ce157..59f07d7 100644
--- a/docs/interface.rst
+++ b/docs/interface.rst
@@ -40,6 +40,7 @@ The following methods have default implementations in fs.base.FS and aren't requ
* :meth:`~fs.base.FS.movedir` Recursively move a directory to a new location
* :meth:`~fs.base.FS.opendir` Opens a directory and returns an FS object that represents it
* :meth:`~fs.base.FS.safeopen` Like :meth:`~fs.base.open` but returns a NullFile if the file could not be opened
+ * :meth:`~fs.base.FS.settimes` Sets the accessed and modified times of a path
Utility Methods
diff --git a/docs/introduction.rst b/docs/introduction.rst
index bb92746..ae32dce 100644
--- a/docs/introduction.rst
+++ b/docs/introduction.rst
@@ -7,3 +7,25 @@ Think of PyFilesystem (FS) objects as the next logical step to Python's `file` o
Even if you only want to work with the local filesystem, PyFilesystem simplifies a number of common operations and reduces the chance of error.
+About PyFilestem
+----------------
+
+PyFilesystem was initially created by Will McGugan (http://www.willmcgugan.com) and is now a joint effort with Ryan Kelly (http://www.rfk.id.au/).
+
+
+Need Help?
+----------
+
+PyFilesystem is in development, but should be pretty stable. If you have any problems or questions, please contact the developers through one of the following channels:
+
+Bugs
+####
+
+If you find a bug in PyFilesytem, please file an issue: http://code.google.com/p/pyfilesystem/issues/list
+
+Discussion Group
+################
+
+There is also a discussion group for PyFilesystem: http://groups.google.com/group/pyfilesystem-discussion
+
+