diff options
Diffstat (limited to 'docs/getting_started.rst')
| -rw-r--r-- | docs/getting_started.rst | 30 |
1 files changed, 11 insertions, 19 deletions
diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 66887e1..bdc08d0 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -1,24 +1,16 @@ Getting Started =============== -PyFilesystem is a Python-only module and can be installed with easy_install or from source. PyFilesystem is known to work on Linux, Mac and OSX. +PyFilesystem is a Python-only module and can be installed from source or with `pip <http://www.pip-installer.org/>`_. PyFilesystem works on Linux, Mac and OSX. Installing ---------- -The easiest way to install PyFilesystem is with `easy_install <http://peak.telecommunity.com/DevCenter/EasyInstall>`_:: - - easy_install fs - -Add the -U switch if you want to upgrade a previous installation:: - - easy_install -U fs - -If you prefer to use Pip (http://pypi.python.org/pypi/pip) to install Python packages, the procedure is much the same:: +To install with pip, use the following pip install fs - -Or to upgrade:: + +Or to upgrade to the most recent version:: pip install fs --upgrade @@ -32,16 +24,16 @@ Whichever method you use, you should now have the `fs` module on your path (vers >>> import fs >>> fs.__version__ - '0.4.0' + '0.5.0' Prerequisites ------------- -PyFilesystem requires at least **Python 2.5**. 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. - +PyFilesystem requires at least **Python 2.6**. 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. + * Boto (required for :mod:`fs.s3fs`) http://code.google.com/p/boto/ * Paramiko (required for :class:`fs.ftpfs.FTPFS`) http://www.lag.net/paramiko/ - * wxPython (required for :mod:`fs.browsewin`) http://www.wxpython.org/ + * wxPython (required for :mod:`fs.browsewin`) http://www.wxpython.org/ Quick Examples @@ -54,11 +46,11 @@ The following will list all the files in your home directory:: >>> from fs.osfs import OSFS >>> 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')) |