# sftputil
Python High-level SFTP client library
Documentation is available on [readthedocs](https://sftputil.readthedocs.io),
or in [docs/index.md](./docs/index.md).
## Description
`sftputil` is Python library to transfer files using SFTP. At this point only
the API is available, but a command line will probably be added in the future.
Why this package?
- Paramiko provides a
[SFTP](https://docs.paramiko.org/en/latest/api/sftp.html#paramiko.sftp_client.SFTPClient)
client but it does not contain many methods. It is alright if one only needs
simple get/put/list commands. But it is not enough for more complex operations.
- [pySFTP](https://pypi.org/project/pysftp/) would have been the solution, but
it has not been updated since 2016 (at the time of this writing). It is a dead
project and cannot be improved. It does not manage the last SSH key
algorithms.
Thus this new project. The initial reason was also that I needed a `rsync`-like
command through SFTP in Python scripts.
## Installation
Available on [pypi](https://pypi.org/project/sftputil/).
```
pip install sftputil
```
## Usage
TODO
## Support
If you have any question or suggestion, you can open a new
[issue](https://framagit.org/RomainTT/sftputil/-/issues).
## Roadmap
TODO for future releases:
- Add synchronisation on the other direction (push)
- Add a command line
- Add some unit tests
## Contributing
You are free to fork this repository and to do Merge Requests that I will
review.
## Authors and acknowledgment
Main author: Romain TAPREST <romain@taprest.fr>
## License
Licensed under [Mozilla Public License v2](./LICENSE).
## Project status
Alive! 💓
Raw data
{
"_id": null,
"home_page": "https://framagit.org/RomainTT/sftputil",
"name": "sftputil",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "sftp,ssh,sync",
"author": "Romain TAPREST",
"author_email": "romain@taprest.fr",
"download_url": "https://files.pythonhosted.org/packages/9a/a4/31a6fb8651e8fc48fa6d7ffe0dcf3c05703e67384284c6b757880f0fb5a7/sftputil-1.2.1.tar.gz",
"platform": null,
"description": "# sftputil\n\nPython High-level SFTP client library\n\nDocumentation is available on [readthedocs](https://sftputil.readthedocs.io),\nor in [docs/index.md](./docs/index.md).\n\n## Description\n\n`sftputil` is Python library to transfer files using SFTP. At this point only\nthe API is available, but a command line will probably be added in the future.\n\nWhy this package?\n\n- Paramiko provides a\n [SFTP](https://docs.paramiko.org/en/latest/api/sftp.html#paramiko.sftp_client.SFTPClient)\n client but it does not contain many methods. It is alright if one only needs\n simple get/put/list commands. But it is not enough for more complex operations.\n- [pySFTP](https://pypi.org/project/pysftp/) would have been the solution, but\n it has not been updated since 2016 (at the time of this writing). It is a dead\n project and cannot be improved. It does not manage the last SSH key\n algorithms.\n\nThus this new project. The initial reason was also that I needed a `rsync`-like\ncommand through SFTP in Python scripts.\n\n## Installation\n\nAvailable on [pypi](https://pypi.org/project/sftputil/).\n\n```\npip install sftputil\n```\n\n## Usage\n\nTODO\n\n## Support\n\nIf you have any question or suggestion, you can open a new\n[issue](https://framagit.org/RomainTT/sftputil/-/issues).\n\n## Roadmap\n\nTODO for future releases:\n\n- Add synchronisation on the other direction (push)\n- Add a command line\n- Add some unit tests\n\n## Contributing\n\nYou are free to fork this repository and to do Merge Requests that I will\nreview.\n\n## Authors and acknowledgment\n\nMain author: Romain TAPREST <romain@taprest.fr>\n\n## License\n\nLicensed under [Mozilla Public License v2](./LICENSE).\n\n## Project status\n\nAlive! \ud83d\udc93\n\n",
"bugtrack_url": null,
"license": "Mozilla Public License v2",
"summary": "Advanced SFTP functions based on Paramiko",
"version": "1.2.1",
"project_urls": {
"Bug Tracker": "https://framagit.org/RomainTT/sftputil/-/issues",
"Homepage": "https://framagit.org/RomainTT/sftputil",
"Repository": "https://framagit.org/RomainTT/sftputil"
},
"split_keywords": [
"sftp",
"ssh",
"sync"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23d89a80136f1d3f31c09c963cb143e899b71be87e270779dc8ff550e84d4ae0",
"md5": "aaa0e3929365f927e6087ceafbd09d1e",
"sha256": "afc7f296ac859b4bd1be5f7a81fc48c3d57e051716889c6dc583ae7fe977fe7f"
},
"downloads": -1,
"filename": "sftputil-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aaa0e3929365f927e6087ceafbd09d1e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 17951,
"upload_time": "2024-02-05T08:42:55",
"upload_time_iso_8601": "2024-02-05T08:42:55.796856Z",
"url": "https://files.pythonhosted.org/packages/23/d8/9a80136f1d3f31c09c963cb143e899b71be87e270779dc8ff550e84d4ae0/sftputil-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9aa431a6fb8651e8fc48fa6d7ffe0dcf3c05703e67384284c6b757880f0fb5a7",
"md5": "59114aaf9bf976dbd1fc8448dfc6ab2f",
"sha256": "4459e0d0ec4734da2662f08e1e5eeba2235c10bdb8274c58e3b82dbcfa771a26"
},
"downloads": -1,
"filename": "sftputil-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "59114aaf9bf976dbd1fc8448dfc6ab2f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 11113,
"upload_time": "2024-02-05T08:42:57",
"upload_time_iso_8601": "2024-02-05T08:42:57.464213Z",
"url": "https://files.pythonhosted.org/packages/9a/a4/31a6fb8651e8fc48fa6d7ffe0dcf3c05703e67384284c6b757880f0fb5a7/sftputil-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 08:42:57",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sftputil"
}
JSON