Metadata-Version: 2.1
Name: webdav4
Version: 0.4.0
Summary: UNKNOWN
Home-page: https://github.com/skshetry/webdav4
Maintainer: Saugat Pachhai
Maintainer-email: suagatchhetri@outlook.com
License: MIT
Project-URL: Documentation, https://skshetry.github.io/webdav4
Description: # webdav4
        
        [![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
        ![ci](https://github.com/skshetry/webdav4/workflows/CI/badge.svg)
        [![codecov](https://codecov.io/gh/skshetry/webdav4/branch/main/graph/badge.svg)](https://codecov.io/gh/skshetry/webdav4)
        
        Webdav API with an (optional) [fsspec](#fsspec) implementation
        
        ## Installation
        
        ```console
        $ pip install webdav4
        ```
        
        ### Usage
        
        #### webdav4 Client
        ```python
        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](docs/reference/client.md) reference for more information.
        
        
        
        #### fsspec
        
        [`fsspec`](https://filesystem-spec.readthedocs.io) 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](#webdav4-client) with a consistent file-system API.
        
        
        To use it, you need to install `fsspec` additionally which you can do as
        follows:
        
        ```console
        $ pip install webdav4[fsspec]
        ```
        
        ```python
        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](docs/reference/fsspec.md) reference for more information.
        
Keywords: webdav,webdav-client
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: fsspec
Provides-Extra: all
Provides-Extra: docs
Provides-Extra: qa
Provides-Extra: tests
Provides-Extra: dev
