Welcome to zget’s documentation!¶

Zget is a simple, Zeroconf-based, peer to peer file transfer utility, for situations where you and your peer are sitting next to each other and want to transfer a file quickly (and can shout the filename across the room).

Files and peers are recognized by the filename they want to transfer, not by their hostnames or IPs.

zget uses the fact that the filename is known to both parties as a basic authentication feature: The sender only advertises the sha1 hash of the filename on the network. Since the receiver must also know the filename, it can look for the sha1 using zeroconf.

If a match was found, a simple HTTP request is made: For transferring the file the actual filename is then requested from the sender. If this filename wasn’t correct, the process is aborted.

The only third party dependency is zeroconf, a platform independent pure-Python Zeroconf implementation.

$ zput file.zip

on the sender and

$ zget file.zip

on the receiver.

Done.

Contents:

Command Line Interface¶

After installing, this toolkit provides a two command line utilities

$ zget

and

$ zput

Upload¶

zput knows a few parameters that allow you to set the behaviour to your needs:

-a ADDRESS lets you manually set the IP address to broadcast and bind to (e.g. 192.168.0.1)

-i INTERFACE lets you manually select the network card to broadcast on (e.g. eth0)

-p PORT lets you manually select the port to open. (e.g. 8080)

-v (one or more) lets you increase verbosity, to debug failing connections.

-q lets you hide the progress bar, for batch processing.

-t SECONDS lets you set a timeout after which the transfer is aborted and a non-zero exit value is returned

-V Show version number and exit.

-h Show help and exit.

Download¶

zget knows a few parameters that allow you to set the behaviour to your needs:

-v (one or more) lets you increase verbosity, to debug failing connections.

-q lets you hide the progress bar, for batch processing.

-t SECONDS lets you set a timeout after which the transfer is aborted and a non-zero exit value is returned

-V Show version number and exit.

-h Show help and exit.

Note

Each unit provides a help-switch -h to investigate its parameters.

Python Interface¶

zget package¶

Module contents¶

`zget.get`(filename[, output, reporthook, timeout])	Receive and save a file using the zget protocol.
`zget.put`(filename[, output, interface, ...])	Send a file using the zget protocol.
`zget.TimeoutException`([msg])	Exception raised when a timeout was hit.

Module reference¶

zget.get(filename, output=None, reporthook=None, timeout=None)¶

Receive and save a file using the zget protocol.

Parameters:

filename : string

The filename to be transferred

output : string

The filename to save to. Optional.

reporthook : callable

A hook that will be called during transfer. Handy for watching the transfer. See urllib.urlretrieve for callback parameters. Optional.

timeout : int

Seconds to wait until process is aborted. A running transfer is not aborted even when timeout was hit. Optional.

Raises:

TimeoutException

When a timeout occurred.

zget.put(filename, output=None, interface=None, address=None, port=None, reporthook=None, timeout=None)¶

Send a file using the zget protocol.

Parameters:

filename : string

The filename to be transferred

output : string

The alias to share on the network. Optional. If empty, the input filename will be used.

interface : string

The network interface to use. Optional.

address : string

The network address to use. Optional.

port : int

The network port to use. Optional.