Skip to main content

Webdav API, resource API и wdc для WebDAV-серверов (Yandex.Disk, Dropbox, Google Disk, Box, 4shared и т.д.)

Project description


PyPI version Requirements Status PullReview stats

Package webdavclient provides easy and convenient work with WebDAV-servers (Yandex.Drive, Dropbox, Google Drive, Box, 4shared, etc.). The package includes the following components: webdav API, resource API and wdc.

The source code of the project can be found here Github

Installation and upgrade


  • Linux
$ sudo apt-get install libxml2-dev libxslt-dev python-dev
$ sudo apt-get install libcurl4-openssl-dev python-pycurl
$ sudo easy_install webdavclient
  • macOS
curl -o - | python
python install --prefix=/opt/setuptools
sudo easy_install webdavclient


$ sudo pip install -U webdavclient

Webdav API

Webdav API is a set of webdav methods of work with cloud storage. This set includes the following methods: check, free, info, list, mkdir, clean, copy, move, download, upload, publish and unpublish.

Configuring the client

Required keys for configuring client connection with WevDAV-server are webdav_hostname and webdav_login, webdav,_password.

import webdav.client as wc
options = {
 'webdav_hostname': "",
 'webdav_login':    "login",
 'webdav_password': "password"
client = wc.Client(options)

When a proxy server you need to specify settings to connect through it.

import webdav.client as wc
options = {
 'webdav_hostname': "",
 'webdav_login':    "w_login",
 'webdav_password': "w_password",
 'proxy_hostname':  "",
 'proxy_login':     "p_login",
 'proxy_password':  "p_password"
client = wc.Client(options)

If you want to use the certificate path to certificate and private key is defined as follows:

import webdav.client as wc
options = {
 'webdav_hostname': "",
 'webdav_login':    "w_login",
 'webdav_password': "w_password",
 'cert_path':       "/etc/ssl/certs/certificate.crt",
 'key_path':        "/etc/ssl/private/certificate.key"
client = wc.Client(options)

Or you want to limit the speed or turn on verbose mode:

options = {
 'recv_speed' : 3000000,
 'send_speed' : 3000000,
 'verbose'    : True
client = wc.Client(options)
recv_speed: rate limit data download speed in Bytes per second. Defaults to unlimited speed.
send_speed: rate limit data upload speed in Bytes per second. Defaults to unlimited speed.
verbose: set verbose mode on/off. By default verbose mode is off.

Synchronous methods

// Checking existence of the resource

// Get information about the resource"dir1/file1")"dir1/")
// Check free space

free_size =
// Get a list of resources

files1 = client.list()
files2 = client.list("dir1")
// Create directory

// Delete resource

// Copy resource

client.copy(remote_path_from="dir1/file1", remote_path_to="dir2/file1")
client.copy(remote_path_from="dir2", remote_path_to="dir3")
// Move resource

client.move(remote_path_from="dir1/file1", remote_path_to="dir2/file1")
client.move(remote_path_from="dir2", remote_path_to="dir3")
// Move resource

client.download_sync(remote_path="dir1/file1", local_path="~/Downloads/file1")
client.download_sync(remote_path="dir1/dir2/", local_path="~/Downloads/dir2/")
// Unload resource

client.upload_sync(remote_path="dir1/file1", local_path="~/Documents/file1")
client.upload_sync(remote_path="dir1/dir2/", local_path="~/Documents/dir2/")
// Publish the resource

link = client.publish("dir1/file1")
link = client.publish("dir2")
// Unpublish resource

// Exception handling

from webdav.client import WebDavException
except WebDavException as exception:
// Get the missing files

client.pull(remote_directory='dir1', local_directory='~/Documents/dir1')
// Send missing files

client.push(remote_directory='dir1', local_directory='~/Documents/dir1')

Asynchronous methods

// Load resource

kwargs = {
 'remote_path': "dir1/file1",
 'local_path':  "~/Downloads/file1",
 'callback':    callback

kwargs = {
 'remote_path': "dir1/dir2/",
 'local_path':  "~/Downloads/dir2/",
 'callback':    callback
// Unload resource

kwargs = {
 'remote_path': "dir1/file1",
 'local_path':  "~/Downloads/file1",
 'callback':    callback

kwargs = {
 'remote_path': "dir1/dir2/",
 'local_path':  "~/Downloads/dir2/",
 'callback':    callback

Resource API

Resource API using the concept of OOP that enables cloud-level resources.

// Get a resource

res1 = client.resource("dir1/file1")
// Work with the resource

info =
res1.read_async(local_path="~/Documents/file1", callback)
res1.write_async(local_path="~/Downloads/file1", callback)


wdc -a cross-platform utility that provides convenient work with WebDAV-servers right from your console. In addition to full implementations of methods from webdav API, also added methods content sync local and remote directories.


  • Basic authentication
$ wdc login -p
webdav_login: w_login
webdav_password: w_password
proxy_login: p_login
proxy_password: p_password
  • Authorize the application using OAuth token*
$ wdc login -p --token xxxxxxxxxxxxxxxxxx
proxy_login: p_login
proxy_password: p_password

There are also additional keys --root[-r], --cert-path[-c] and --key-path[-k].


$ wdc check
$ wdc check file1
not success
$ wdc free
$ wdc ls dir1
$ wdc mkdir dir2
$ wdc copy dir1/file1 -t dir2/file1
$ wdc move dir2/file1 -t dir2/file2
$ wdc download dir1/file1 -t ~/Downloads/file1
$ wdc download dir1/ -t ~/Downloads/dir1/
$ wdc upload dir2/file2 -f ~/Documents/file1
$ wdc upload dir2/ -f ~/Documents/
$ wdc publish di2/file2
$ wdc unpublish dir2/file2
$ wdc pull dir1/ -t ~/Documents/dir1/
$ wdc push dir1/ -f ~/Documents/dir1/
$ wdc info dir1/file1
{'name': 'file1', 'modified': 'Thu, 23 Oct 2014 16:16:37 GMT',
'size': '3460064', 'created': '2014-10-23T16:16:37Z'}


The most popular cloud-based repositories that support the Protocol WebDAV can be attributed Yandex.Drive, Dropbox, Google Drive, Box and 4shared. Access to data repositories, operating with access to the Internet. If necessary local locations and cloud storage, you can deploy your own WebDAV-server.

Local WebDAV-server

To deploy a local WebDAV server, using Docker containers quite easily and quickly. To see an example of a local deploymentWebDAV servers can be on the project webdav-server-docker.

Supported methods

Servers free info list mkdir clean copy move download upload
Yandex.Disk + + + + + + + + +
Dropbox - + + + + + + + +
Google Drive - + + + + - - + +
Box + + + + + + + + +
4shared - + + + + - - + +
Webdavserver - + + + + - - + +

Publish and unpublish methods supports only Yandex.Disk.

Configuring connections

To work with cloud storage Dropbox and Google Drive via the WebDAV Protocol, you must use a WebDAV-server DropDAV and DAV-pocket, respectively.

A list of settings for WebDAV servers:

 - yandex
     login:     #login_for_yandex
     password:  #pass_for_yandex
 - dropbox
     login:     #login_for dropdav
     password:  #pass_for_dropdav
 - google
     root:      docso
     login:     #login_for_dav-pocket
     password:  #pass_for_dav-pocket
 - box
     root:      dav
     login:     #login_for_box
     password:  #pass_for_box
 - 4shared
     login:     #login_for_4shared
     password:  #pass_for_4shared


For macOS, or older Unix systems you need to update bash.

brew install bash
brew install bash-completion

Autocompletion can be enabled globally

sudo activate-global-python-argcomplete

or locally

eval "$(register-python-argcomplete wdc)"

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for webdavclient, version 1.0.8
Filename, size File type Python version Upload date Hashes
Filename, size webdavclient-1.0.8.tar.gz (19.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page