Skip to main content

A simple file transfer service

Project description

Reloc

Features

  • Serves as a simple file transfer service between client and server. Initially designed for easy transfer of files to single-board computers, such as the Raspberry Pi.
  • Can be used both locally on the network or externally over the internet.
  • Reloc can be used as a command-line application for easier transfer of files from the command prompt.

Installation

$ pip3 install reloc

Usage

Server-side

Start server where you want to receive files. If no path is specified the home folder is used. Two modes of the server can be used; internal or external. By using the internal mode, only connection over the local network is possible. By using external mode, connection to the server can be made over the internet if the specified port is open in the network.

import reloc

# Starting server to handle external connections, i.e. over the internet.
server = reloc.server(mode = 'external', port = 1750, 
    def_path = '/users/antonnormelius/documents')

# Start listening for incoming data stream.
server.receive()

Client-side

Client is used to transfer files and folders to server. Observe that the host and port for the client need to be the same as the host and port for the server.

import reloc

# Connecting to external server.
client = reloc.client(host = '92.34.13.274', port = 1750)

# Sending a text file.
filename = 'test.txt'
client.transmit(filename)

# Sending a folder.
foldername = 'test'
client.transmit(foldername)

# Disconnect from the client.
client.disconnect()

Command-Line Application

Reloc can be used as a command-line application in order to transfer files to the server using the command prompt, i.e. terminal.

Transfer of files/folders.
# Send file internally.
$ reloc send file.txt

# Send folder internally.
$ reloc send foldername

# Send file externally.
$ reloc send file.txt --host 92.34.13.274 --port 1750

# Send folder externally.
$ reloc send foldername --host 92.34.13.274 --port 1750
Start server both internally and externally.
# Start internal server, i.e. using localhost and predefined port.
$ reloc start internal

# Start external server. Observe that port needs to be specified.
$ reloc start external 1750

# Start external server on predefined host and port.
$ reloc start external 1750 --host 192.168.1.10

Releases

  • 0.0.4 - Major updates to how the CLI works.
  • 0.0.3 - Initial stable release.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reloc-0.0.6.tar.gz (9.9 kB view hashes)

Uploaded Source

Built Distribution

reloc-0.0.6-py3-none-any.whl (11.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page