File: introduction.rst

package info (click to toggle)
python-fs 2.4.16-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,944 kB
  • sloc: python: 13,048; makefile: 226; sh: 3
file content (30 lines) | stat: -rw-r--r-- 742 bytes parent folder | download | duplicates (4)
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
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`` objects. In the same way that file objects abstract a
single file, FS objects abstract an entire filesystem.


Installing
----------

You can install PyFilesystem with ``pip`` as follows::

    pip install fs

Or to upgrade to the most recent version::

    pip install fs --upgrade

PyFilesystem is also available on conda_::

    conda install fs -c conda-forge

Alternatively, if you would like to install from source, you can check
out `the code from Github <https://github.com/PyFilesystem/pyfilesystem2>`_.

.. _conda: https://conda.io/docs/