summaryrefslogtreecommitdiff
path: root/docs/introduction.rst
blob: affa880db821639d37689a8df3ee20b29db280bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
Introduction
============

PyFilesystem is a Python module that provides a common interface to any filesystem.

Think of PyFilesystem ``FS`` objects as the next logical step to Python's ``file`` class. Just as *file-like* objects abstract a single file, FS objects abstract the whole filesystem by providing a common interface to operations such as reading directories, getting file information, opening/copying/deleting files etc.

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 PyFilesystem
------------------

PyFilesystem was initially created by Will McGugan and is now a joint effort from the following contributors:


- Will McGugan (http://www.willmcgugan.com)
- Ryan Kelly (http://www.rfk.id.au)
- Andrew Scheller (http://www.andrewscheller.co.uk/)
- Ben Timby (http://ben.timby.com/)

And many others who have contributed bug reports and patches.


Need Help?
----------

If you have any problems or questions, please contact the developers through one of the following channels:

Bugs
####

If you find a bug in PyFilesystem, please file an issue: https://github.com/PyFilesystem/pyfilesystem/issues

Discussion Group
################

There is also a discussion group for PyFilesystem: http://groups.google.com/group/pyfilesystem-discussion