| Name | webdav4 JSON |
| Version |
0.10.0
JSON |
| download |
| home_page | None |
| Summary | WebDAV client library with an fsspec-based filesystem and a CLI |
| upload_time | 2024-07-13 19:42:42 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
fsspec
webdav
webdav-cli
webdav-client
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# webdav4
[](https://pypi.org/project/webdav4)
[](https://anaconda.org/conda-forge/webdav4)
[](https://pypi.org/project/webdav4)
[](https://pypi.org/project/webdav4)
Webdav API with an (optional) [fsspec](#fsspec) implementation and a [CLI](#cli).
## 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.
#### CLI
webdav4 also provides a CLI similar to `aws s3` to make it easier to work with webdav servers.
Please checkout [CLI Usage](docs/reference/cli.md) for more information.
### Contributing
Contributions are welcome. Please take a look at
[Contributing Guide](CONTRIBUTING.md) for more details.
Raw data
{
"_id": null,
"home_page": null,
"name": "webdav4",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "fsspec, webdav, webdav-cli, webdav-client",
"author": null,
"author_email": "Saugat Pachhai <suagatchhetri@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/08/3d/d604f9d5195689e578f124f196a5d7e80f3106c8404f5c19b2181691de19/webdav4-0.10.0.tar.gz",
"platform": null,
"description": "# webdav4\n[](https://pypi.org/project/webdav4)\n[](https://anaconda.org/conda-forge/webdav4)\n[](https://pypi.org/project/webdav4)\n[](https://pypi.org/project/webdav4)\n\n\nWebdav API with an (optional) [fsspec](#fsspec) implementation and a [CLI](#cli).\n\n## Installation\n\n```console\n$ pip install webdav4\n```\n\n### Usage\n\n#### webdav4 Client\n```python\nfrom webdav4.client import Client\n\nclient = Client(\"https://webdav.com\", auth=(\"username\", \"password\"))\nclient.exists(\"Documents/Readme.md\")\n\nclient.ls(\"Photos\", detail=False)\nclient.upload_file(\"Gorilla.jpg\", \"Photos/Gorilla.jpg\")\n```\n\nCheck out [Client API](docs/reference/client.md) reference for more information.\n\n\n\n#### fsspec\n\n[`fsspec`](https://filesystem-spec.readthedocs.io) tries to provide a\nconsistent APIs to different storage backends, by defining standard\ninterfaces, so that other code using them could operate without depending\non the implementations of the backends. This package, in the same way,\nwraps the above [webdav client](#webdav4-client) with a consistent file-system API.\n\n\nTo use it, you need to install `fsspec` additionally which you can do as\nfollows:\n\n```console\n$ pip install webdav4[fsspec]\n```\n\n```python\nfrom webdav4.fsspec import WebdavFileSystem\n\nfs = WebdavFileSystem(\"https://webdav.com\", auth=(\"username\", \"password\"))\nfs.exists(\"Documents/Readme.md\")\n\nfs.ls(\"Photos\", detail=False)\n```\n\nCheck out [WebdavFileSystem API](docs/reference/fsspec.md) reference for more information.\n\n\n#### CLI\n\nwebdav4 also provides a CLI similar to `aws s3` to make it easier to work with webdav servers.\n\n\nPlease checkout [CLI Usage](docs/reference/cli.md) for more information.\n\n### Contributing\n\nContributions are welcome. Please take a look at\n[Contributing Guide](CONTRIBUTING.md) for more details.\n",
"bugtrack_url": null,
"license": null,
"summary": "WebDAV client library with an fsspec-based filesystem and a CLI",
"version": "0.10.0",
"project_urls": {
"Bug Tracker": "https://github.com/skshetry/webdav4/issues",
"Documentation": "https://skshetry.github.io/webdav4",
"Source Code": "https://github.com/skshetry/webdav4"
},
"split_keywords": [
"fsspec",
" webdav",
" webdav-cli",
" webdav-client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "60021b77232297fa52f7bedcf70f3ebe3817e9295f302389fb57dd0e6c077329",
"md5": "3bfd8f817a74ccbb7e0106b08a07a867",
"sha256": "8f915d72483e572089a3af0a2ad20c7e12d04eee9b9134eb718dbfa37af221d8"
},
"downloads": -1,
"filename": "webdav4-0.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3bfd8f817a74ccbb7e0106b08a07a867",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 36350,
"upload_time": "2024-07-13T19:42:41",
"upload_time_iso_8601": "2024-07-13T19:42:41.087316Z",
"url": "https://files.pythonhosted.org/packages/60/02/1b77232297fa52f7bedcf70f3ebe3817e9295f302389fb57dd0e6c077329/webdav4-0.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "083dd604f9d5195689e578f124f196a5d7e80f3106c8404f5c19b2181691de19",
"md5": "28695af107788db18db7e0a1f48183f6",
"sha256": "387da6f0ee384e77149dddd9bcfd434afa155882f6c440a529a7cb458624407f"
},
"downloads": -1,
"filename": "webdav4-0.10.0.tar.gz",
"has_sig": false,
"md5_digest": "28695af107788db18db7e0a1f48183f6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 229195,
"upload_time": "2024-07-13T19:42:42",
"upload_time_iso_8601": "2024-07-13T19:42:42.593082Z",
"url": "https://files.pythonhosted.org/packages/08/3d/d604f9d5195689e578f124f196a5d7e80f3106c8404f5c19b2181691de19/webdav4-0.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-13 19:42:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "skshetry",
"github_project": "webdav4",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "webdav4"
}
