# pydavsync
A command line to synchronize files with WebDav servers, written in Python.
## Name
The foundational idea was to have a similar command line and behavior to
[rsync](https://rsync.samba.org/), but for WebDav servers. `davsync` is the logical
name. But I started to implement it in Rust, then in Python, and I decided to integrate
the development language in the name. Thus `pydavsync` for the Python implementation.
## Description
[rsync](https://rsync.samba.org/) allows to synchronize files over a SSH connection.
[pydavsync](https://framagit.org/RomainTT/pydavsync/) has been developed to do the same
over a WebDav connection.
The command line is not identical because compatibility is not a goal, and some new
ideas emerged while developing `pydavsync`.
The following operations can be done :
- Synchronization from local filesystem to WebDav server
- Synchronization from WebDav server to local filesystem
- Synchronization from WebDav server to WebDav server (not necessarily the same)
Here are some of the features :
- dry run
- verbose output
- login/password given through command line options
- synchronization based on modified time and file size
- deletion when files disappear
### Webdav?
[Webdav](https://fr.wikipedia.org/wiki/WebDAV) is used to manage files on remote servers
using HTTP.
The primary motivation was to use `pydavsync` with [Nextcloud](https://nextcloud.com/)
which is compatible with webdav. But there are many other services accepting webdav.
## Installation
`pydavsync` is available on [Pypi.org](https://pypi.org/project/pydavsync) and can be
installed using `pip`. Many options are available to you, do as you please.
```
pip install pydavsync
```
## Usage
Once installed, the program `pydavsync` should be available in your terminal.
To get help, use `pydavsyncc --help`.
Here is an example to synchronize files from a webdav server to a local directory.
```sh
$ pydavsync --src-user Username --src-pass Password --verbose https://my-server.org/path/to/my/directory /path/to/local/directory
```
## Support
If you have a question or need help, please [open an issue](https://framagit.org/RomainTT/pydavsync/-/issues/new) and tag it with the ~support label.
## Roadmap
Future developments:
- Synchronization from local to webdav (and consequently from webdav to webdav)
- Smarter synchronization if source and destination are both the same webdav server.
- Better tests with mocks to simulate a webdav server.
- A [man](https://www.man7.org/linux/man-pages/man1/man.1.html) page.
- New and optional means to check if a file has changed or not.
## Contributing
- Firstly, you can open [a new issue](https://framagit.org/RomainTT/pydavsync/-/issues/new) if you find a bug or have an improvement idea.
- Any help to test the tool on various systems and Webdav servers is appreciated, as I did not checked many of these myself.
- If you feel like coding, please [fork](https://framagit.org/RomainTT/pydavsync/-/forks/new) the repository and do a [merge request](https://framagit.org/RomainTT/pydavsync/-/merge_requests). It will be reviewed. Don’t forget to mention issues in your comments if you fix some of them!
## Authors and acknowledgment
Main author: Romain TAPREST [✉](mailto:romain@taprest.fr)
## License
This project is under the [Mozilla Public License Version 2.0](https://choosealicense.com/licenses/mpl-2.0/).
## Project status
🧡 This project is alive! Not frequent updates, but it is not abandoned.
Raw data
{
"_id": null,
"home_page": "https://framagit.org/RomainTT/pydavsync",
"name": "pydavsync",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "webdav,sync",
"author": "Romain TAPREST",
"author_email": "romain@taprest.fr",
"download_url": "https://files.pythonhosted.org/packages/d9/04/a24c21f5d1db9b4bbd1bf08e73ebda739737e22d1faaafa191e4c863c0eb/pydavsync-0.1.0.tar.gz",
"platform": null,
"description": "# pydavsync\n\nA command line to synchronize files with WebDav servers, written in Python.\n\n## Name\n\nThe foundational idea was to have a similar command line and behavior to\n[rsync](https://rsync.samba.org/), but for WebDav servers. `davsync` is the logical\nname. But I started to implement it in Rust, then in Python, and I decided to integrate\nthe development language in the name. Thus `pydavsync` for the Python implementation.\n\n## Description\n\n[rsync](https://rsync.samba.org/) allows to synchronize files over a SSH connection.\n[pydavsync](https://framagit.org/RomainTT/pydavsync/) has been developed to do the same\nover a WebDav connection.\n\nThe command line is not identical because compatibility is not a goal, and some new\nideas emerged while developing `pydavsync`.\n\nThe following operations can be done\u00a0:\n- Synchronization from local filesystem to WebDav server\n- Synchronization from WebDav server to local filesystem\n- Synchronization from WebDav server to WebDav server (not necessarily the same)\n\nHere are some of the features\u00a0:\n- dry run\n- verbose output\n- login/password given through command line options\n- synchronization based on modified time and file size\n- deletion when files disappear\n\n### Webdav?\n\n[Webdav](https://fr.wikipedia.org/wiki/WebDAV) is used to manage files on remote servers\nusing HTTP.\n\nThe primary motivation was to use `pydavsync` with [Nextcloud](https://nextcloud.com/)\nwhich is compatible with webdav. But there are many other services accepting webdav.\n\n## Installation\n\n`pydavsync` is available on [Pypi.org](https://pypi.org/project/pydavsync) and can be\ninstalled using `pip`. Many options are available to you, do as you please.\n\n```\npip install pydavsync\n```\n\n## Usage\n\nOnce installed, the program `pydavsync` should be available in your terminal.\n\nTo get help, use `pydavsyncc --help`.\n\nHere is an example to synchronize files from a webdav server to a local directory.\n\n```sh\n$ pydavsync --src-user Username --src-pass Password --verbose https://my-server.org/path/to/my/directory /path/to/local/directory\n```\n\n## Support\n\nIf you have a question or need help, please [open an issue](https://framagit.org/RomainTT/pydavsync/-/issues/new) and tag it with the ~support label.\n\n## Roadmap\n\nFuture developments:\n\n- Synchronization from local to webdav (and consequently from webdav to webdav)\n- Smarter synchronization if source and destination are both the same webdav server.\n- Better tests with mocks to simulate a webdav server.\n- A [man](https://www.man7.org/linux/man-pages/man1/man.1.html) page.\n- New and optional means to check if a file has changed or not.\n\n## Contributing\n\n- Firstly, you can open [a new issue](https://framagit.org/RomainTT/pydavsync/-/issues/new) if you find a bug or have an improvement idea.\n- Any help to test the tool on various systems and Webdav servers is appreciated, as I did not checked many of these myself.\n- If you feel like coding, please [fork](https://framagit.org/RomainTT/pydavsync/-/forks/new) the repository and do a [merge request](https://framagit.org/RomainTT/pydavsync/-/merge_requests). It will be reviewed. Don\u2019t forget to mention issues in your comments if you fix some of them!\n\n## Authors and acknowledgment\n\nMain author: Romain TAPREST [\u2709](mailto:romain@taprest.fr)\n\n## License\n\nThis project is under the [Mozilla Public License Version 2.0](https://choosealicense.com/licenses/mpl-2.0/).\n\n## Project status\n\n\ud83e\udde1 This project is alive! Not frequent updates, but it is not abandoned.\n\n",
"bugtrack_url": null,
"license": "Mozilla Public License v2",
"summary": "Synchronization command line for WebDav.",
"version": "0.1.0",
"split_keywords": [
"webdav",
"sync"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e012d8e238a92675f51e64dd4a977fb399fd3d2f8bf38be94460b36b14c1d1ea",
"md5": "9b42dc0235c0a74c152c8758ab47d211",
"sha256": "21c954400b50f8b634cd59a488497131c047a7eefb13de8ec24ae979cf494109"
},
"downloads": -1,
"filename": "pydavsync-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b42dc0235c0a74c152c8758ab47d211",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 21727,
"upload_time": "2023-02-06T14:34:31",
"upload_time_iso_8601": "2023-02-06T14:34:31.427059Z",
"url": "https://files.pythonhosted.org/packages/e0/12/d8e238a92675f51e64dd4a977fb399fd3d2f8bf38be94460b36b14c1d1ea/pydavsync-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d904a24c21f5d1db9b4bbd1bf08e73ebda739737e22d1faaafa191e4c863c0eb",
"md5": "9c9319b9ff2cd3bfb0fa67b44565cda0",
"sha256": "f143a35f4e198cb719e228b5cdcffdbbd2af0087f78944376853bf33338a73ca"
},
"downloads": -1,
"filename": "pydavsync-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "9c9319b9ff2cd3bfb0fa67b44565cda0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 15266,
"upload_time": "2023-02-06T14:34:33",
"upload_time_iso_8601": "2023-02-06T14:34:33.517320Z",
"url": "https://files.pythonhosted.org/packages/d9/04/a24c21f5d1db9b4bbd1bf08e73ebda739737e22d1faaafa191e4c863c0eb/pydavsync-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-06 14:34:33",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "pydavsync"
}
JSON