datacoco-ftp_tools

PyPI Version Documentation Status Code Quality Grade Coverage Code of Conduct

datacoco-ftp_tools provides basic interaction for FTP (File-Transfer-Protocol) Standard Internet protocol for transmitting files between computers on the Internet over TCP/IP connections This module has FTP and SFTP support

Installation

datacoco-ftp_tools requires Python 3.6+

python3 -m venv venv
source venv/bin/activate
python -m pip install datacoco_ftp_tools

Quickstart

SFTP and write file to remote server using FTP

from datacoco_ftp_tools import FTPInteraction


# Sample Code for FTP Interaction

ftp = FTPInteraction('ftp',ftp_site,ftp_user,ftp_password)

ftp.conn()

ftp.curr_dir() # outputs '/web_analytics'

ftp.call_dir('Monitoring') # outputs '/web_analytics/Monitoring'

ftp.write_file('test.txt', 'test')

ftp.quit()

SFTP and write file to remote server using SFTP

from datacoco_ftp_tools import FTPInteraction


# Sample Code for SFTP Interaction

sftp = FTPInteraction('sftp',sftp_site,sftp_user,sftp_password)

sftp.conn()

sftp.curr_dir() outputs '/web_analytics'

sftp.call_dir('Monitoring') outputs '/web_analytics/Monitoring'

sftp.write_file('test.txt', 'test')

sftp.quit()

SFTP and write file to remote server using SFTP

from datacoco_ftp_tools import SFTPInteraction


# Sample Code for SFTP Interaction

sftp = SFTPInteraction(sftp_site, user, None, key_file='key.ppk')

sftp.conn()

sftp.call_dir('Monitoring') outputs '/web_analytics/Monitoring'

sftp.write_file(schema[table], remote_path=path)

sftp.quit()

Development

Getting Started

It is recommended to use the steps below to set up a virtual environment for development:

python3 -m venv <virtual env name>
source <virtual env name>/bin/activate
pip install -r requirements.txt

Testing

pip install -r requirements-dev.txt

To run the testing suite, simply run the command: tox or python -m unittest discover tests

Contributing

Contributions to datacoco_ftp_tools are welcome!

Please reference guidelines to help with setting up your development environment here.