{"id":26060483,"url":"https://github.com/jpbede/aiowebdav2","last_synced_at":"2026-03-02T09:03:59.689Z","repository":{"id":276677630,"uuid":"929945709","full_name":"jpbede/aiowebdav2","owner":"jpbede","description":"Async Python 3 client for WebDAV","archived":false,"fork":false,"pushed_at":"2025-04-07T06:02:42.000Z","size":391,"stargazers_count":0,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-07T07:22:18.887Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jpbede.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"jpbede","custom":["https://www.buymeacoffee.com/janphilipp_bnck"]}},"created_at":"2025-02-09T19:00:04.000Z","updated_at":"2025-04-07T06:02:45.000Z","dependencies_parsed_at":"2025-02-09T20:19:41.312Z","dependency_job_id":"a13499d7-9010-466e-a7b4-ad8e178d3b58","html_url":"https://github.com/jpbede/aiowebdav2","commit_stats":null,"previous_names":["jpbede/aiowebdav2"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpbede%2Faiowebdav2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpbede%2Faiowebdav2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpbede%2Faiowebdav2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpbede%2Faiowebdav2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jpbede","download_url":"https://codeload.github.com/jpbede/aiowebdav2/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247609049,"owners_count":20966106,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-08T14:08:28.404Z","updated_at":"2026-03-02T09:03:59.611Z","avatar_url":"https://github.com/jpbede.png","language":"Python","funding_links":["https://github.com/sponsors/jpbede","https://www.buymeacoffee.com/janphilipp_bnck"],"categories":[],"sub_categories":[],"readme":"aiowebdav2\n=========\n[![GitHub Release][releases-shield]][releases]\n[![Python Versions][python-versions-shield]][pypi]\n![Project Stage][project-stage-shield]\n![Project Maintenance][maintenance-shield]\n[![License][license-shield]](LICENSE.md)\n\n[![Build Status][build-shield]][build]\n[![Code Coverage][codecov-shield]][codecov]\n\n`aiowebdav2` is an asyncio based Python 3 client for WebDAV.\n\nIt is based on https://github.com/designerror/webdav-client-python and https://github.com/synodriver/aiowebdav.\n\nInstallation\n------------\n```bash\n$ pip install aiowebdav2\n```\n\nSample Usage\n------------\n\n```python\nimport asyncio\nfrom aiowebdav2.client import Client\n\noptions = {\n 'webdav_hostname': \"https://webdav.server.ru\",\n 'webdav_login': \"login\",\n 'webdav_password': \"password\",\n \"disable_check\": True\n}\n\nasync def main():\n    client = Client(options)\n    client.verify = False  # To not check SSL certificates (Default = True)\n    await client.execute_request(\"mkdir\", 'directory_name')\nasyncio.run(main())\n```\n\nWebdav API\n==========\n\nWebdav API is a set of webdav actions of work with cloud storage. This set includes the following actions:\n`check`, `free`, `info`, `list`, `mkdir`, `clean`, `copy`, `move`, `download`, `upload`, `publish` and `unpublish`.\n\n**Configuring the client**\n\nRequired key is host name or IP address of the WevDAV-server with param name `webdav_hostname`.\nFor authentication in WebDAV server use `webdav_login`, `webdav_password`.\nFor an anonymous login do not specify auth properties.\n\n```python\nfrom aiowebdav2.client import Client\n\noptions = {\n 'webdav_hostname': \"https://webdav.server.ru\",\n 'webdav_login': \"login\",\n 'webdav_password': \"password\"\n}\nclient = Client(options)\n```\n\nIf 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`.\nThe key should be in the following list: `check`, `free`, `info`, `list`, `mkdir`, `clean`, `copy`, `move`, `download`, `upload`,\n `publish` and `unpublish`. The value should a string name of WebDAV method, for example `GET`.\n\n```python\nfrom aiowebdav2.client import Client\n\noptions = {\n 'webdav_hostname': \"https://webdav.server.ru\",\n 'webdav_login': \"login\",\n 'webdav_password': \"password\",\n 'webdav_override_methods': {\n  'check': 'GET'\n }\n\n}\nclient = Client(options)\n```\n\nFor 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.\n\n```python\nfrom aiowebdav2.client import Client\n\noptions = {\n 'webdav_hostname': \"https://webdav.server.ru\",\n 'webdav_login': \"login\",\n 'webdav_password': \"password\",\n 'webdav_timeout': 30\n}\nclient = Client(options)\n```\n\nWhen a proxy server you need to specify settings to connect through it.\n\n```python\nfrom aiowebdav2.client import Client\n\noptions = {\n 'webdav_hostname': \"https://webdav.server.ru\",\n 'webdav_login': \"w_login\",\n 'webdav_password': \"w_password\",\n 'webdav_proxy': \"http://127.0.0.1:8080\",\n 'webdav_proxy_auth': \"xxx\",\n}\nclient = Client(options)\n```\n\nIf you want to use the certificate path to certificate and private key is defined as follows:\n\n```python\nfrom aiowebdav2.client import Client\n\noptions = {\n 'webdav_hostname': \"https://webdav.server.ru\",\n 'webdav_login': \"w_login\",\n 'webdav_password': \"w_password\",\n 'webdav_ssl': 'sslcontext'\n}\nclient = Client(options)\n```\n\nOr you want to limit the speed or turn on verbose mode:\n\n```python\noptions = {\n ...\n 'recv_speed' : 3000000,\n 'send_speed' : 3000000,\n 'verbose'    : True\n}\nclient = Client(options)\n```\n\nrecv_speed: rate limit data download speed in Bytes per second. Defaults to unlimited speed.\nsend_speed: rate limit data upload speed in Bytes per second. Defaults to unlimited speed.\nverbose:    set verbose mode on/off. By default verbose mode is off.\n\nAlso if your server does not support `check` it is possible to disable it:\n\n```python\noptions = {\n ...\n 'disable_check': True\n}\nclient = Client(options)\n```\n\nBy default, checking of remote resources is enabled.\n\nFor configuring chunk size of content downloading use `chunk_size` param, by default it is `65536`\n\n```python\noptions = {\n ...\n 'chunk_size': 65536\n}\nclient = Client(options)\n```\n\n**Asynchronous methods**\n\n```python\n# Checking existence of the resource\n\nawait client.check(\"dir1/file1\")\nawait client.check(\"dir1\")\n```\n\n```python\n# Get information about the resource\n\nawait client.info(\"dir1/file1\")\nawait client.info(\"dir1/\")\n```\n\n```python\n# Check free space\n\nfree_size = await client.free()\n```\n\n```python\n# Get a list of resources\n\nfiles1 = await client.list()\nfiles2 = await client.list(\"dir1\")\nfiles3 = await client.list(\"dir1\", get_info=True) # returns a list of dictionaries with files details\n```\n\n```python\n# Create directory\n\nawait client.mkdir(\"dir1/dir2\")\n```\n\n```python\n# Delete resource\n\nawait client.clean(\"dir1/dir2\")\n```\n\n```python\n# Copy resource\n\nawait client.copy(remote_path_from=\"dir1/file1\", remote_path_to=\"dir2/file1\")\nawait client.copy(remote_path_from=\"dir2\", remote_path_to=\"dir3\")\n```\n\n```python\n# Move resource\n\nawait client.move(remote_path_from=\"dir1/file1\", remote_path_to=\"dir2/file1\")\nawait client.move(remote_path_from=\"dir2\", remote_path_to=\"dir3\")\n```\n\n```python\n# Download a resource\n\nawait client.download(remote_path=\"dir1/file1\", local_path=\"~/Downloads/file1\")\nawait client.download(remote_path=\"dir1/dir2/\", local_path=\"~/Downloads/dir2/\")\n```\n\n```python\n# Upload resource\n\nawait client.upload(remote_path=\"dir1/file1\", local_path=\"~/Documents/file1\")\nawait client.upload(remote_path=\"dir1/dir2/\", local_path=\"~/Documents/dir2/\")\n```\n\n```python\n# Publish the resource\n\nlink = await client.publish(\"dir1/file1\")\nlink = await client.publish(\"dir2\")\n```\n\n```python\n# Unpublish resource\n\nawait client.unpublish(\"dir1/file1\")\nawait client.unpublish(\"dir2\")\n```\n\n```python\n# Exception handling\n\nfrom aiowebdav.exceptions import WebDavException\n\ntry:\n ...\nexcept WebDavException as exception:\n...\n```\n\n```python\n# Get the missing files\n\nawait client.pull(remote_directory='dir1', local_directory='~/Documents/dir1')\n```\n\n```python\n# Send missing files\n\nawait client.push(remote_directory='dir1', local_directory='~/Documents/dir1')\n```\n\n```python\n# Unload resource\n\nkwargs = {\n 'remote_path': \"dir1/file1\",\n 'local_path':  \"~/Downloads/file1\",\n 'callback':    callback\n}\nclient.upload_async(**kwargs)\n\nkwargs = {\n 'remote_path': \"dir1/dir2/\",\n 'local_path':  \"~/Downloads/dir2/\",\n 'callback':    callback\n}\nclient.upload_async(**kwargs)\n```\n\nResource API\n============\n\nResource API using the concept of OOP that enables cloud-level resources.\n\n```python\n# Get a resource\n\nres1 = client.resource(\"dir1/file1\")\n```\n\n```python\n# Work with the resource\n\nawait res1.rename(\"file2\")\nawait res1.move(\"dir1/file2\")\nawait res1.copy(\"dir2/file1\")\ninfo = await res1.info()\nawait res1.read_from(buffer)\nawait res1.read(local_path=\"~/Documents/file1\")\nawait res1.write_to(buffer)\nawait res1.write(local_path=\"~/Downloads/file1\")\n\n```\n\n## Changelog \u0026 Releases\n\nThis repository keeps a change log using [GitHub's releases][releases]\nfunctionality. The format of the log is based on\n[Keep a Changelog][keepchangelog].\n\nReleases are based on [Semantic Versioning][semver], and use the format\nof `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented\nbased on the following:\n\n- `MAJOR`: Incompatible or major changes.\n- `MINOR`: Backwards-compatible new features and enhancements.\n- `PATCH`: Backwards-compatible bugfixes and package updates.\n\n## Contributing\n\nThis is an active open-source project. I am always open to people who want to\nuse the code or contribute to it.\n\nThank you for being involved! :heart_eyes:\n\n## Setting up development environment\n\nThis Python project is fully managed using the [Poetry][poetry] dependency manager. But also relies on the use of NodeJS for certain checks during development.\n\nYou need at least:\n\n- Python 3.11+\n- [Poetry][poetry-install]\n- NodeJS 20+ (including NPM)\n\nTo install all packages, including all development requirements:\n\n```bash\nnpm install\npoetry install\n```\n\nAs this repository uses the [pre-commit][pre-commit] framework, all changes\nare linted and tested with each commit. You can run all checks and tests\nmanually, using the following command:\n\n```bash\npoetry run pre-commit run --all-files\n```\n\nTo run just the Python tests:\n\n```bash\npoetry run pytest\n```\n\n## Authors \u0026 contributors\n\nThe content is by [Jan-Philipp Benecke][jpbede].\n\nFor a full list of all authors and contributors,\ncheck [the contributor's page][contributors].\n\n## License\n\nMIT License\n\nCopyright (c) 2025 Jan-Philipp Benecke\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n[build-shield]: https://github.com/jpbede/aiowebdav2/actions/workflows/release.yml/badge.svg\n[build]: https://github.com/jpbede/aiowebdav2/actions\n[codecov-shield]: https://codecov.io/gh/jpbede/aiowebdav2/branch/main/graph/badge.svg\n[codecov]: https://codecov.io/gh/jpbede/aiowebdav2\n[commits-shield]: https://img.shields.io/github/commit-activity/y/jpbede/aiowebdav2.svg\n[commits]: https://github.com/jpbede/aiowebdav2/commits/main\n[contributors]: https://github.com/jpbede/aiowebdav2/graphs/contributors\n[jpbede]: https://github.com/jpbede\n[keepchangelog]: http://keepachangelog.com/en/1.0.0/\n[license-shield]: https://img.shields.io/github/license/jpbede/aiowebdav2.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2025.svg\n[poetry-install]: https://python-poetry.org/docs/#installation\n[poetry]: https://python-poetry.org\n[pre-commit]: https://pre-commit.com/\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-stable-green.svg\n[python-versions-shield]: https://img.shields.io/pypi/pyversions/aiowebdav2\n[releases-shield]: https://img.shields.io/github/release/jpbede/aiowebdav2.svg\n[releases]: https://github.com/jpbede/aiowebdav2/releases\n[semver]: http://semver.org/spec/v2.0.0.html\n[pypi]: https://pypi.org/project/aiowebdav2/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpbede%2Faiowebdav2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjpbede%2Faiowebdav2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpbede%2Faiowebdav2/lists"}