.. core-ftp documentation master file, created by
   sphinx-quickstart on Fri Mar 28 10:17:05 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

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...

===============================================================================

.. image:: https://img.shields.io/pypi/pyversions/core-ftp.svg
    :target: https://pypi.org/project/core-ftp/
    :alt: Python Versions

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
    :target: https://gitlab.com/bytecode-solutions/core/core-ftp/-/blob/main/LICENSE
    :alt: License

.. image:: https://gitlab.com/bytecode-solutions/core/core-ftp/badges/release/pipeline.svg
    :target: https://gitlab.com/bytecode-solutions/core/core-ftp/-/pipelines
    :alt: Pipeline Status

.. image:: https://readthedocs.org/projects/core-ftp/badge/?version=latest
    :target: https://readthedocs.org/projects/core-ftp/
    :alt: Docs Status

.. image:: https://img.shields.io/badge/security-bandit-yellow.svg
    :target: https://github.com/PyCQA/bandit
    :alt: Security


Documentation Contents
-------------------------------------------------------------------------------

.. toctree::
   :maxdepth: 1
   :caption: Index:

   how_to_use
   clients
   interfaces
   tests


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


Installation
-------------------------------------------------------------------------------

Install from PyPI using pip:

.. code-block:: bash

    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:

.. code-block:: bash

    pip install --upgrade pip
    pip install virtualenv

2. Create Python virtual environment:

.. code-block:: bash

    virtualenv --python=python3.12 .venv

3. Activate the virtual environment:

.. code-block:: bash

    source .venv/bin/activate

Install packages
-------------------------------------------------------------------------------

.. code-block:: bash

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

Check tests and coverage
-------------------------------------------------------------------------------

.. code-block:: shell

    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: ``python manager.py run-tests``
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* - alek.cora.glez@gmail.com