Metadata-Version: 2.1
Name: opd
Version: 310
Summary: Original Programmer Daemon
Author-email: Bart Thate <bthate@dds.nl>
License: Public Domain
Project-URL: home, https://pypi.org/project/opd
Project-URL: bugs, https://github.com/bthate/opd/issues
Project-URL: source, https://github.com/bthate/opd
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
Provides-Extra: dev

**NAME**


``opd`` - Original Programmer Daemon


**SYNOPSIS**

|
| ``opdctl <cmd> [key=val] [key==val]``
| ``opdc [-cviw]``
| ``opd`` 
| ``opds``
|

**DESCRIPTION**


``opd`` is a python3 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.

``opd`` 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.

``opd`` 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.

``opd`` 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.

``opd`` is Public Domain.


**INSTALL**

installation is done with pipx

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

**USAGE**

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

|
| ``$ opdctl``
| ``$``
|

see list of commands

|
| ``$ opd 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

|
| ``$ opd``
| ``$``
|

start service

|
| ``$ opds``
| ``<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

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

sasl

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

rss

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

opml

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

**SOURCE**

source is at `https://github.com/bthate/opd  <https://github.com/bthate/opd>`_


**FILES**

|
| ``~/.opd``
| ``~/.local/bin/opd``
| ``~/.local/bin/opdc``
| ``~/.local/bin/opdctl``
| ``~/.local/bin/opds``
| ``~/.local/pipx/venvs/opd/*``
|

**AUTHOR**

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

**COPYRIGHT**

|
| ``OPD`` is Public Domain.
|
