Giter VIP home page Giter VIP logo

aioeasywebdav's Introduction

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

aioeasywebdav's People

Contributors

amnong avatar andrewleech avatar ashleyhood avatar chadburrus avatar ciarang avatar frankkkkk avatar glader avatar kartoch avatar killerx avatar sscherfke avatar tebeka avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

sscherfke

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.