# fileshiftlib
* [Description](#package-description)
* [Usage](#usage)
* [Installation](#installation)
* [License](#license)
## Package Description
SFTP client Python package that uses [paramiko](https://pypi.org/project/paramiko/) library.
## Usage
* [fileshiftlib](#fileshiftlib)
from a script:
```python
import fileshiftlib
host = "localhost"
username = "123..."
password = "xxxx"
port = 22
# Initialize SFTP client
sftp = fileshiftlib.SFTP(host=host,
username=username,
password=password,
port=port,
logger=None)
```
```python
content_list = sftp.list_dir()
print(content_list)
```
```python
sftp.change_dir(path=".")
```
```python
sftp.delete_file(filename=r"demo.txt")
```
```python
sftp.download_file(remote_path=r"/demo/demo.txt", local_path=r"c:\local\demo.txt")
```
```python
sftp.upload_file(local_path=r"c:\local\demo.txt", remote_path=r"/demo/demo.txt")
```
## Installation
* [fileshiftlib](#fileshiftlib)
Install python and pip if you have not already.
Then run:
```bash
pip install pip --upgrade
```
For production:
```bash
pip install fileshiftlib
```
This will install the package and all of it's python dependencies.
If you want to install the project for development:
```bash
git clone https://github.com/aghuttun/fileshiftlib.git
cd fileshiftlib
pip install -e ".[dev]"
```
To test the development package: [Testing](#testing)
## License
* [fileshiftlib](#fileshiftlib)
BSD License (see license file)
Raw data
{
"_id": null,
"home_page": null,
"name": "fileshiftlib",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Paulo Portela <portela.paulo@gmail.com>",
"keywords": "SFTP, Python, FTP, File Transfer",
"author": null,
"author_email": "Paulo Portela <portela.paulo@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a5/40/6da4b3eebef8b5f812181e4d1eeefdba388e29eadc6df23ab8ebe6a2c174/fileshiftlib-0.0.8.tar.gz",
"platform": null,
"description": "# fileshiftlib\r\n\r\n* [Description](#package-description)\r\n* [Usage](#usage)\r\n* [Installation](#installation)\r\n* [License](#license)\r\n\r\n## Package Description\r\n\r\nSFTP client Python package that uses [paramiko](https://pypi.org/project/paramiko/) library.\r\n\r\n## Usage\r\n\r\n* [fileshiftlib](#fileshiftlib)\r\n\r\nfrom a script:\r\n\r\n```python\r\nimport fileshiftlib\r\n\r\nhost = \"localhost\"\r\nusername = \"123...\"\r\npassword = \"xxxx\"\r\nport = 22\r\n\r\n# Initialize SFTP client\r\nsftp = fileshiftlib.SFTP(host=host,\r\n username=username,\r\n password=password,\r\n port=port,\r\n logger=None)\r\n```\r\n\r\n```python\r\ncontent_list = sftp.list_dir()\r\nprint(content_list)\r\n```\r\n\r\n```python\r\nsftp.change_dir(path=\".\")\r\n```\r\n\r\n```python\r\nsftp.delete_file(filename=r\"demo.txt\")\r\n```\r\n\r\n```python\r\nsftp.download_file(remote_path=r\"/demo/demo.txt\", local_path=r\"c:\\local\\demo.txt\")\r\n```\r\n\r\n```python\r\nsftp.upload_file(local_path=r\"c:\\local\\demo.txt\", remote_path=r\"/demo/demo.txt\")\r\n```\r\n\r\n## Installation\r\n\r\n* [fileshiftlib](#fileshiftlib)\r\n\r\nInstall python and pip if you have not already.\r\n\r\nThen run:\r\n\r\n```bash\r\npip install pip --upgrade\r\n```\r\n\r\nFor production:\r\n\r\n```bash\r\npip install fileshiftlib\r\n```\r\n\r\nThis will install the package and all of it's python dependencies.\r\n\r\nIf you want to install the project for development:\r\n\r\n```bash\r\ngit clone https://github.com/aghuttun/fileshiftlib.git\r\ncd fileshiftlib\r\npip install -e \".[dev]\"\r\n```\r\n\r\nTo test the development package: [Testing](#testing)\r\n\r\n## License\r\n\r\n* [fileshiftlib](#fileshiftlib)\r\n\r\nBSD License (see license file)\r\n",
"bugtrack_url": null,
"license": null,
"summary": "SFTP client!",
"version": "0.0.8",
"project_urls": {
"Documentation": "https://github.com/aghuttun/fileshiftlib/blob/main/README.md",
"Homepage": "https://github.com/aghuttun/fileshiftlib"
},
"split_keywords": [
"sftp",
" python",
" ftp",
" file transfer"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7d28486ad3cc55c41c5f1a9d06a29dae2a19d6d4c401eed256063792472c4d7d",
"md5": "1b1183d243efbfec913f66030d923561",
"sha256": "d7c9d359bcb07fa2d7c03089b1fefefab302b9aa3483e9dae7ff766bc644dc81"
},
"downloads": -1,
"filename": "fileshiftlib-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1b1183d243efbfec913f66030d923561",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 4901,
"upload_time": "2025-07-25T16:44:04",
"upload_time_iso_8601": "2025-07-25T16:44:04.917249Z",
"url": "https://files.pythonhosted.org/packages/7d/28/486ad3cc55c41c5f1a9d06a29dae2a19d6d4c401eed256063792472c4d7d/fileshiftlib-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a5406da4b3eebef8b5f812181e4d1eeefdba388e29eadc6df23ab8ebe6a2c174",
"md5": "77fa7c49beedc7d00184c42ea37dfc6c",
"sha256": "0c5e31024892bf14f8718ad23a05e2f33b1ede7868e5f864a83fb480d968ced6"
},
"downloads": -1,
"filename": "fileshiftlib-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "77fa7c49beedc7d00184c42ea37dfc6c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 4424,
"upload_time": "2025-07-25T16:44:06",
"upload_time_iso_8601": "2025-07-25T16:44:06.021260Z",
"url": "https://files.pythonhosted.org/packages/a5/40/6da4b3eebef8b5f812181e4d1eeefdba388e29eadc6df23ab8ebe6a2c174/fileshiftlib-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-25 16:44:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aghuttun",
"github_project": "fileshiftlib",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "fileshiftlib"
}
JSON
