diff --git a/.gitignore b/.gitignore index d601571..8a735d4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ *.pyc test +dist +*.egg-info diff --git a/pytahoe/__init__.py b/pytahoe/__init__.py index fc84f2d..29a6083 100644 --- a/pytahoe/__init__.py +++ b/pytahoe/__init__.py @@ -195,7 +195,11 @@ class Filesystem: raise ObjectException("Could not attach object - the request failed with code %d." % result.status_code) class Directory: - """Represents a directory node in a Tahoe-LAFS grid.""" + """Represents a directory node in a Tahoe-LAFS grid. + + Properties: + children -- A dictionary of File and Directory objects, with their name as key. + """ mutable = False writeable = False children = {} diff --git a/setup.py b/setup.py index a328c6e..1e61bff 100644 --- a/setup.py +++ b/setup.py @@ -3,9 +3,27 @@ from setuptools import setup setup(name='pytahoe', version='1.0', description='Python module for working with the Tahoe-LAFS filesystem.', + long_description=''' + This module allows for easy interaction with a Tahoe-LAFS grid, via the WebAPI. + + Current functionality includes: + * Retrieving information about files and directories + * Creating directories and subdirectories + * Uploading immutable files + * Attaching files or subdirectories to directories + * Mounting a directory to a mountpoint via FUSE or dokan + * Retrieving files + + Functionality that is currently notably absent, but will be added in the future: + * Verifying and repairing objects + * Renewing share leases + * Deleting files from directories + * Uploading of mutable files (SDMF and MDMF) + ''', author='Sven Slootweg', author_email='pytahoe@cryto.net', url='http://cryto.net/pytahoe', packages=['pytahoe'], - provides=['pytahoe'] + provides=['pytahoe'], + requires=['fs', 'requests'] )