Metadata-Version: 2.1
Name: aioeasywebdav
Version: 2.4.0
Summary: A straight-forward WebDAV client, ported from easywebdav to use aiohttp.
Home-page: https://gitlab.com/alelec/aioeasywebdav
Author: Andrew Leech
Author-email: andrew@alelec.net
License: ISC
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.5
License-File: LICENSE
Requires-Dist: aiohttp
Requires-Dist: six
Requires-Dist: setuptools-scm

aioEasyWebDAV: A WebDAV Client for asyncio
==========================================

This project started as a port of the requests-based EasyWebDAV (
http://github.com/amnong/easywebdav ) to asyncio on Python 3.5. It has
since been extended with additional features.

Features
--------

-  Basic authentication
-  Creating directories, removing directories and files
-  Uploading and downloading files
-  Directory listing
-  Support for client side SSL certificates
-  Fragmented download (multiple chunks in simultaneous streams)
-  MD5 checksum validation when used with OwnCloud/Nextcloud webdav
-  Progress tracking/reporting via callback system

Installation
------------

Install using distribute:

::

    pip install aioeasywebdav

Quick Start
-----------

::

    import aioeasywebdav
    loop = asyncio.get_event_loop()

    # Start off by creating a client object. Username and
    # password may be omitted if no authentication is needed.
    webdav = aioeasywebdav.connect('webdav.your-domain.com', username='myuser', password='mypass')

    # Do some stuff:
    loop.run_until_complete(webdav.mkdir('some_dir'))
    loop.run_until_complete(webdav.rmdir('another_dir'))

    async def fn():
        await webdav.download('/remote/path/to/file', '/local/target/file')
        await webdav.upload('/local/path/to/file', '/remote/target/file')
    loop.run_until_complete(fn())

Client object API
-----------------

The API is pretty much self-explanatory:

::

    cd(path)
    ls(path=None)
    exists(remote_path)
    mkdir(path, safe=False)
    mkdirs(path)
    rmdir(path, safe=False)
    delete(file_path)
    upload(local_path_or_fileobj, remote_path)
    download(remote_path, local_path)

Using clientside SSL certificate
--------------------------------

::

    webdav = aioeasywebdav.connect('secure.example.net',
                                   username='user',
                                   password='pass',
                                   protocol='https',
                                   cert="/path/to/your/certificate.pem")
    # Do some stuff:
    print(await webdav.ls())

Please note that all options and restriction regarding the "cert"
parameter from `Requests
API <http://docs.python-requests.org/en/latest/api/>`__ apply here as
the parameter is only passed through!

Developing aioEasyWebDAV
------------------------

Working with a virtual environment is highly recommended:

::

    virtualenv --no-site-packages aioeasywebdav_dev
    source aioeasywebdav_dev/bin/activate

Installing the library in development-mode:

::

    EASYWEBDAV_DEV=1 python setup.py develop

The first part of the command causes setup.py to install development
dependencies, in addition to the normal dependencies.

Running the tests:

::

    nosetests --with-yanc --nologcapture --nocapture tests

Running the tests with WebDAV server logs:

::

    WEBDAV_LOGS=1 nosetests --with-yanc --nologcapture --nocapture -v tests