Skip to main content

light-weight support for connecting different python scripts

Project description

EasyCommunications (EComs): easy handling of communication between python scripts

This library is a light-weight support for connecting different python scripts via TCP

Installation

The minimal required python version is Python3.6. The easiest installation can be done by pip3 install EasyCommunications.

Getting started

Once installed, just import the package by import ecoms. For exchanging data between two endpoints (the scripts), one must be the master and the other one the slave. The master must open the connection first for the slave to connect to it. Once the scripts are connected, communication is completely bi-directional.

Master

Initialize the communication and send "abc" as payload to the slave and wait infinitely until answering:
master = EasyCommunicationMaster(some_port)
master.send(payload="abc")
data = master.wait_until_receiving()

Slave

Initialize the communication and echo received payload "abc":
slave = EasyCommunicationSlave(master_ip, master_port)
data = slave.wait_until_receiving()
slave.send(statusCode=200, payload=data.payload)

Quickstart tip

In /tests there is an example master echoing everything sent to from localhost.
Just fire it up for testing with python3 tests/echo_master.py port.

Documentation

For further guidance and help look at the documentation

Requests & contribution

If you desire anything changed in the package or need another feature please just create an issue.

I am happy for everybody wanting to contribute. Simplest way is to start writing issues, forking the repository and contacting me ;)

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

EasyCommunications-0.1.5.tar.gz (6.3 kB view hashes)

Uploaded Source

Built Distribution

EasyCommunications-0.1.5-py3-none-any.whl (11.8 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