diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 42 |
1 files changed, 26 insertions, 16 deletions
| @@ -1,4 +1,4 @@ | |||
| 1 | Copyright (C) 2014-2018 - Simeon Simeonov | 1 | Copyright (C) 2014-2020 - Simeon Simeonov |
| 2 | See the end of the file for license conditions. | 2 | See the end of the file for license conditions. |
| 3 | 3 | ||
| 4 | 4 | ||
| @@ -10,14 +10,14 @@ on-screen-display notification scenarios. | |||
| 10 | 10 | ||
| 11 | The current version of BEINC contains the following components: | 11 | The current version of BEINC contains the following components: |
| 12 | beinc_server.py - server used for queueing or providing on-screen-display (OSD) | 12 | beinc_server.py - server used for queueing or providing on-screen-display (OSD) |
| 13 | beinc_poller.py - client used to fetch enqueued messages from beinc_server.py | 13 | beinc_pull.py - client used to fetch enqueued messages from beinc_server.py |
| 14 | and provide OSD | 14 | and provide OSD |
| 15 | beinc_weechat.py - a complete script / client for the Weechat IRC client >=0.4.0 | 15 | beinc_weechat.py - a complete script / client for the Weechat IRC client >=0.4.0 |
| 16 | used to push notification messages to beinc_server.py | 16 | used to push notification messages to beinc_server.py |
| 17 | beinc_generic_client.py - a simple client used to push notification messages | 17 | beinc_generic_client.py - a simple client used to push notification messages |
| 18 | to beinc_server.py | 18 | to beinc_server.py |
| 19 | Its main purpose is to provide a convenient way to | 19 | Its main purpose is to provide a convenient way to |
| 20 | test beinc_server.py (and beinc_poller.py) as well as | 20 | test beinc_server.py (and beinc_pull.py) as well as |
| 21 | to serve as an example for how to develop BEINC-clients | 21 | to serve as an example for how to develop BEINC-clients |
| 22 | + documentation and a sample configuration file (beinc_config_sample.json) | 22 | + documentation and a sample configuration file (beinc_config_sample.json) |
| 23 | 23 | ||
| @@ -28,7 +28,7 @@ BEINC is a free-software, licensed under the GPL3. It gives you the freedoms | |||
| 28 | of using it, studying it and modifying it. | 28 | of using it, studying it and modifying it. |
| 29 | 29 | ||
| 30 | BEINC is designed to assist you two common scenarios. | 30 | BEINC is designed to assist you two common scenarios. |
| 31 | As an example we will consider the case of an IRC cliet, although BEINC can be | 31 | As an example we will consider the case of an IRC client, although BEINC can be |
| 32 | used by any client that conforms with BEINC's "messaging protocol". | 32 | used by any client that conforms with BEINC's "messaging protocol". |
| 33 | 33 | ||
| 34 | We have the common situation where a user is accessing an IRC client located on | 34 | We have the common situation where a user is accessing an IRC client located on |
| @@ -66,20 +66,20 @@ Solution: | |||
| 66 | - set up the beinc_server.py on it. No OSD capabilities are needed (no X11). | 66 | - set up the beinc_server.py on it. No OSD capabilities are needed (no X11). |
| 67 | Define instance(s) for queueing. Define a queue size | 67 | Define instance(s) for queueing. Define a queue size |
| 68 | (how many notifications to store) for each of them. | 68 | (how many notifications to store) for each of them. |
| 69 | - set up beinc_poller.py on the desktop workstation (the computer where the | 69 | - set up beinc_pull.py on the desktop workstation (the computer where the |
| 70 | notification-message should be displayed). | 70 | notification-message should be displayed). |
| 71 | beinc_poller.py should be able to access the server running beinc_server.py | 71 | beinc_pull.py should be able to access the server running beinc_server.py |
| 72 | Polling interval of 5 seconds should be enough for most users. | 72 | Pulling interval of 5 seconds should be enough for most users. |
| 73 | 73 | ||
| 74 | Read beinc_config_sample.json.readme for details on how to setup | 74 | Read beinc_config_sample.json.readme for details on how to setup |
| 75 | beinc_server.py and beinc_weechat.py! | 75 | beinc_server.py and beinc_weechat.py! |
| 76 | Use "-h" command line parameter to display the available options for | 76 | Use "-h" command line parameter to display the available options for |
| 77 | beinc_poller.py and beinc_generic_client.py | 77 | beinc_pull.py and beinc_generic_client.py |
| 78 | Each configured beinc_server.py instance has an unique name. | 78 | Each configured beinc_server.py instance has an unique name. |
| 79 | There are 2 operations that can be done on an instance: | 79 | There are 2 operations that can be done on an instance: |
| 80 | - push - a client is sending a notification to the BEINC server. | 80 | - push - a client is sending a notification to the BEINC server. |
| 81 | A push is available for all instances. | 81 | A push is available for all instances. |
| 82 | - pull - a poller (f.i. beinc_poller.py) is fetching data from the instance-queue. | 82 | - pull - a pull (f.i. beinc_pull.py) is fetching data from the instance-queue. |
| 83 | A pull is available only for instances defined for queueing. | 83 | A pull is available only for instances defined for queueing. |
| 84 | (read beinc_config_sample.json.readme for details!) | 84 | (read beinc_config_sample.json.readme for details!) |
| 85 | Example: | 85 | Example: |
| @@ -91,28 +91,38 @@ your URL will be: https://hostname:port | |||
| 91 | 91 | ||
| 92 | Any system running the software required for the selected components. | 92 | Any system running the software required for the selected components. |
| 93 | All components tested on: Gentoo GNU/Linux, | 93 | All components tested on: Gentoo GNU/Linux, |
| 94 | Ubuntu GNU/Linux 16.4, 18.4, | 94 | Ubuntu GNU/Linux 18.4, |
| 95 | FreeBSD 10.x, 11.x | 95 | FreeBSD 12.x |
| 96 | 96 | ||
| 97 | 97 | ||
| 98 | ### Requirements | 98 | ### Requirements |
| 99 | All components: Python >= 2.7.9 or Python >= 3.4.* | 99 | All components: Python >= 3.6.* |
| 100 | 100 | ||
| 101 | beinc_server.py: pynotify >= 0.1 (optional) | 101 | beinc_server.py: pynotify >= 0.1 (optional) |
| 102 | beinc_weechat.py: Weechat >= 0.4.0 | 102 | beinc_weechat.py: Weechat >= 0.4.0 |
| 103 | beinc_poller.py: pynotify >= 0.1 | 103 | beinc_pull.py: pynotify >= 0.1 |
| 104 | beinc_generic_client.py: No additional software required | 104 | beinc_generic_client.py: No additional software required |
| 105 | 105 | ||
| 106 | Read INSTALL in this very same folder for more details about installing the requirements! | 106 | Read INSTALL in this very same folder for more details about installing the requirements! |
| 107 | 107 | ||
| 108 | 108 | ||
| 109 | ### License | 109 | ## Support and contributing |
| 110 | |||
| 111 | BEINC is hosted on GitHub: https://github.com/blackm0re/BEINC | ||
| 112 | |||
| 113 | |||
| 114 | ## Author | ||
| 115 | |||
| 116 | Simeon Simeonov - sgs @ Freenode | ||
| 117 | |||
| 118 | |||
| 119 | ## License | ||
| 110 | 120 | ||
| 111 | This file is part of BEINC. | 121 | This file is part of BEINC. |
| 112 | 122 | ||
| 113 | BEINC is free software: you can redistribute it and/or modify | 123 | BEINC is free software: you can redistribute it and/or modify |
| 114 | it under the terms of the GNU General Public License as published by | 124 | it under the terms of the GNU General Public License as published by |
| 115 | the Free Software Foundation, either version 3 of the License, or | 125 | the Free Software Foundation, either version 3 of the License, or |
| 116 | (at your option) any later version. | 126 | (at your option) any later version. |
| 117 | 127 | ||
| 118 | This program is distributed in the hope that it will be useful, | 128 | This program is distributed in the hope that it will be useful, |
