Metadata-Version: 2.1
Name: obz
Version: 3
Summary: Object Shell
Author-email: Bart Thate <bthate@dds.nl>
License: Public Domain
Project-URL: home, https://pypi.org/project/obz
Project-URL: bugs, https://github.com/otpcr/obz/issues
Project-URL: source, https://github.com/otpcr/obz
Classifier: Development Status :: 3 - Alpha
Classifier: License :: Public Domain
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Topic :: Utilities
Description-Content-Type: text/x-rst

**NAME**


``OBZ`` - Object Shell


**SYNOPSIS**


| ``obz <cmd> [key=val] [key==val]``
| ``obzd`` 
| ``obzs``
|

**DESCRIPTION**


``OBZ`` has all you need to program a unix cli program, such as disk
perisistence for configuration files, event handler to handle the
client/server connection, deferred exception handling to not crash
on an error, etc.

``OBX`` contains all the python3 code to program objects in a functional
way. It provides a base Object class that has only dunder methods, all
methods are factored out into functions with the objects as the first
argument. It is called Object Programming (OP), OOP without the
oriented.

``OBX`` allows for easy json save//load to/from disk of objects. It
provides an "clean namespace" Object class that only has dunder
methods, so the namespace is not cluttered with method names. This
makes storing and reading to/from json possible.

``OBZ`` is a demo bot, it can connect to IRC, fetch and display RSS
feeds, take todo notes, keep a shopping list and log text. You can
also copy/paste the service file and run it under systemd for 24/7
presence in a IRC channel.

``OBX/OBZ`` is Public Domain.


**INSTALL**


installation is done with pipx

| ``$ pipx install obz``
| ``$ pipx ensurepath``
|
| <new terminal>
|
| ``$ obz srv > obz.service``
| ``$ sudo mv obz.service /etc/systemd/system/``
| ``$ sudo systemctl enable obz --now``
|
| joins ``#obz`` on localhost
|


**USAGE**


use ``obz`` to control the program, default it does nothing

| ``$ obz``
| ``$``
|

see list of commands

| ``$ obz cmd``
| ``cfg,cmd,dne,dpl,err,exp,imp,log,mod,mre,nme,``
| ``now,pwd,rem,req,res,rss,srv,syn,tdo,thr,upt``
|

start daemon

| ``$ obzd``
| ``$``
|

start service

| ``$ obzs``
| ``<runs until ctrl-c>``
|


**COMMANDS**


here is a list of available commands

| ``cfg`` - irc configuration
| ``cmd`` - commands
| ``dpl`` - sets display items
| ``err`` - show errors
| ``exp`` - export opml (stdout)
| ``imp`` - import opml
| ``log`` - log text
| ``mre`` - display cached output
| ``now`` - show genocide stats
| ``pwd`` - sasl nickserv name/pass
| ``rem`` - removes a rss feed
| ``res`` - restore deleted feeds
| ``req`` - reconsider
| ``rss`` - add a feed
| ``syn`` - sync rss feeds
| ``tdo`` - add todo item
| ``thr`` - show running threads
| ``upt`` - show uptime
|

**CONFIGURATION**


irc

| ``$ obz cfg server=<server>``
| ``$ obz cfg channel=<channel>``
| ``$ obz cfg nick=<nick>``
|

sasl

| ``$ obz pwd <nsvnick> <nspass>``
| ``$ obz cfg password=<frompwd>``
|

rss

| ``$ obz rss <url>``
| ``$ obz dpl <url> <item1,item2>``
| ``$ obz rem <url>``
| ``$ obz nme <url> <name>``
|

opml

| ``$ obz exp``
| ``$ obz imp <filename>``
|


**PROGRAMMING**


``obz`` runs it's modules in the package, so you have to clone from git

| ``$ git clone ssh://git@github.com/otpcr/obz``
|

edit a file in obz/modules/<name>.py and add the following for ``hello world``

::

    def hello(event):
        event.reply("hello world !!")


save this and edit ``obz/modules/face.py`` and import your filename in there.
install that with ``pipx install . --force``, your program can execute the
``hello`` command now.


|
| ``$ obz hello``
| ``hello world !!``
|

commands run in their own thread, errors are deferred to not have loops
blocking/breaking on exception and can contain your own written python3
code, see the obx/modules directory for examples.


**SOURCE**


source is at `https://github.com/otpcr/obz  <https://github.com/otpcr/obz>`_


**FILES**


| ``~/.obz``
| ``~/.local/bin/obz``
| ``~/.local/bin/obzd``
| ``~/.local/bin/obzs``
| ``~/.local/pipx/venvs/obz/*``
|

**AUTHOR**


| Bart Thate <``bthate@dds.nl``>
|

**COPYRIGHT**


| ``OBZ`` is Public Domain.
|
