Skip to main content

WebDAV client library with an fsspec-based filesystem and a CLI

Project description

webdav4

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Conda PyPi ci codecov

Webdav API with an (optional) fsspec implementation and a CLI.

Installation

$ pip install webdav4

Usage

webdav4 Client

from webdav4.client import Client

client = Client("https://webdav.com", auth=("username", "password"))
client.exists("Documents/Readme.md")

client.ls("Photos", detail=False)
client.upload_file("Gorilla.jpg", "Photos/Gorilla.jpg")

Check out Client API reference for more information.

fsspec

fsspec tries to provide a consistent APIs to different storage backends, by defining standard interfaces, so that other code using them could operate without depending on the implementations of the backends. This package, in the same way, wraps the above webdav client with a consistent file-system API.

To use it, you need to install fsspec additionally which you can do as follows:

$ pip install webdav4[fsspec]
from webdav4.fsspec import WebdavFileSystem

fs = WebdavFileSystem("https://webdav.com", auth=("username", "password"))
fs.exists("Documents/Readme.md")

fs.ls("Photos", detail=False)

Check out WebdavFileSystem API reference for more information.

CLI

webdav4 also provides a CLI similar to aws s3 to make it easier to work with webdav servers. cli-usage

Please checkout CLI Usage for more information.

Contributing

Contributions are welcome. Please take a look at Contributing Guide for more details.

Project details


Download files

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

Source Distribution

webdav4-0.9.8.tar.gz (229.2 kB view hashes)

Uploaded Source

Built Distribution

webdav4-0.9.8-py3-none-any.whl (36.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page