Metadata-Version: 2.0
Name: ftp-proxy-client
Version: 0.0.4
Summary: python client for ftp-proxy server
Home-page: https://github.com/uptilab2/ftp_proxy_client
Author: Emile Caron
Author-email: emile.caron@outlook.com
License: UNKNOWN
Project-URL: Source, https://github.com/uptilab2/ftp_proxy
Keywords: ftp proxy client
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: flake8; extra == 'dev'

# ftp-proxy-client ![travis](https://travis-ci.com/uptilab2/ftp-proxy-client.svg?branch=master)
An FTP client for [ftp-proxy](https://github.com/uptilab2/ftp-proxy)

## Current features:
- Test successful connection to FTP server through proxy
- List files and directories
- Download a file

## Installation
`pip install ftp-proxy-client`

## Usage
```
    ftp_proxy = FtpProxy(host='foo', port=8080)
    ftp_client = ftp_proxy.connect('192.168.0.1', port=8080, login='foobar')

    assert ftp_client.ping() is True
    files, directories = ftp_client.ls()
    assert files and directories

    files2, directories = ftp_client.ls(recursive=True)
    assert len(files2) > len(files)

    files3, directories = ftp_client.ls(recursive=True, extension='.txt')
    assert not directories
    assert files3[0].endswith('.txt')

    fp = ftp_client.download(path='/foo.txt')
    with open('/tmp/foo.txt', 'wb') as ff:
    ff.write(fp.read())
    assert fp.tell() > 0
```


