~mdkcore/jackplug

ZMQ based microservice communications library
1c000f2e — Rodrigo Oliveira 11 months ago
Update README.md
5046b37e — Rodrigo Oliveira 11 months ago
Bump version
d0e53e91 — Rodrigo Oliveira 11 months ago
Update requirements and remove tornado as dependency

clone

read-only
https://git.sr.ht/~mdkcore/jackplug
read/write
git@git.sr.ht:~mdkcore/jackplug

You can also use your local clone with git send-email.

#JackPlug

ZMQ based microservice communications library

Two transports are supported: ipc (though IPCEndpoint, using the following path as default: /tmp/jack.plug), and tcp (TCPEndpoint, using 3559 as the default port number).

#Requirements

  • pyzmq >= 19.0.2

#Development requirements:

  • python 3.8
  • pyenv 1.2.20 (optional)

#Installation instructions for development:

  • Install pyenv (optional):

    • macos:

        $ brew install pyenv
      
    • linux:

  • Create a new python virtualenv (optional):

      $ pyenv install 3.8.5
      $ pyenv virtualenv 3.8.5 jackplug
      $ pyenv activate jackplug
    
  • Install python requirements:

      $ pip install -r requirements.txt
    

#Examples

An example of the use of this library can be found on the examples folder, and running them is pretty straightforward:

Run examples/jack.py and examples/plug.py, in different terminals. You should set the same transport argument on both of them (ipc or tcp).

$ python examples/jack.py ipc
$ python examples/plug.py ipc