sftp-helper 2.2.3__tar.gz

sftp_helper-2.2.3/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Warith HARCHAOUI
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

sftp_helper-2.2.3/PKG-INFO

@@ -0,0 +1,258 @@
+Metadata-Version: 2.4
+Name: sftp-helper
+Version: 2.2.3
+Summary: SFTP Helper — utility functions for working with SFTP servers via paramiko, exposed as library, argparse CLI, click CLI, FastAPI HTTP surface and MCP tools. Strict host-key verification, credentials loader, upload / download / list / remove / exists / remote_tempfile context manager.
+Author-email: Warith HARCHAOUI <warithmetics@deraison.ai>
+License: BSD-3-Clause
+Project-URL: Homepage, https://github.com/warith-harchaoui/sftp-helper
+Project-URL: Issues, https://github.com/warith-harchaoui/sftp-helper/issues
+Keywords: sftp,paramiko,ssh,file-transfer,secure
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: File Transfer Protocol (FTP)
+Classifier: Topic :: System :: Networking
+Requires-Python: <3.14,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: os-helper>=1.5.0
+Requires-Dist: paramiko<4,>=3.0
+Provides-Extra: cli
+Requires-Dist: click<9,>=8.1; extra == "cli"
+Provides-Extra: api
+Requires-Dist: fastapi<1,>=0.111; extra == "api"
+Requires-Dist: uvicorn<1,>=0.30; extra == "api"
+Requires-Dist: python-multipart<1,>=0.0.9; extra == "api"
+Provides-Extra: mcp
+Requires-Dist: fastapi-mcp<1,>=0.3; extra == "mcp"
+Requires-Dist: fastapi<1,>=0.111; extra == "mcp"
+Requires-Dist: uvicorn<1,>=0.30; extra == "mcp"
+Requires-Dist: python-multipart<1,>=0.0.9; extra == "mcp"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pyyaml>=6; extra == "dev"
+Requires-Dist: httpx>=0.27; extra == "dev"
+Requires-Dist: click<9,>=8.1; extra == "dev"
+Requires-Dist: fastapi<1,>=0.111; extra == "dev"
+Requires-Dist: python-multipart<1,>=0.0.9; extra == "dev"
+Requires-Dist: fastapi-mcp<1,>=0.3; extra == "dev"
+Dynamic: license-file
+
+# SFTP Helper
+
+[🇫🇷](https://github.com/warith-harchaoui/sftp-helper/blob/main/LISEZMOI.md) · [🇬🇧](https://github.com/warith-harchaoui/sftp-helper/blob/main/README.md)
+
+[![CI](https://github.com/warith-harchaoui/sftp-helper/actions/workflows/ci.yml/badge.svg)](https://github.com/warith-harchaoui/sftp-helper/actions/workflows/ci.yml) [![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE) [![Python](https://img.shields.io/badge/python-3.10%E2%80%933.13-blue.svg)](#)
+
+`SFTP Helper` belongs to a collection of libraries called `AI Helpers` developped for building Artificial Intelligence
+
+This toolbox requires:
+  - a `config.json` for the sftp parameters (or YAML or environment variables or .env)
+  - that you previously added you SSH key of your local machine in the SFTP server
+
+[🌍 AI Helpers](https://harchaoui.org/warith/ai-helpers)
+
+[![logo](https://raw.githubusercontent.com/warith-harchaoui/sftp-helper/main/assets/logo.png)](https://harchaoui.org/warith/ai-helpers)
+
+SFTP Helper is a Python library that provides utility functions for working with SFTP servers via [paramiko](https://www.paramiko.org/). Host key verification is on by default — `~/.ssh/known_hosts` is loaded and unknown hosts are rejected.
+
+# Installation
+
+**Prerequisites** — **Python 3.10–3.13** and **git**, cross-platform:
+
+- 🍎 **macOS** ([Homebrew](https://brew.sh)): `brew install python git`
+- 🐧 **Ubuntu/Debian**: `sudo apt update && sudo apt install -y python3 python3-pip git`
+- 🪟 **Windows** (PowerShell): `winget install Python.Python.3.12 Git.Git`
+
+Then install the package:
+
+
+## Install Package
+
+We can recommand python environments. Check this link if you don't know how
+
+[🥸 Tech tips](https://harchaoui.org/warith/4ml/#install)
+
+```bash
+pip install --force-reinstall --no-cache-dir git+https://github.com/warith-harchaoui/sftp-helper.git@v2.2.2
+```
+
+Or, from a checkout:
+
+```bash
+pip install -r requirements.txt
+pip install -e .
+```
+
+## Write your own configuration file
+
+A ready-to-fill template is committed at [`sftp_config.json.example`](https://github.com/warith-harchaoui/sftp-helper/blob/main/sftp_config.json.example). A heavily-commented YAML variant is also provided at [`sftp_config.yaml.example`](https://github.com/warith-harchaoui/sftp-helper/blob/main/sftp_config.yaml.example) — YAML supports inline comments explaining every key and how to obtain its value. Copy either one and edit in place — real `*config.json` / `*config.yaml` files are gitignored so you cannot accidentally commit secrets:
+
+```bash
+cp sftp_config.json.example sftp_config.json
+# then edit sftp_config.json with your credentials
+```
+
+You may also provide a YAML version (`sftp_config.yaml`), environment variables, or an `.env` file — `sftp-helper` falls back in that order via `os_helper.get_config`:
+
+_JSON_
+```json
+{
+    "sftp_host": "<sftp_host>",
+    "sftp_login": "<sftp_login>",
+    "sftp_passwd": "<sftp_passwd>",
+    "sftp_https": "<sftp_https>",
+    "sftp_destination_path": "<sftp_destination_path>",
+}
+```
+or
+
+_YAML_
+```yaml
+sftp_host: "<sftp_host>"
+sftp_login: "<sftp_login>"
+sftp_passwd: "<sftp_passwd>"
+sftp_https: "<sftp_https>"
+sftp_destination_path: "<sftp_destination_path>"
+```
+or
+
+_ENVIRONMENT VARIABLES_
+```bash
+SFTP_HOST="<sftp_host>" \
+SFTP_LOGIN="<sftp_login>" \
+SFTP_PASSWD="<sftp_passwd>" \
+SFTP_HTTPS="<sftp_https>" \
+SFTP_DESTINATION_PATH="<sftp_destination_path>" \
+python <your_python_script>
+```
+or
+
+_.env_
+```
+SFTP_HOST                = <sftp_host>
+SFTP_LOGIN               = <sftp_login>
+SFTP_PASSWD              = <sftp_passwd>
+SFTP_HTTPS               = <sftp_https>
+SFTP_DESTINATION_PATH    = <sftp_destination_path>
+```
+
+In which you can find these information in your favorite FTP tool (mine is FileZilla):
+  + `<sftp_host>` is the server path `sftp.` ...
+  + `<sftp_login>` and `<sftp_passwd>` that you use in FileZilla
+  + `<sftp_destination_path>` is the remote folder path
+  + `<sftp_https>` corresponds to the web URL of `<sftp_destination_path>`
+  + <your_python_script> is your python script :)
+
+## Usage
+
+For the full catalog of recipes (uploads, downloads, existence checks, recursive directory creation, temporary remote files with auto-cleanup, strict host-key verification), see [📋 EXAMPLES.md](https://github.com/warith-harchaoui/sftp-helper/blob/main/EXAMPLES.md).
+
+Here's an example of how to use SFTP helper (**won't work without a valid `path/to/sftp_config.json`**):
+
+```python
+import sftp_helper as sftph
+import os_helper as osh
+
+# Write a small text file
+local_file = "example.txt"
+with open(local_file, "wt") as f:
+    f.write("A small example of text")
+
+# Load creds from JSON / YAML file, or fall back to .env / environment vars.
+cred = sftph.credentials("path/to/sftp_config.json")
+
+remote_file = cred["sftp_destination_path"] + "/" + local_file
+url = cred["sftp_https"] + "/" + local_file
+
+# upload() raises on failure and returns the destination URL on success.
+sftph.upload(local_file, cred, remote_file)
+print(f"Uploaded {local_file} to {remote_file}")
+# Uploaded example.txt to /remote/base/path/example.txt
+
+assert osh.is_working_url(url), f"URL not reachable: {url}"
+print(f"URL is live: {url}")
+# URL is live: https://files.example.com/example.txt
+```
+
+## Temporary remote files
+
+If you need a unique remote path that gets cleaned up automatically, use the
+`remote_tempfile` context manager:
+
+```python
+import sftp_helper as sftph
+import os_helper as osh
+
+credentials = sftph.credentials("path/to/sftp_config.json")
+
+with sftph.remote_tempfile(credentials, ext="txt") as (sftp_address, url):
+    sftph.upload("local.txt", credentials, sftp_address)
+    assert osh.is_working_url(url)
+# On exit, the remote file is deleted.
+```
+
+## Host key verification
+
+`sftp_helper` never disables host key verification. The default policy is
+`paramiko.RejectPolicy()` and `~/.ssh/known_hosts` is loaded automatically. To
+trust a server in a non-default location, point at an extra known_hosts file
+via the optional `sftp_known_hosts` credential.
+
+# Multi-surface exposure
+
+`sftp-helper` is not just a library — the same functions are exposed
+as a CLI, a FastAPI HTTP surface, and an MCP tool set:
+
+```bash
+# Python library (default)
+import sftp_helper as sftph
+
+# argparse-based CLI (installed automatically)
+sftp-helper upload   --config sftp_config.json --input local.txt --remote /uploads/local.txt
+sftp-helper download --config sftp_config.json --remote /uploads/local.txt --output out.txt
+sftp-helper exists   --config sftp_config.json --remote /uploads/local.txt
+sftp-helper mkdir    --config sftp_config.json --remote /uploads/a/b/c
+
+# click-based CLI twin (needs the [cli] extra)
+pip install 'sftp-helper[cli] @ git+https://github.com/warith-harchaoui/sftp-helper.git@v2.2.2'
+sftp-helper-click upload --config sftp_config.json --input local.txt --remote /uploads/local.txt
+
+# FastAPI HTTP surface (needs the [api] extra)
+pip install 'sftp-helper[api] @ git+https://github.com/warith-harchaoui/sftp-helper.git@v2.2.2'
+SFTP_HELPER_CONFIG=./sftp_config.json uvicorn sftp_helper.api:app --port 8000
+# → OpenAPI docs at http://localhost:8000/docs
+
+# MCP tools over FastAPI (needs the [api,mcp] extras)
+pip install 'sftp-helper[api,mcp] @ git+https://github.com/warith-harchaoui/sftp-helper.git@v2.2.2'
+sftp-helper-mcp                  # serves FastAPI + MCP on port 8000
+```
+
+Docker image (HTTP + MCP on port 8000):
+
+```bash
+docker build -t sftp-helper .
+docker run --rm -p 8000:8000 \
+  -v $PWD/sftp_config.json:/app/sftp_config.json:ro \
+  -e SFTP_HELPER_CONFIG=/app/sftp_config.json \
+  sftp-helper
+```
+
+An innovative GUI plan (pipeline dashboard, storage health panel,
+live transfer feed) lives in [GUI.md](https://github.com/warith-harchaoui/sftp-helper/blob/main/GUI.md).
+
+The competitive landscape (paramiko, pysftp, asyncssh, Fabric,
+smart-open, PyFilesystem2, lftp, Rclone, …) is analysed in
+[LANDSCAPE.md](https://github.com/warith-harchaoui/sftp-helper/blob/main/LANDSCAPE.md).
+
+# Author
+ - [Warith HARCHAOUI](https://linkedin.com/in/warith-harchaoui)
+
+# Acknowledgements
+Special thanks to [Mohamed Chelali](https://mchelali.github.io) and [Bachir Zerroug](https://www.linkedin.com/in/bachirzerroug) for fruitful discussions.

sftp_helper-2.2.3/README.md

@@ -0,0 +1,212 @@
+# SFTP Helper
+
+[🇫🇷](https://github.com/warith-harchaoui/sftp-helper/blob/main/LISEZMOI.md) · [🇬🇧](https://github.com/warith-harchaoui/sftp-helper/blob/main/README.md)
+
+[![CI](https://github.com/warith-harchaoui/sftp-helper/actions/workflows/ci.yml/badge.svg)](https://github.com/warith-harchaoui/sftp-helper/actions/workflows/ci.yml) [![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE) [![Python](https://img.shields.io/badge/python-3.10%E2%80%933.13-blue.svg)](#)
+
+`SFTP Helper` belongs to a collection of libraries called `AI Helpers` developped for building Artificial Intelligence
+
+This toolbox requires:
+  - a `config.json` for the sftp parameters (or YAML or environment variables or .env)
+  - that you previously added you SSH key of your local machine in the SFTP server
+
+[🌍 AI Helpers](https://harchaoui.org/warith/ai-helpers)
+
+[![logo](https://raw.githubusercontent.com/warith-harchaoui/sftp-helper/main/assets/logo.png)](https://harchaoui.org/warith/ai-helpers)
+
+SFTP Helper is a Python library that provides utility functions for working with SFTP servers via [paramiko](https://www.paramiko.org/). Host key verification is on by default — `~/.ssh/known_hosts` is loaded and unknown hosts are rejected.
+
+# Installation
+
+**Prerequisites** — **Python 3.10–3.13** and **git**, cross-platform:
+
+- 🍎 **macOS** ([Homebrew](https://brew.sh)): `brew install python git`
+- 🐧 **Ubuntu/Debian**: `sudo apt update && sudo apt install -y python3 python3-pip git`
+- 🪟 **Windows** (PowerShell): `winget install Python.Python.3.12 Git.Git`
+
+Then install the package:
+
+
+## Install Package
+
+We can recommand python environments. Check this link if you don't know how
+
+[🥸 Tech tips](https://harchaoui.org/warith/4ml/#install)
+
+```bash
+pip install --force-reinstall --no-cache-dir git+https://github.com/warith-harchaoui/sftp-helper.git@v2.2.2
+```
+
+Or, from a checkout:
+
+```bash
+pip install -r requirements.txt
+pip install -e .
+```
+
+## Write your own configuration file
+
+A ready-to-fill template is committed at [`sftp_config.json.example`](https://github.com/warith-harchaoui/sftp-helper/blob/main/sftp_config.json.example). A heavily-commented YAML variant is also provided at [`sftp_config.yaml.example`](https://github.com/warith-harchaoui/sftp-helper/blob/main/sftp_config.yaml.example) — YAML supports inline comments explaining every key and how to obtain its value. Copy either one and edit in place — real `*config.json` / `*config.yaml` files are gitignored so you cannot accidentally commit secrets:
+
+```bash
+cp sftp_config.json.example sftp_config.json
+# then edit sftp_config.json with your credentials
+```
+
+You may also provide a YAML version (`sftp_config.yaml`), environment variables, or an `.env` file — `sftp-helper` falls back in that order via `os_helper.get_config`:
+
+_JSON_
+```json
+{
+    "sftp_host": "<sftp_host>",
+    "sftp_login": "<sftp_login>",
+    "sftp_passwd": "<sftp_passwd>",
+    "sftp_https": "<sftp_https>",
+    "sftp_destination_path": "<sftp_destination_path>",
+}
+```
+or
+
+_YAML_
+```yaml
+sftp_host: "<sftp_host>"
+sftp_login: "<sftp_login>"
+sftp_passwd: "<sftp_passwd>"
+sftp_https: "<sftp_https>"
+sftp_destination_path: "<sftp_destination_path>"
+```
+or
+
+_ENVIRONMENT VARIABLES_
+```bash
+SFTP_HOST="<sftp_host>" \
+SFTP_LOGIN="<sftp_login>" \
+SFTP_PASSWD="<sftp_passwd>" \
+SFTP_HTTPS="<sftp_https>" \
+SFTP_DESTINATION_PATH="<sftp_destination_path>" \
+python <your_python_script>
+```
+or
+
+_.env_
+```
+SFTP_HOST                = <sftp_host>
+SFTP_LOGIN               = <sftp_login>
+SFTP_PASSWD              = <sftp_passwd>
+SFTP_HTTPS               = <sftp_https>
+SFTP_DESTINATION_PATH    = <sftp_destination_path>
+```
+
+In which you can find these information in your favorite FTP tool (mine is FileZilla):
+  + `<sftp_host>` is the server path `sftp.` ...
+  + `<sftp_login>` and `<sftp_passwd>` that you use in FileZilla
+  + `<sftp_destination_path>` is the remote folder path
+  + `<sftp_https>` corresponds to the web URL of `<sftp_destination_path>`
+  + <your_python_script> is your python script :)
+
+## Usage
+
+For the full catalog of recipes (uploads, downloads, existence checks, recursive directory creation, temporary remote files with auto-cleanup, strict host-key verification), see [📋 EXAMPLES.md](https://github.com/warith-harchaoui/sftp-helper/blob/main/EXAMPLES.md).
+
+Here's an example of how to use SFTP helper (**won't work without a valid `path/to/sftp_config.json`**):
+
+```python
+import sftp_helper as sftph
+import os_helper as osh
+
+# Write a small text file
+local_file = "example.txt"
+with open(local_file, "wt") as f:
+    f.write("A small example of text")
+
+# Load creds from JSON / YAML file, or fall back to .env / environment vars.
+cred = sftph.credentials("path/to/sftp_config.json")
+
+remote_file = cred["sftp_destination_path"] + "/" + local_file
+url = cred["sftp_https"] + "/" + local_file
+
+# upload() raises on failure and returns the destination URL on success.
+sftph.upload(local_file, cred, remote_file)
+print(f"Uploaded {local_file} to {remote_file}")
+# Uploaded example.txt to /remote/base/path/example.txt
+
+assert osh.is_working_url(url), f"URL not reachable: {url}"
+print(f"URL is live: {url}")
+# URL is live: https://files.example.com/example.txt
+```
+
+## Temporary remote files
+
+If you need a unique remote path that gets cleaned up automatically, use the
+`remote_tempfile` context manager:
+
+```python
+import sftp_helper as sftph
+import os_helper as osh
+
+credentials = sftph.credentials("path/to/sftp_config.json")
+
+with sftph.remote_tempfile(credentials, ext="txt") as (sftp_address, url):
+    sftph.upload("local.txt", credentials, sftp_address)
+    assert osh.is_working_url(url)
+# On exit, the remote file is deleted.
+```
+
+## Host key verification
+
+`sftp_helper` never disables host key verification. The default policy is
+`paramiko.RejectPolicy()` and `~/.ssh/known_hosts` is loaded automatically. To
+trust a server in a non-default location, point at an extra known_hosts file
+via the optional `sftp_known_hosts` credential.
+
+# Multi-surface exposure
+
+`sftp-helper` is not just a library — the same functions are exposed
+as a CLI, a FastAPI HTTP surface, and an MCP tool set:
+
+```bash
+# Python library (default)
+import sftp_helper as sftph
+
+# argparse-based CLI (installed automatically)
+sftp-helper upload   --config sftp_config.json --input local.txt --remote /uploads/local.txt
+sftp-helper download --config sftp_config.json --remote /uploads/local.txt --output out.txt
+sftp-helper exists   --config sftp_config.json --remote /uploads/local.txt
+sftp-helper mkdir    --config sftp_config.json --remote /uploads/a/b/c
+
+# click-based CLI twin (needs the [cli] extra)
+pip install 'sftp-helper[cli] @ git+https://github.com/warith-harchaoui/sftp-helper.git@v2.2.2'
+sftp-helper-click upload --config sftp_config.json --input local.txt --remote /uploads/local.txt
+
+# FastAPI HTTP surface (needs the [api] extra)
+pip install 'sftp-helper[api] @ git+https://github.com/warith-harchaoui/sftp-helper.git@v2.2.2'
+SFTP_HELPER_CONFIG=./sftp_config.json uvicorn sftp_helper.api:app --port 8000
+# → OpenAPI docs at http://localhost:8000/docs
+
+# MCP tools over FastAPI (needs the [api,mcp] extras)
+pip install 'sftp-helper[api,mcp] @ git+https://github.com/warith-harchaoui/sftp-helper.git@v2.2.2'
+sftp-helper-mcp                  # serves FastAPI + MCP on port 8000
+```
+
+Docker image (HTTP + MCP on port 8000):
+
+```bash
+docker build -t sftp-helper .
+docker run --rm -p 8000:8000 \
+  -v $PWD/sftp_config.json:/app/sftp_config.json:ro \
+  -e SFTP_HELPER_CONFIG=/app/sftp_config.json \
+  sftp-helper
+```
+
+An innovative GUI plan (pipeline dashboard, storage health panel,
+live transfer feed) lives in [GUI.md](https://github.com/warith-harchaoui/sftp-helper/blob/main/GUI.md).
+
+The competitive landscape (paramiko, pysftp, asyncssh, Fabric,
+smart-open, PyFilesystem2, lftp, Rclone, …) is analysed in
+[LANDSCAPE.md](https://github.com/warith-harchaoui/sftp-helper/blob/main/LANDSCAPE.md).
+
+# Author
+ - [Warith HARCHAOUI](https://linkedin.com/in/warith-harchaoui)
+
+# Acknowledgements
+Special thanks to [Mohamed Chelali](https://mchelali.github.io) and [Bachir Zerroug](https://www.linkedin.com/in/bachirzerroug) for fruitful discussions.

sftp_helper-2.2.3/pyproject.toml

@@ -0,0 +1,105 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sftp-helper"
+version = "2.2.3"
+description = "SFTP Helper — utility functions for working with SFTP servers via paramiko, exposed as library, argparse CLI, click CLI, FastAPI HTTP surface and MCP tools. Strict host-key verification, credentials loader, upload / download / list / remove / exists / remote_tempfile context manager."
+readme = "README.md"
+requires-python = ">=3.10,<3.14"
+license = {text = "BSD-3-Clause"}
+authors = [
+    {name = "Warith HARCHAOUI", email = "warithmetics@deraison.ai"},
+]
+keywords = ["sftp", "paramiko", "ssh", "file-transfer", "secure"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Internet :: File Transfer Protocol (FTP)",
+    "Topic :: System :: Networking",
+]
+dependencies = [
+    "os-helper>=1.5.0",
+    "paramiko>=3.0,<4",
+]
+
+[project.optional-dependencies]
+# CLI-only-with-click extra. argparse variant needs no runtime dep and
+# is always available.
+cli = ["click>=8.1,<9"]
+# FastAPI HTTP surface (sftp_helper.api). uvicorn + python-multipart
+# so multipart file uploads work out of the box.
+api = [
+    "fastapi>=0.111,<1",
+    "uvicorn>=0.30,<1",
+    "python-multipart>=0.0.9,<1",
+]
+# MCP surface (sftp_helper.mcp). Depends on the `api` extra
+# — fastapi-mcp wraps the FastAPI app.
+mcp = [
+    "fastapi-mcp>=0.3,<1",
+    "fastapi>=0.111,<1",
+    "uvicorn>=0.30,<1",
+    "python-multipart>=0.0.9,<1",
+]
+# `dev` keeps the bar low for CI — pytest + httpx (for FastAPI TestClient)
+# + click (so the click CLI import always resolves in tests) + pyyaml
+# (used by the credentials tests to write YAML configs).
+dev = [
+    "pytest>=8",
+    "pyyaml>=6",
+    "httpx>=0.27",
+    "click>=8.1,<9",
+    "fastapi>=0.111,<1",
+    "python-multipart>=0.0.9,<1",
+    "fastapi-mcp>=0.3,<1",
+]
+
+[project.scripts]
+# argparse-based CLI — no runtime dep beyond stdlib + core package.
+sftp-helper = "sftp_helper.cli_argparse:main"
+# click-based twin — install with [cli] extra.
+sftp-helper-click = "sftp_helper.cli_click:cli"
+# MCP server (over FastAPI) — install with [api,mcp] extras.
+sftp-helper-mcp = "sftp_helper.mcp:main"
+
+[project.urls]
+Homepage = "https://github.com/warith-harchaoui/sftp-helper"
+Issues = "https://github.com/warith-harchaoui/sftp-helper/issues"
+
+[tool.setuptools.packages.find]
+include = ["sftp_helper*"]
+exclude = ["tests*", "assets*"]
+
+[tool.pytest.ini_options]
+markers = [
+    "integration: tests that hit a real SFTP server (skipped by default)",
+]
+addopts = "-m 'not integration'"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+extend-exclude = ["assets", "tests"]
+
+[tool.ruff.lint]
+# Conservative starter set: pyflakes (F), pycodestyle errors (E), warnings (W),
+# isort (I), bugbear (B), comprehensions (C4), pyupgrade (UP), simplify (SIM).
+# Easy to tighten later; this is the baseline.
+select = ["E", "F", "W", "I", "B", "C4", "UP", "SIM"]
+ignore = [
+    "E501",  # line-too-long — handled by formatter / context-dependent
+    "B008",  # function call in argument default — too noisy for our style
+    "SIM108",  # ternary preferred over if/else — sometimes hurts readability
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["B011"]  # assert False in pytest is fine

sftp_helper-2.2.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sftp_helper-2.2.3/sftp_helper/__init__.py

@@ -0,0 +1,57 @@
+"""
+SFTP Helper — public API surface.
+
+Re-exports the utility functions from :mod:`sftp_helper.main` so that
+downstream code can simply write ``import sftp_helper as sftph`` and reach
+every supported operation (credentials loading, connection context manager,
+upload, download, exists, delete, mkdir -p, remote temp file with
+auto-cleanup) without knowing about the module layout.
+
+Backed by paramiko with strict host-key verification. See the module docs
+for the full policy — there is no flag to disable verification.
+
+Usage Example
+-------------
+>>> import sftp_helper as sftph
+>>> cred = sftph.credentials("sftp_config.json")
+>>> sftph.upload("local.txt", cred, "/remote/base/local.txt")
+>>> assert sftph.remote_file_exists("/remote/base/local.txt", cred)
+>>> sftph.download("/remote/base/local.txt", cred, "roundtrip.txt")
+>>> sftph.delete("/remote/base/local.txt", cred)
+
+Author
+------
+Warith Harchaoui, Ph.D. — https://linkedin.com/in/warith-harchaoui/
+"""
+
+__author__ = "Warith Harchaoui, Ph.D."
+__email__ = "warithmetics@deraison.ai"
+
+# Specify the public API of this module using __all__
+__all__ = [
+    "credentials",
+    "get_client_sftp",
+    "normalize_path",
+    "strip_sftp_path",
+    "remote_file_exists",
+    "delete",
+    "upload",
+    "download",
+    "remote_dir_exist",
+    "make_remote_directory",
+    "remote_tempfile",
+]
+
+from .main import (
+    credentials,
+    delete,
+    download,
+    get_client_sftp,
+    make_remote_directory,
+    normalize_path,
+    remote_dir_exist,
+    remote_file_exists,
+    remote_tempfile,
+    strip_sftp_path,
+    upload,
+)