Skip to main content

python library for writing long running processes with a cli interface

Build Status

oi image

oi image

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 p: 'pong')
program.add_command('state', lambda p: p.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

$ python programd --config /etc/program.conf

$ python programctl  # enter ctl loop
programctl > ping
pong

$ python programctl ping # OR ping end exit

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

Release files for oi 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for oi 0.3.2
File Size Uploaded
oi-0.3.2.tar.gz 5.9 kB Details

Release files / oi-0.3.2.tar.gz

Download URL oi-0.3.2.tar.gz
Size 5.9 kB
Tags Source
SHA-256 checksum
How to use checksums
e8bc223cc39e8655ac68a9f649a173801b53c68c783a724943f12daed11bec7b
BLAKE2b-256 checksum
How to use checksums
1a06a5dcf00a234680fbcfe379382c8617f849ed4743a5a632d2cc2602a2ec55
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

0.4.2

1 release file

0.4.1

1 release file

0.3.6

1 release file

0.3.5

1 release file

This release

0.3.2 This release

1 release file

0.3.1

0.3.0

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page