transfer-client: Transfer client library and CLI.
Project description
# Transfer client
This package provides functions for communication with the Restful Transfer
Server.
## Installation
Via pypi:
pip install transfer_client
From source:
git clone https://git.lumc.nl/j.k.vis/transfer.git
cd transfer/transfer_client
pip install .
## Command line interface
Use the command `transfer_client -h` for a list of subcommands. For every
subcommand a separate help is available, e.g.,
```
$ transfer_client users -h
usage: transfer_client users [-h] [-o OUTPUT] SERVER USER
Gives a JSON object of a user together with its transfers.
positional arguments:
SERVER server name
USER user id
optional arguments:
-h, --help show this help message and exit
-o OUTPUT output file
```
### Typical usage
The three high level subcommands are probably the only ones needed.
To transfer a list of files, use the `transfer` subcommand. We assume that the
server name is `server.domain` and the user ID is `xxxxxxxx`.
transfer_client transfer server.domain xxxxxxxx *.gz
If a transfer is interrupted for some reason, it can be resumed with the
`resume` subcommand.
transfer_client resume server.domain xxxxxxxx
To cancel an interrupted transfer, the `cancel` subcommand can be used.
transfer_client cancel server.domain xxxxxxxx
## Library
The library implements an interface to the API of the Restful Transfer server.
Full documentation can be found [here](https://git.lumc.nl/j.k.vis/transfer).
### Usage
To use the interface, we first make a class instance of `TransferClient`, then
we can use the API endpoints.
```python
>>> from transfer_client.transfer_client import TransferClient
>>>
>>> # Create a class instance for a server running on server.domain.
>>> transfer_client = TransferClient('server.domain')
>>>
>>> # Get user information together with its transfers.
>>> transfer_client.users('xxxxxxxx')
{ ... }
```
This package provides functions for communication with the Restful Transfer
Server.
## Installation
Via pypi:
pip install transfer_client
From source:
git clone https://git.lumc.nl/j.k.vis/transfer.git
cd transfer/transfer_client
pip install .
## Command line interface
Use the command `transfer_client -h` for a list of subcommands. For every
subcommand a separate help is available, e.g.,
```
$ transfer_client users -h
usage: transfer_client users [-h] [-o OUTPUT] SERVER USER
Gives a JSON object of a user together with its transfers.
positional arguments:
SERVER server name
USER user id
optional arguments:
-h, --help show this help message and exit
-o OUTPUT output file
```
### Typical usage
The three high level subcommands are probably the only ones needed.
To transfer a list of files, use the `transfer` subcommand. We assume that the
server name is `server.domain` and the user ID is `xxxxxxxx`.
transfer_client transfer server.domain xxxxxxxx *.gz
If a transfer is interrupted for some reason, it can be resumed with the
`resume` subcommand.
transfer_client resume server.domain xxxxxxxx
To cancel an interrupted transfer, the `cancel` subcommand can be used.
transfer_client cancel server.domain xxxxxxxx
## Library
The library implements an interface to the API of the Restful Transfer server.
Full documentation can be found [here](https://git.lumc.nl/j.k.vis/transfer).
### Usage
To use the interface, we first make a class instance of `TransferClient`, then
we can use the API endpoints.
```python
>>> from transfer_client.transfer_client import TransferClient
>>>
>>> # Create a class instance for a server running on server.domain.
>>> transfer_client = TransferClient('server.domain')
>>>
>>> # Get user information together with its transfers.
>>> transfer_client.users('xxxxxxxx')
{ ... }
```
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
transfer-client-0.0.2.tar.gz
(5.6 kB
view hashes)