walkr / oi Goto Github PK

View Code? Open in Web Editor NEW

234.0 12.0 10.0 43 KB

python library for writing long running processes with a cli interface

License: MIT License

Makefile 3.71% Python 96.29%

python nanomsg

oi's Introduction

oi

python library for writing long running processes with a cli interface

Install

Note: You need nanomsg installed on your system:

$ git clone [email protected]:nanomsg/nanomsg.git
$ cd nanomsg
$ ./configure
$ make
$ make check
$ sudo make install

Then install oi

$ pip install oi

Usage

####1. Write your long running program

# programd.py

import oi

program = oi.Program('my program', 'ipc:///tmp/program.sock')
program.add_command('ping', lambda: 'pong')
program.add_command('state', lambda: program.state)
program.run()  # program will run forever

####2. Add a ctl interface

# programctl.py

import oi

ctl = oi.CtlProgram('ctl program', address='ipc:///tmp/program.sock')
ctl.run()

####3. Run program, then connect to it via ctl

# Run process
$ python programd

# OR with a configuration file
$ python programd --config /etc/program.conf

$ python programctl  # enter ctl loop
programctl > ping
pong

# OR ping end exit
$ python programctl ping

Quickly get started with a new project

$ mkdir xprogram
$ cd xprogram

$ oi init
$ make install

# Start your program
$ xprogramd

# Start ctl program
$ xprogramctl
ctl > ping
pong

# Upload to pypi (Edit setup.py before distributing)
$ make distribute

Now the interesting bit. Are you ready?

Run your program on one computer, then control it from another with a single line change (actually two).

Just change the address ipc:///tmp/program.sock to a tcp address, such as tcp://192.168.1.100:5000 in both your programd.py and programctl.py. That's it! (:

TODO

Add more testing

License

MIT License

oi's People

Stargazers

Watchers

Forkers

intermezzo-fr chrisidefix richwu janjaapbos pombredanne skyformat99 yutiansut zortanin iq-scm gkuo06

oi's Issues

Missing Dependency Under Ubuntu

The package complains about there being no libhttpmsg library available and it doesn't seem to be [readily] available under Ubuntu:

Traceback (most recent call last):
  File "programd.py", line 2, in <module>
    import oi
  File "/usr/local/lib/python2.7/dist-packages/oi/__init__.py", line 1, in <module>
    from .core import *
  File "/usr/local/lib/python2.7/dist-packages/oi/core.py", line 8, in <module>
    from nanoservice import Service
  File "/usr/local/lib/python2.7/dist-packages/nanoservice/__init__.py", line 1, in <module>
    from .client import *
  File "/usr/local/lib/python2.7/dist-packages/nanoservice/client.py", line 27, in <module>
    import nanomsg
  File "/usr/local/lib/python2.7/dist-packages/nanomsg/__init__.py", line 7, in <module>
    from . import wrapper
  File "/usr/local/lib/python2.7/dist-packages/nanomsg/wrapper.py", line 4, in <module>
    _wrapper = _load_wrapper()
  File "/usr/local/lib/python2.7/dist-packages/nanomsg_wrappers/__init__.py", line 23, in load_wrapper
    return importlib.import_module('_nanomsg_ctypes')
  File "/usr/lib/python2.7/importlib/__init__.py", line 37, in import_module
    __import__(name)
  File "/usr/local/lib/python2.7/dist-packages/_nanomsg_ctypes/__init__.py", line 13, in <module>
    _lib = ctypes.cdll.LoadLibrary('libnanomsg.so')
  File "/usr/lib/python2.7/ctypes/__init__.py", line 443, in LoadLibrary
    return self._dlltype(name)
  File "/usr/lib/python2.7/ctypes/__init__.py", line 365, in __init__
    self._handle = _dlopen(self._name, mode)
OSError: libnanomsg.so: cannot open shared object file: No such file or directory

AttributeError when creating an oi.CtlProgram instance

I was testing the example on the web page, but when I try to instantiate a CtlProgram class I get:

Traceback (most recent call last):
  File "programctl.py", line 5, in <module>
    ctl = oi.CtlProgram('ctl program', address='ipc:///tmp/program.sock')
  File "/home/antonio/git/others/oi/oi/core.py", line 257, in __init__
    self.client = ClientWrapper(address, timeout) if address else None
  File "/home/antonio/git/others/oi/oi/core.py", line 149, in __init__
    self.c = self.create_client(address, timeout)
  File "/home/antonio/git/others/oi/oi/core.py", line 163, in create_client
    return make(addr)
  File "/home/antonio/git/others/oi/oi/core.py", line 156, in make
    c.sock._set_recv_timeout(timeout)
AttributeError: 'Client' object has no attribute 'sock'

The issue is solved by just removing the call to c.sock._set_recv_timeout(timeout) in https://github.com/walkr/oi/blob/master/oi/core.py#L156

Does the TCP command channel work under TLS?

Would be nice to have encrypted comms.

oi.Program.run() and argument parsing

I want to include oi to enable IPC to a daemon I am writing.

Unfortunately, it seems that oi.Program class is parsing the command line, but since my program uses cli.app parser to include some option that the internal parser of oi.Program does not recognize, it fails when oi.Program.run() is called (and some options oi.Program doesn't recognize are passed)

This code, for instance, will fail if you run it with option --foo:

#!/usr/bin/env python

import cli
import cli.app
import logging
import oi
import os
import threading
import time

class Daemon(cli.app.CommandLineApp):

    def setup(self):
        super(Daemon, self).setup()
        self.add_param('--foo', action='store_true')

    def main(self):
        wdir = os.getcwd()

        def commthread():
            try:
                comm = oi.Program(
                    "daemon",
                    "ipc://%s/daemon.sock" % wdir)
                comm.add_command("ping", lambda: "pong")
                comm.run()
            except Exception as ex:
                print("Error while running oi: %s" % ex)

        self.comm = threading.Thread(target=commthread)
        self.comm.start()
        # main loop
        self.main_loop()

    def main_loop(self):
        self.log.info("Entering main loop")
        it = 0
        while True:
            it += 1
            time.sleep(1)

if __name__ == "__main__":
    Daemon().run()

The program will hang and print the following error:

usage: daemon_buggy.py [-h] [--version] [--debug] [--config [CONFIG]]
daemon_buggy.py: error: unrecognized arguments: --foo

I have found a workaround: just passing an args class to oi.Program.run() with the following attributes will avoid the problem:

debug
version
config

but it's not a clean solution. Do you have any alternative to fix this issue?

walkr / oi Goto Github PK

oi's Introduction

oi

Install

Usage

Quickly get started with a new project

Now the interesting bit. Are you ready?

TODO

License

oi's People

Stargazers

Watchers

Forkers

oi's Issues

Missing Dependency Under Ubuntu

AttributeError when creating an oi.CtlProgram instance

Does the TCP command channel work under TLS?

oi.Program.run() and argument parsing

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent