easy_py_messaging is a simple to use python wrapper around ZeroMQ for distributed systems to use for messaging. For illustration purposes, a non-trivial logging application is presented.
This package runs on most linux systems: Centos, Ubunty, Debian, Raspberry Py and like most other linux offerings. It does not run on Windows.
A logging application demonstrates the power of ZeroMQ and the implemented wrapper. This serves to use ZeroMQ in a non-trivial manners and to show how flexible python can be in messaging applications.
The Easy Py Messaging system provides lightweight messaging in a library which implements a ZeroMQ based messaging to privde logging facilities for distributed systems. This robust library uses the excellent ZeroMQ messaging system to allow easy interfacing with distributed systems. While specifically developed for distributed Raspberry Pis and similar systems, it is easily installed in almost any Linux system. Additionaly, this code works seamlessly when all processes exist on the same node.
This code contains a synchronous messaging API, a log collector to receive and store logs, a log filter application to receive, store and filter logs. Additional support utilities enhance and support this product.
The library contains easy-to-use python classes for interfacing with the lower level ZeroMQ messaging system. Users will enjoy the simplicity of interfacing these classes with their own applications.
The logging system can easily collect logs from remote systems and store them. Now consolidated log messages eases the problems associated with monitoring and debugging problems with distributed systems.
Installation consists of the normal:
git clone https://github.com/TrailingDots/easy_py_messaging.git
python setup.py install"sudo" may or may not be required depending upon your particular system configuration.
Your system may or may not require additional dependencies.
The backbone of this offering uses ZeroMQ for low level, fast message handling.
Install ZeroMQ from the above site. The instructions are straightforward and should present no problems.
You might need these tools. Most python developers have these already installed. See Installing pip/setuptools/wheel with Linux Package Managers. Windows and OSX are on sister pages.
If you choose to develop with code from this package, the runTests.sh script includes a somewhat exhaustive suite of testing that includes timing, unit tests and clean code checking.
This project has been careful to provide clean code as determined by pyflakes, unit test, python lint, etc.
To eliminate the static checkers, examing the section executing pyflakes, lizard, pep8, etc. and comment out these lines.
Pyflakes is a code analysis tool for Python. Pyflakes does not execute code, but rather analyzes the code. See pyflakes or this pyflakes and follow the installation instructions.
Cyclomatic complexity determines the complexity of Python code. Reducing the complexity allows code to usually be more readable, testable and maintainable.
This may be ignored by commenting out the lizard command in runTests.sh.
To install lizard, see lizard.
pep8 checks Python code against the recommended style conventions. See pep8 - Python style guide checker.
If desired, comment out the line in runTest.sh to ignore this.
The Python bindings for Zero MQ are required since the intent of the package drives an easy Zero MQ interface.
The distribution provides extensive documentation. Refer to Easy Py Messaging. Developers should start here.
A tutorial: Easy Py Messaging Tutorial.
This tutorial presents minimal logic for client and server code as well as tourbleshooting guidelines.
Easy Log Collection by Messaging represents a significant application using the messaging concepts implemented for this package. A log collector repsents a utility that most applications could use. Logging has been underrated in every site I have worked. Yet logging remains the primary debugging source of live systems. Without proper logging, knowledge of your working system will remain elusive and mysterious.
The project license is specified in COPYING and COPYING.LESSER.
Easy Py Messaging is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (LGPL) as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
As a special exception, the Contributors give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you must extend this exception to your version of the library.
Easy Py Messaging is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.