A http to ftp proxy server application
Project description
# ftp-proxy ![travis](https://travis-ci.com/uptilab2/ftp-proxy.svg?branch=master)
Http proxy to interact with FTP servers
## Install
`pip install ftp-proxy`
## Deployment
Use the provided [docker image](https://hub.docker.com/r/emilecaron/ftp-proxy)
## Usage
### Using the python client
See [client repository](https://github.com/uptilab2/ftp-proxy-client)
### Using an http client
ftp-proxy can be used with any http client
#### Authentication headers
All api routes expect the same authentication headers
| Header | Content | Default |
|--------|---------|---------|
| `X-ftpproxy-host` | server host | No default, mandatory header |
| `X-ftpproxy-port` | server port | 21 |
| `X-ftpproxy-user` | login | anonymous |
| `X-ftpproxy-password` | password | |
#### Available routes
##### Ping (/ftp/ping)
Test connection to the remote FTP server
Returns HTTP 200 on success
##### LS (ftp/ls)
List the files on the ftp server
Optional parameters:
- path (string): path to list content. Defaults to "/"
- recursive (true/false): recurse down subdirectories. Defaults to "false"
- extension (string): list only files with matching extension if provided (example: ".py")
Response:
```javascript
["/file1.txt", "/other.py", "/folder", "/folder/nested.txt", "/folder/subfolder"]
```
##### Download (/ftp/download)
Download a file from the ftp server
Mandatory parameters:
- path (string): path to file to download
##### SFTP support
SFTP support API is roughly the same as ftp, and can be achieved by switching the url prefixes from ftp to sftp
The following features are not yet available for SFTP:
- recursive listing
- extension filtering
#### Errors
If an error occured on the proxy or the FTP server, the request will return a HTTP 400 json response with the following format
```javascript
{
"error": "<DESCRIPTION>"
}
```
## Development
### Setup
```sh
git clone git@github.com:uptilab2/ftp-proxy.git
cd ftp-proxy
# Project uses pipenv for dependency management
# so it should be installed first
pipenv install --dev
# Run the tests:
pipenv run py.test
# Run the development server:
pipenv run python -m aiohttp.web -H 0.0.0.0 -P 5000 ftp_proxy:init_func
```
Http proxy to interact with FTP servers
## Install
`pip install ftp-proxy`
## Deployment
Use the provided [docker image](https://hub.docker.com/r/emilecaron/ftp-proxy)
## Usage
### Using the python client
See [client repository](https://github.com/uptilab2/ftp-proxy-client)
### Using an http client
ftp-proxy can be used with any http client
#### Authentication headers
All api routes expect the same authentication headers
| Header | Content | Default |
|--------|---------|---------|
| `X-ftpproxy-host` | server host | No default, mandatory header |
| `X-ftpproxy-port` | server port | 21 |
| `X-ftpproxy-user` | login | anonymous |
| `X-ftpproxy-password` | password | |
#### Available routes
##### Ping (/ftp/ping)
Test connection to the remote FTP server
Returns HTTP 200 on success
##### LS (ftp/ls)
List the files on the ftp server
Optional parameters:
- path (string): path to list content. Defaults to "/"
- recursive (true/false): recurse down subdirectories. Defaults to "false"
- extension (string): list only files with matching extension if provided (example: ".py")
Response:
```javascript
["/file1.txt", "/other.py", "/folder", "/folder/nested.txt", "/folder/subfolder"]
```
##### Download (/ftp/download)
Download a file from the ftp server
Mandatory parameters:
- path (string): path to file to download
##### SFTP support
SFTP support API is roughly the same as ftp, and can be achieved by switching the url prefixes from ftp to sftp
The following features are not yet available for SFTP:
- recursive listing
- extension filtering
#### Errors
If an error occured on the proxy or the FTP server, the request will return a HTTP 400 json response with the following format
```javascript
{
"error": "<DESCRIPTION>"
}
```
## Development
### Setup
```sh
git clone git@github.com:uptilab2/ftp-proxy.git
cd ftp-proxy
# Project uses pipenv for dependency management
# so it should be installed first
pipenv install --dev
# Run the tests:
pipenv run py.test
# Run the development server:
pipenv run python -m aiohttp.web -H 0.0.0.0 -P 5000 ftp_proxy:init_func
```
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ftp-proxy-0.0.8.tar.gz
(7.5 kB
view hashes)
Built Distribution
Close
Hashes for ftp_proxy-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00d32ffbfe6d4e62960d301a12971615654cfcc1c0fa0b669fdb5ac4f7500f3c |
|
MD5 | e15d97ecf463a0993d62b5f9a3d79796 |
|
BLAKE2b-256 | 7b0019feab8b31ebb745090e0f0a6899f904ae7920c28075e42ae23ef6fac8cf |