Commit cceca13e by willmcgugan@gmail.com

Docs update

parent fa7b8da1
...@@ -46,16 +46,16 @@ master_doc = 'index' ...@@ -46,16 +46,16 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'PyFilesystem' project = u'PyFilesystem'
copyright = u'2009-2010, Will McGugan, Ryan Kelly' copyright = u'2009-2014, Will McGugan, Ryan Kelly'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '0.4' version = '0.5'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '0.4.0' release = '0.5.0'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
......
Getting Started 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 Installing
---------- ----------
The easiest way to install PyFilesystem is with `easy_install <http://peak.telecommunity.com/DevCenter/EasyInstall>`_:: To install with pip, use the following
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::
pip install fs pip install fs
Or to upgrade:: Or to upgrade to the most recent version::
pip install fs --upgrade pip install fs --upgrade
...@@ -32,12 +24,12 @@ Whichever method you use, you should now have the `fs` module on your path (vers ...@@ -32,12 +24,12 @@ Whichever method you use, you should now have the `fs` module on your path (vers
>>> import fs >>> import fs
>>> fs.__version__ >>> fs.__version__
'0.4.0' '0.5.0'
Prerequisites 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/ * Boto (required for :mod:`fs.s3fs`) http://code.google.com/p/boto/
* Paramiko (required for :class:`fs.ftpfs.FTPFS`) http://www.lag.net/paramiko/ * Paramiko (required for :class:`fs.ftpfs.FTPFS`) http://www.lag.net/paramiko/
......
...@@ -25,6 +25,7 @@ Guide ...@@ -25,6 +25,7 @@ Guide
utilities.rst utilities.rst
commands.rst commands.rst
implementersguide.rst implementersguide.rst
releasenotes.rst
Code Documentation Code Documentation
------------------ ------------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment