core-ftp 2.0.2

This project/library contains common elements related to FTP connections...

# core-ftp

This project/library provides a comprehensive set of common components and interfaces designed to facilitate and streamline FTP connections, ensuring efficient communication and data transfer…

---

Installation

Install from PyPI using pip:

pip install core-ftp
uv pip install core-ftp  # Or using UV...

Features

SFTP Client

• Simplified SFTP connection management with context manager support

• Multiple authentication methods:

  • Password-based authentication

  • SSH private key authentication with optional passphrase

  • Customizable transport and connection parameters

• Comprehensive file operations:

  • List files and directories with detailed attributes

  • Upload files from local filesystem or file-like objects

  • Download files to local filesystem

  • Delete files and directories

  • Change and retrieve current working directory

• Built-in error handling with custom exceptions

• Automatic resource cleanup

ETL Support

• Abstract base class for SFTP-based ETL tasks

• Seamless integration with core-etl framework

• File filtering capabilities:

  • Filter by file extension

  • Filter by filename prefix

  • Time-based filtering with delay options

• Optional automatic file cleanup after successful processing

Examples.

from core_ftp.clients.sftp import SftpClient

with SftpClient("test.rebex.net", 22, "demo", "password") as client:
    for x in client.list_files("/"):
        print(x)

from core_ftp.clients.sftp import SftpClient

with SftpClient(
        host="localhost", port=23,
        user="foo", private_key_path="key_path") as client:

    for x in client.list_files("/"):
        print(x)

Local SFTP server using Docker

You can use docker to create an SFTP server to test the client using the functional tests via command python manager.py run-tests –test-type functional –pattern “*.py” and the following docker image: <atmoz/sftp> (https://hub.docker.com/r/atmoz/sftp/).

Authentication via user & password.

docker run \
  -v ./tests/resources/upload:/home/foo/upload:rw \
  -p 22:22 -d atmoz/sftp foo:pass:::upload

Authentication via SSH key.

docker run \
  -v ./tests/resources/ssh_keys/id_rsa.pub:/home/foo/.ssh/keys/id_rsa.pub:ro \
  -v ./tests/resources/upload:/home/foo/upload:rw \
  -p 23:22 -d atmoz/sftp foo::1001

Quick Start

Installation

Install the package:

pip install core-ftp
uv pip install core-ftp     # Or using UV...
pip install -e ".[dev]"     # For development...

Setting Up Environment

1. Install required libraries:

pip install --upgrade pip
pip install virtualenv

2. Create Python virtual environment:

virtualenv --python=python3.12 .venv

3. Activate the virtual environment:

source .venv/bin/activate

Install packages

pip install .
pip install -e ".[dev]"

Check tests and coverage

python manager.py run-tests
python manager.py run-coverage

Contributing

Contributions are welcome! Please:

1. Fork the repository

2. Create a feature branch

3. Write tests for new functionality

4. Ensure all tests pass: pytest -n auto

5. Run linting: pylint core_ftp

6. Run security checks: bandit -r core_ftp

7. Submit a pull request

License

This project is licensed under the MIT License. See the LICENSE file for details.

Links

• Documentation: https://core-ftp.readthedocs.io/en/latest/

• Repository: https://gitlab.com/bytecode-solutions/core/core-ftp

• Issues: https://gitlab.com/bytecode-solutions/core/core-ftp/-/issues

• Changelog: https://gitlab.com/bytecode-solutions/core/core-ftp/-/blob/master/CHANGELOG.md

• PyPI: https://pypi.org/project/core-ftp/

Support

For questions or support, please open an issue on GitLab or contact the maintainers.

Authors

• Alejandro Cora González - Initial work - [e-mail]