Metadata-Version: 2.1
Name: webdavclient3
Version: 3.14.5
Summary: WebDAV client, based on original package https://github.com/designerror/webdav-client-python but uses requests instead of PyCURL
Home-page: https://github.com/ezhov-evgeny/webdav-client-python-3
Author: Evgeny Ezhov
Author-email: ezhov.evgeny@gmail.com
License: MIT License
Description: Python WebDAV Client 3
        =========
        [![Build Status](https://travis-ci.com/ezhov-evgeny/webdav-client-python-3.svg?branch=develop)](https://travis-ci.com/ezhov-evgeny/webdav-client-python-3)
        [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ezhov-evgeny_webdav-client-python-3&metric=alert_status)](https://sonarcloud.io/dashboard?id=ezhov-evgeny_webdav-client-python-3)
        [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=ezhov-evgeny_webdav-client-python-3&metric=coverage)](https://sonarcloud.io/dashboard?id=ezhov-evgeny_webdav-client-python-3)
        [![PyPI](https://img.shields.io/pypi/v/webdavclient3)](https://pypi.org/project/webdavclient3/) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/webdavclient3)  
        
        Package webdavclient3 based on https://github.com/designerror/webdav-client-python but uses `requests` instead of `PyCURL`.
        It provides easy way to work with WebDAV-servers.
        
        Installation
        ------------
        ```bash
        $ pip install webdavclient3
        ```
        
        Sample Usage
        ------------
        ```python
        from webdav3.client import Client
        options = {
         'webdav_hostname': "https://webdav.server.ru",
         'webdav_login':    "login",
         'webdav_password': "password"
        }
        client = Client(options)
        client.verify = False # To not check SSL certificates (Default = True)
        client.session.proxies(...) # To set proxy directly into the session (Optional)
        client.session.auth(...) # To set proxy auth directly into the session (Optional)
        client.execute_request("mkdir", 'directory_name')
        ```
        
        Webdav API
        ==========
        
        Webdav API is a set of webdav actions of work with cloud storage. This set includes the following actions:
        `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`.
        
        ```python
        from webdav3.client import Client
        
        options = {
         'webdav_hostname': "https://webdav.server.ru",
         'webdav_login':    "login",
         'webdav_password': "password"
        }
        client = Client(options)
        ```
        
        If your server does not support `HEAD` method or there are other reasons to override default WebDAV methods for actions use a dictionary option `webdav_override_methods`. 
        The key should be in the following list: `check`, `free`, `info`, `list`, `mkdir`, `clean`, `copy`, `move`, `download`, `upload`,
         `publish` and `unpublish`. The value should a string name of WebDAV method, for example `GET`.
         
        ```python
        from webdav3.client import Client
        
        options = {
         'webdav_hostname': "https://webdav.server.ru",
         'webdav_login':    "login",
         'webdav_password': "password",
         'webdav_override_methods': {
                    'check': 'GET'
                }
        
        }
        client = Client(options)
        ```
        
        For configuring a requests timeout you can use an option `webdav_timeout` with int value in seconds, by default the timeout is set to 30 seconds.
        
        ```python
        from webdav3.client import Client
        
        options = {
         'webdav_hostname': "https://webdav.server.ru",
         'webdav_login':    "login",
         'webdav_password': "password",
         'webdav_timeout': 30
        }
        client = Client(options)
        ```
        
        When a proxy server you need to specify settings to connect through it.
        
        ```python
        from webdav3.client import Client
        options = {
         'webdav_hostname': "https://webdav.server.ru",
         'webdav_login':    "w_login",
         'webdav_password': "w_password", 
         'proxy_hostname':  "http://127.0.0.1:8080",
         'proxy_login':     "p_login",
         'proxy_password':  "p_password"
        }
        client = Client(options)
        ```
        
        If you want to use the certificate path to certificate and private key is defined as follows:
        
        ```python
        from webdav3.client import Client
        options = {
         'webdav_hostname': "https://webdav.server.ru",
         'webdav_login':    "w_login",
         'webdav_password': "w_password",
         'cert_path':       "/etc/ssl/certs/certificate.crt",
         'key_path':        "/etc/ssl/private/certificate.key"
        }
        client = Client(options)
        ```
        
        Or you want to limit the speed or turn on verbose mode:
        
        ```python
        options = {
         ...
         'recv_speed' : 3000000,
         'send_speed' : 3000000,
         'verbose'    : True
        }
        client = 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.
        
        Also if your server does not support `check` it is possible to disable it:
        
        ```python
        options = {
         ...
         'disable_check': True
        }
        client = Client(options)
        ```
        
        By default checking of remote resources is enabled.
        
        **Synchronous methods**
        
        ```python
        # Checking existence of the resource
        
        client.check("dir1/file1")
        client.check("dir1")
        ```
        
        ```python
        # Get information about the resource
        
        client.info("dir1/file1")
        client.info("dir1/")
        ```
        
        ```python
        # Check free space
        
        free_size = client.free()
        ```
        
        ```python
        # Get a list of resources
        
        files1 = client.list()
        files2 = client.list("dir1")
        files3 = client.list("dir1", get_info=True) # returns a list of dictionaries with files details
        ```
        
        ```python
        # Create directory
        
        client.mkdir("dir1/dir2")
        ```
        
        ```python
        # Delete resource
        
        client.clean("dir1/dir2")
        ```
        
        ```python
        # Copy resource
        
        client.copy(remote_path_from="dir1/file1", remote_path_to="dir2/file1")
        client.copy(remote_path_from="dir2", remote_path_to="dir3")
        ```
        
        ```python
        # Move resource
        
        client.move(remote_path_from="dir1/file1", remote_path_to="dir2/file1")
        client.move(remote_path_from="dir2", remote_path_to="dir3")
        ```
        
        ```python
        # Move resource
        
        client.download_sync(remote_path="dir1/file1", local_path="~/Downloads/file1")
        client.download_sync(remote_path="dir1/dir2/", local_path="~/Downloads/dir2/")
        ```
        
        ```python
        # Unload resource
        
        client.upload_sync(remote_path="dir1/file1", local_path="~/Documents/file1")
        client.upload_sync(remote_path="dir1/dir2/", local_path="~/Documents/dir2/")
        ```
        
        ```python
        # Publish the resource
        
        link = client.publish("dir1/file1")
        link = client.publish("dir2")
        ```
        
        ```python
        # Unpublish resource
        
        client.unpublish("dir1/file1")
        client.unpublish("dir2")
        ```
        
        ```python
        # Exception handling
        
        from webdav3.client import WebDavException
        try:
        ...
        except WebDavException as exception:
        ...
        ```
        
        ```python
        # Get the missing files
        
        client.pull(remote_directory='dir1', local_directory='~/Documents/dir1')
        ```
        
        ```python
        # Send missing files
        
        client.push(remote_directory='dir1', local_directory='~/Documents/dir1')
        ```
        
        **Asynchronous methods**
        
        ```python
        # Load resource
        
        kwargs = {
         'remote_path': "dir1/file1",
         'local_path':  "~/Downloads/file1",
         'callback':    callback
        }
        client.download_async(**kwargs)
        
        kwargs = {
         'remote_path': "dir1/dir2/",
         'local_path':  "~/Downloads/dir2/",
         'callback':    callback
        }
        client.download_async(**kwargs)
        ```
        
        ```python
        # Unload resource
        
        kwargs = {
         'remote_path': "dir1/file1",
         'local_path':  "~/Downloads/file1",
         'callback':    callback
        }
        client.upload_async(**kwargs)
        
        kwargs = {
         'remote_path': "dir1/dir2/",
         'local_path':  "~/Downloads/dir2/",
         'callback':    callback
        }
        client.upload_async(**kwargs)
        ```
        
        Resource API
        ============
        
        Resource API using the concept of OOP that enables cloud-level resources.
        
        ```python
        # Get a resource
        
        res1 = client.resource("dir1/file1")
        ```
        
        ```python
        # Work with the resource
        
        res1.rename("file2")
        res1.move("dir1/file2")
        res1.copy("dir2/file1")
        info = res1.info()
        res1.read_from(buffer)
        res1.read(local_path="~/Documents/file1")
        res1.read_async(local_path="~/Documents/file1", callback)
        res1.write_to(buffer)
        res1.write(local_path="~/Downloads/file1")
        res1.write_async(local_path="~/Downloads/file1", callback)
        ```
        
Keywords: webdav,client,python,module,library,packet,Yandex.Disk,Dropbox,Google Disk,Box,4shared
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires: python (>= 3.3.0)
Description-Content-Type: text/markdown
