bisos.debian 0.11__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- bisos.debian-0.11/MANIFEST.in +6 -0
- bisos.debian-0.11/PKG-INFO +238 -0
- bisos.debian-0.11/README.org +176 -0
- bisos.debian-0.11/README.rst +220 -0
- bisos.debian-0.11/bin/bifSystemd.cs +260 -0
- bisos.debian-0.11/bisos/__init__.py +1 -0
- bisos.debian-0.11/bisos/debian/__init__.py +0 -0
- bisos.debian-0.11/bisos/debian/bifSystemd.py +690 -0
- bisos.debian-0.11/bisos/debian/configFile.py +412 -0
- bisos.debian-0.11/bisos.debian.egg-info/PKG-INFO +238 -0
- bisos.debian-0.11/bisos.debian.egg-info/SOURCES.txt +18 -0
- bisos.debian-0.11/bisos.debian.egg-info/dependency_links.txt +1 -0
- bisos.debian-0.11/bisos.debian.egg-info/not-zip-safe +1 -0
- bisos.debian-0.11/bisos.debian.egg-info/requires.txt +7 -0
- bisos.debian-0.11/bisos.debian.egg-info/top_level.txt +1 -0
- bisos.debian-0.11/lh-agpl3-LICENSE.txt +679 -0
- bisos.debian-0.11/pyproject.toml +3 -0
- bisos.debian-0.11/setup.cfg +4 -0
- bisos.debian-0.11/setup.py +110 -0
|
@@ -0,0 +1,238 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: bisos.debian
|
|
3
|
+
Version: 0.11
|
|
4
|
+
Summary: bisos.MODULE: Python Command-Services for
|
|
5
|
+
Home-page: http://www.by-star.net/PLPC/180047
|
|
6
|
+
Download-URL: http://www.by-star.net/PLPC/180047
|
|
7
|
+
Author: Mohsen Banan
|
|
8
|
+
Author-email: libre@mohsen.1.banan.byname.net
|
|
9
|
+
Maintainer: Mohsen Banan
|
|
10
|
+
Maintainer-email: libre@mohsen.1.banan.byname.net
|
|
11
|
+
License: AGPL
|
|
12
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
|
|
15
|
+
Classifier: Operating System :: POSIX
|
|
16
|
+
Classifier: Programming Language :: Python
|
|
17
|
+
Classifier: Topic :: Software Development :: Libraries
|
|
18
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
19
|
+
|
|
20
|
+
Panel Controls:: `Show-All <elisp:(show-all)>`__
|
|
21
|
+
`Overview <elisp:(org-shifttab)>`__
|
|
22
|
+
`Content <elisp:(progn (org-shifttab) (org-content))>`__ \|
|
|
23
|
+
`(1) <elisp:(delete-other-windows)>`__ \|
|
|
24
|
+
`S&Q <elisp:(progn (save-buffer) (kill-buffer))>`__
|
|
25
|
+
`Save <elisp:(save-buffer)>`__ `Quit <elisp:(kill-buffer)>`__
|
|
26
|
+
`Bury <elisp:(bury-buffer)>`__ Links:
|
|
27
|
+
`file:./panels/_nodeBase_/fullUsagePanel-en.org <./panels/_nodeBase_/fullUsagePanel-en.org>`__
|
|
28
|
+
(Package Panel)
|
|
29
|
+
|
|
30
|
+
Overview
|
|
31
|
+
========
|
|
32
|
+
|
|
33
|
+
bisos.MODULE is a python package that uses the PyCS-Framework for
|
|
34
|
+
NOTYET. It is a BISOS-Capability and a Standalone-BISOS-Package.
|
|
35
|
+
|
|
36
|
+
*bisos.MODULE* is based on PyCS-Foundation and can be used both as a
|
|
37
|
+
Command and as a Service (invoke/perform model of remote operations)
|
|
38
|
+
using RPYC for central management of multiple systems.
|
|
39
|
+
|
|
40
|
+
.. _table-of-contents:
|
|
41
|
+
|
|
42
|
+
Table of Contents TOC
|
|
43
|
+
=====================
|
|
44
|
+
|
|
45
|
+
- `Overview <#overview>`__
|
|
46
|
+
- `About BISOS — ByStar Internet Services Operating
|
|
47
|
+
System <#about-bisos-----bystar-internet-services-operating-system>`__
|
|
48
|
+
- `bisos.MODULE is a Command Services (PyCS)
|
|
49
|
+
Facility <#bisosmodule-is-a-command-services-pycs-facility>`__
|
|
50
|
+
- `Uses of bisos.MODULE <#uses-of-bisosmodule>`__
|
|
51
|
+
- `bisos.MODULE as a Standalone Piece of
|
|
52
|
+
BISOS <#bisosmodule-as-a-standalone-piece-of-bisos>`__
|
|
53
|
+
- `Installation <#installation>`__
|
|
54
|
+
|
|
55
|
+
- `With pip <#with-pip>`__
|
|
56
|
+
- `With pipx <#with-pipx>`__
|
|
57
|
+
|
|
58
|
+
- `Usage <#usage>`__
|
|
59
|
+
|
|
60
|
+
- `Locally (system command-line) <#locally-system-command-line>`__
|
|
61
|
+
- `Remotely (as a service –
|
|
62
|
+
Performer+Invoker) <#remotely-as-a-service----performerinvoker>`__
|
|
63
|
+
|
|
64
|
+
- `Performer <#performer>`__
|
|
65
|
+
- `Invoker <#invoker>`__
|
|
66
|
+
|
|
67
|
+
- `Use by Python script <#use-by-python-script>`__
|
|
68
|
+
|
|
69
|
+
- `bisos.MODULE Source Code is in writen in COMEEGA
|
|
70
|
+
(Collaborative Org-Mode Enhanced Emacs Generalized Authorship)
|
|
71
|
+
– <#bisosmodule-source-code-is-in-writen-in-comeega-collaborative-org-mode-enhanced-emacs-generalized-authorship----httpsgithubcombx-bleecomeega>`__\ https://github.com/bx-blee/comeega\ `. <#bisosmodule-source-code-is-in-writen-in-comeega-collaborative-org-mode-enhanced-emacs-generalized-authorship----httpsgithubcombx-bleecomeega>`__
|
|
72
|
+
- `The primary API for bisos.MODULE is
|
|
73
|
+
./bisos/MODULE/MODULE-csu.py. It is self documented in
|
|
74
|
+
COMEEGA. <#the-primary-api-for-bisosmodule-is-bisosmodulemodule-csupy-it-is-self-documented-in-comeega>`__
|
|
75
|
+
|
|
76
|
+
- `Documentation and Blee-Panels <#documentation-and-blee-panels>`__
|
|
77
|
+
|
|
78
|
+
- `bisos.MODULE Blee-Panels <#bisosmodule-blee-panels>`__
|
|
79
|
+
|
|
80
|
+
- `Support <#support>`__
|
|
81
|
+
|
|
82
|
+
About BISOS — ByStar Internet Services Operating System
|
|
83
|
+
=======================================================
|
|
84
|
+
|
|
85
|
+
Layered on top of Debian, **BISOS**: (By\* Internet Services Operating
|
|
86
|
+
System) is a unified and universal framework for developing both
|
|
87
|
+
internet services and software-service continuums that use internet
|
|
88
|
+
services. See `Bootstrapping ByStar, BISOS and
|
|
89
|
+
Blee <https://github.com/bxGenesis/start>`__ for information about
|
|
90
|
+
getting started with BISOS.
|
|
91
|
+
|
|
92
|
+
*bisos.MODULE* as a PyCS facility is a small piece of a much bigger
|
|
93
|
+
picture. **BISOS** is a foundation for **The Libre-Halaal ByStar Digital
|
|
94
|
+
Ecosystem** which is described as a cure for losses of autonomy and
|
|
95
|
+
privacy that we are experiencing in a book titled: `Nature of
|
|
96
|
+
Polyexistentials <https://github.com/bxplpc/120033>`__
|
|
97
|
+
|
|
98
|
+
bisos.MODULE is a Command Services (PyCS) Facility
|
|
99
|
+
==================================================
|
|
100
|
+
|
|
101
|
+
bisos.MODULE can be used locally on command-line or remotely as a
|
|
102
|
+
service. bisos.MODULE is a PyCS multi-unit command-service. PyCS is a
|
|
103
|
+
framework that converges developement of CLI and Services. PyCS is an
|
|
104
|
+
alternative to FastAPI, Typer and Click.
|
|
105
|
+
|
|
106
|
+
bisos.MODULE uses the PyCS Framework to:
|
|
107
|
+
|
|
108
|
+
#. Provide access to MODULE facilities through native python.
|
|
109
|
+
#. Provide local access to MODULE facilities on CLI.
|
|
110
|
+
#. Provide remote access to MODULE facilities through remote invocation
|
|
111
|
+
of python Expection Complete Operations using
|
|
112
|
+
`rpyc <https://github.com/tomerfiliba-org/rpyc>`__.
|
|
113
|
+
#. Provide remote access to MODULE facilities on CLI.
|
|
114
|
+
|
|
115
|
+
What is unique in the PyCS-Framework is that these four models are all a
|
|
116
|
+
single abstraction.
|
|
117
|
+
|
|
118
|
+
The core of PyCS-Framework is the *bisos.b* package (the
|
|
119
|
+
PyCS-Foundation). See https://github.com/bisos-pip/b for an overview.
|
|
120
|
+
|
|
121
|
+
Uses of bisos.MODULE
|
|
122
|
+
====================
|
|
123
|
+
|
|
124
|
+
Within BISOS, bisos.MODULE is used as a common facility.
|
|
125
|
+
|
|
126
|
+
bisos.MODULE as a Standalone Piece of BISOS
|
|
127
|
+
===========================================
|
|
128
|
+
|
|
129
|
+
bisos.MODULE is a standalone piece of BISOS. It can be used as a
|
|
130
|
+
self-contained Python package separate from BISOS. Follow the
|
|
131
|
+
installtion and usage instructions below for your own use.
|
|
132
|
+
|
|
133
|
+
Installation
|
|
134
|
+
============
|
|
135
|
+
|
|
136
|
+
The sources for the bisos.MODULE pip package is maintained at:
|
|
137
|
+
https://github.com/bisos-pip/MODULE.
|
|
138
|
+
|
|
139
|
+
The bisos.MODULE pip package is available at PYPI as
|
|
140
|
+
https://pypi.org/project/bisos.MODULE
|
|
141
|
+
|
|
142
|
+
You can install bisos.MODULE with pip or pipx.
|
|
143
|
+
|
|
144
|
+
With pip
|
|
145
|
+
--------
|
|
146
|
+
|
|
147
|
+
If you need access to bisos.MODULE as a python module, you can install
|
|
148
|
+
it with pip:
|
|
149
|
+
|
|
150
|
+
.. code:: bash
|
|
151
|
+
|
|
152
|
+
pip install bisos.MODULE
|
|
153
|
+
|
|
154
|
+
With pipx
|
|
155
|
+
---------
|
|
156
|
+
|
|
157
|
+
If you only need access to bisos.MODULE as a command on command-line,
|
|
158
|
+
you can install it with pipx:
|
|
159
|
+
|
|
160
|
+
.. code:: bash
|
|
161
|
+
|
|
162
|
+
pipx install bisos.MODULE
|
|
163
|
+
|
|
164
|
+
The following commands are made available:
|
|
165
|
+
|
|
166
|
+
- MODULE.cs
|
|
167
|
+
- roInv-MODULE.cs
|
|
168
|
+
- roPerf-MODULE.cs
|
|
169
|
+
|
|
170
|
+
These are all one file with 3 names. *roInv-MODULE.cs* and
|
|
171
|
+
*roPerf-MODULE.cs* are sym-links to *MODULE.cs*
|
|
172
|
+
|
|
173
|
+
Usage
|
|
174
|
+
=====
|
|
175
|
+
|
|
176
|
+
Locally (system command-line)
|
|
177
|
+
-----------------------------
|
|
178
|
+
|
|
179
|
+
``MODULE.cs`` can be invoked directly as
|
|
180
|
+
|
|
181
|
+
.. code:: bash
|
|
182
|
+
|
|
183
|
+
bin/MODULE.cs
|
|
184
|
+
|
|
185
|
+
Remotely (as a service – Performer+Invoker)
|
|
186
|
+
-------------------------------------------
|
|
187
|
+
|
|
188
|
+
You can also run
|
|
189
|
+
|
|
190
|
+
Performer
|
|
191
|
+
~~~~~~~~~
|
|
192
|
+
|
|
193
|
+
Run performer as:
|
|
194
|
+
|
|
195
|
+
.. code:: bash
|
|
196
|
+
|
|
197
|
+
bin/roPerf-MODULE.cs
|
|
198
|
+
|
|
199
|
+
Invoker
|
|
200
|
+
~~~~~~~
|
|
201
|
+
|
|
202
|
+
Run invoker as:
|
|
203
|
+
|
|
204
|
+
.. code:: bash
|
|
205
|
+
|
|
206
|
+
bin/roInv-MODULE.cs
|
|
207
|
+
|
|
208
|
+
Use by Python script
|
|
209
|
+
--------------------
|
|
210
|
+
|
|
211
|
+
bisos.MODULE Source Code is in writen in COMEEGA (Collaborative Org-Mode Enhanced Emacs Generalized Authorship) – https://github.com/bx-blee/comeega.
|
|
212
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
213
|
+
|
|
214
|
+
The primary API for bisos.MODULE is ./bisos/MODULE/MODULE-csu.py. It is self documented in COMEEGA.
|
|
215
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
216
|
+
|
|
217
|
+
Documentation and Blee-Panels
|
|
218
|
+
=============================
|
|
219
|
+
|
|
220
|
+
bisos.MODULE is part of ByStar Digital Ecosystem http://www.by-star.net.
|
|
221
|
+
|
|
222
|
+
This module's primary documentation is in the form of Blee-Panels.
|
|
223
|
+
Additional information is also available in:
|
|
224
|
+
http://www.by-star.net/PLPC/180047
|
|
225
|
+
|
|
226
|
+
bisos.MODULE Blee-Panels
|
|
227
|
+
------------------------
|
|
228
|
+
|
|
229
|
+
bisos.MODULE Blee-Panles are in ./panels directory. From within Blee and
|
|
230
|
+
BISOS these panles are accessible under the Blee "Panels" menu.
|
|
231
|
+
|
|
232
|
+
Support
|
|
233
|
+
=======
|
|
234
|
+
|
|
235
|
+
| For support, criticism, comments and questions; please contact the
|
|
236
|
+
author/maintainer
|
|
237
|
+
| `Mohsen Banan <http://mohsen.1.banan.byname.net>`__ at:
|
|
238
|
+
http://mohsen.1.banan.byname.net/contact
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
#+title: bisos.MODULE: Python Command-Services for
|
|
2
|
+
#+DATE: <2024-02-19 Mon 16:27>
|
|
3
|
+
#+AUTHOR: Mohsen BANAN
|
|
4
|
+
#+OPTIONS: toc:4
|
|
5
|
+
|
|
6
|
+
Panel Controls:: [[elisp:(show-all)][Show-All]] [[elisp:(org-shifttab)][Overview]] [[elisp:(progn (org-shifttab) (org-content))][Content]] | [[elisp:(delete-other-windows)][(1)]] | [[elisp:(progn (save-buffer) (kill-buffer))][S&Q]] [[elisp:(save-buffer)][Save]] [[elisp:(kill-buffer)][Quit]] [[elisp:(bury-buffer)][Bury]]
|
|
7
|
+
Links: [[file:./panels/_nodeBase_/fullUsagePanel-en.org]] (Package Panel)
|
|
8
|
+
|
|
9
|
+
* Overview
|
|
10
|
+
bisos.MODULE is a python package that uses the PyCS-Framework for NOTYET.
|
|
11
|
+
It is a BISOS-Capability and a Standalone-BISOS-Package.
|
|
12
|
+
|
|
13
|
+
/bisos.MODULE/ is based on PyCS-Foundation and can be used both as a Command and
|
|
14
|
+
as a Service (invoke/perform model of remote operations) using RPYC for central
|
|
15
|
+
management of multiple systems.
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
* Table of Contents :TOC:
|
|
19
|
+
- [[#overview][Overview]]
|
|
20
|
+
- [[#about-bisos-----bystar-internet-services-operating-system][About BISOS --- ByStar Internet Services Operating System]]
|
|
21
|
+
- [[#bisosmodule-is-a-command-services-pycs-facility][bisos.MODULE is a Command Services (PyCS) Facility]]
|
|
22
|
+
- [[#uses-of-bisosmodule][Uses of bisos.MODULE]]
|
|
23
|
+
- [[#bisosmodule-as-a-standalone-piece-of-bisos][bisos.MODULE as a Standalone Piece of BISOS]]
|
|
24
|
+
- [[#installation][Installation]]
|
|
25
|
+
- [[#with-pip][With pip]]
|
|
26
|
+
- [[#with-pipx][With pipx]]
|
|
27
|
+
- [[#usage][Usage]]
|
|
28
|
+
- [[#locally-system-command-line][Locally (system command-line)]]
|
|
29
|
+
- [[#remotely-as-a-service----performerinvoker][Remotely (as a service -- Performer+Invoker)]]
|
|
30
|
+
- [[#performer][Performer]]
|
|
31
|
+
- [[#invoker][Invoker]]
|
|
32
|
+
- [[#use-by-python-script][Use by Python script]]
|
|
33
|
+
- [[#bisosmodule-source-code-is-in-writen-in-comeega-collaborative-org-mode-enhanced-emacs-generalized-authorship----httpsgithubcombx-bleecomeega][bisos.MODULE Source Code is in writen in COMEEGA (Collaborative Org-Mode Enhanced Emacs Generalized Authorship) -- https://github.com/bx-blee/comeega.]]
|
|
34
|
+
- [[#the-primary-api-for-bisosmodule-is-bisosmodulemodule-csupy-it-is-self-documented-in-comeega][The primary API for bisos.MODULE is ./bisos/MODULE/MODULE-csu.py. It is self documented in COMEEGA.]]
|
|
35
|
+
- [[#documentation-and-blee-panels][Documentation and Blee-Panels]]
|
|
36
|
+
- [[#bisosmodule-blee-panels][bisos.MODULE Blee-Panels]]
|
|
37
|
+
- [[#support][Support]]
|
|
38
|
+
|
|
39
|
+
* About BISOS --- ByStar Internet Services Operating System
|
|
40
|
+
|
|
41
|
+
Layered on top of Debian, *BISOS*: (By* Internet Services Operating System) is a
|
|
42
|
+
unified and universal framework for developing both internet services and
|
|
43
|
+
software-service continuums that use internet services. See [[https://github.com/bxGenesis/start][Bootstrapping
|
|
44
|
+
ByStar, BISOS and Blee]] for information about getting started with BISOS.
|
|
45
|
+
|
|
46
|
+
/bisos.MODULE/ as a PyCS facility is a small piece of a much bigger picture. *BISOS*
|
|
47
|
+
is a foundation for *The Libre-Halaal ByStar Digital Ecosystem* which is described
|
|
48
|
+
as a cure for losses of autonomy and privacy that we are experiencing in a book
|
|
49
|
+
titled: [[https://github.com/bxplpc/120033][Nature of Polyexistentials]]
|
|
50
|
+
|
|
51
|
+
* bisos.MODULE is a Command Services (PyCS) Facility
|
|
52
|
+
|
|
53
|
+
bisos.MODULE can be used locally on command-line or remotely as a service.
|
|
54
|
+
bisos.MODULE is a PyCS multi-unit command-service.
|
|
55
|
+
PyCS is a framework that converges developement of CLI and Services.
|
|
56
|
+
PyCS is an alternative to FastAPI, Typer and Click.
|
|
57
|
+
|
|
58
|
+
bisos.MODULE uses the PyCS Framework to:
|
|
59
|
+
|
|
60
|
+
1) Provide access to MODULE facilities through native python.
|
|
61
|
+
2) Provide local access to MODULE facilities on CLI.
|
|
62
|
+
3) Provide remote access to MODULE facilities through remote invocation of
|
|
63
|
+
python Expection Complete Operations using [[https://github.com/tomerfiliba-org/rpyc][rpyc]].
|
|
64
|
+
4) Provide remote access to MODULE facilities on CLI.
|
|
65
|
+
|
|
66
|
+
What is unique in the PyCS-Framework is that these four models are all
|
|
67
|
+
a single abstraction.
|
|
68
|
+
|
|
69
|
+
The core of PyCS-Framework is the /bisos.b/ package (the PyCS-Foundation).
|
|
70
|
+
See https://github.com/bisos-pip/b for an overview.
|
|
71
|
+
|
|
72
|
+
* Uses of bisos.MODULE
|
|
73
|
+
|
|
74
|
+
Within BISOS, bisos.MODULE is used as a common facility.
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
* bisos.MODULE as a Standalone Piece of BISOS
|
|
78
|
+
|
|
79
|
+
bisos.MODULE is a standalone piece of BISOS. It can be used as a self-contained
|
|
80
|
+
Python package separate from BISOS. Follow the installtion and usage
|
|
81
|
+
instructions below for your own use.
|
|
82
|
+
|
|
83
|
+
* Installation
|
|
84
|
+
|
|
85
|
+
The sources for the bisos.MODULE pip package is maintained at:
|
|
86
|
+
https://github.com/bisos-pip/MODULE.
|
|
87
|
+
|
|
88
|
+
The bisos.MODULE pip package is available at PYPI as
|
|
89
|
+
https://pypi.org/project/bisos.MODULE
|
|
90
|
+
|
|
91
|
+
You can install bisos.MODULE with pip or pipx.
|
|
92
|
+
|
|
93
|
+
** With pip
|
|
94
|
+
|
|
95
|
+
If you need access to bisos.MODULE as a python module, you can install it with pip:
|
|
96
|
+
|
|
97
|
+
#+begin_src bash
|
|
98
|
+
pip install bisos.MODULE
|
|
99
|
+
#+end_src
|
|
100
|
+
|
|
101
|
+
** With pipx
|
|
102
|
+
|
|
103
|
+
If you only need access to bisos.MODULE as a command on command-line, you can install it with pipx:
|
|
104
|
+
|
|
105
|
+
#+begin_src bash
|
|
106
|
+
pipx install bisos.MODULE
|
|
107
|
+
#+end_src
|
|
108
|
+
|
|
109
|
+
The following commands are made available:
|
|
110
|
+
- MODULE.cs
|
|
111
|
+
- roInv-MODULE.cs
|
|
112
|
+
- roPerf-MODULE.cs
|
|
113
|
+
|
|
114
|
+
These are all one file with 3 names. _roInv-MODULE.cs_ and _roPerf-MODULE.cs_ are sym-links to _MODULE.cs_
|
|
115
|
+
|
|
116
|
+
* Usage
|
|
117
|
+
|
|
118
|
+
** Locally (system command-line)
|
|
119
|
+
|
|
120
|
+
=MODULE.cs= can be invoked directly as
|
|
121
|
+
|
|
122
|
+
#+begin_src bash
|
|
123
|
+
bin/MODULE.cs
|
|
124
|
+
#+end_src
|
|
125
|
+
|
|
126
|
+
** Remotely (as a service -- Performer+Invoker)
|
|
127
|
+
|
|
128
|
+
You can also run
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
*** Performer
|
|
132
|
+
|
|
133
|
+
Run performer as:
|
|
134
|
+
|
|
135
|
+
#+begin_src bash
|
|
136
|
+
bin/roPerf-MODULE.cs
|
|
137
|
+
#+end_src
|
|
138
|
+
|
|
139
|
+
*** Invoker
|
|
140
|
+
|
|
141
|
+
Run invoker as:
|
|
142
|
+
|
|
143
|
+
#+begin_src bash
|
|
144
|
+
bin/roInv-MODULE.cs
|
|
145
|
+
#+end_src
|
|
146
|
+
|
|
147
|
+
** Use by Python script
|
|
148
|
+
|
|
149
|
+
*** bisos.MODULE Source Code is in writen in COMEEGA (Collaborative Org-Mode Enhanced Emacs Generalized Authorship) -- https://github.com/bx-blee/comeega.
|
|
150
|
+
|
|
151
|
+
*** The primary API for bisos.MODULE is ./bisos/MODULE/MODULE-csu.py. It is self documented in COMEEGA.
|
|
152
|
+
|
|
153
|
+
* Documentation and Blee-Panels
|
|
154
|
+
|
|
155
|
+
bisos.MODULE is part of ByStar Digital Ecosystem [[http://www.by-star.net]].
|
|
156
|
+
|
|
157
|
+
This module's primary documentation is in the form of Blee-Panels.
|
|
158
|
+
Additional information is also available in: [[http://www.by-star.net/PLPC/180047]]
|
|
159
|
+
|
|
160
|
+
** bisos.MODULE Blee-Panels
|
|
161
|
+
|
|
162
|
+
bisos.MODULE Blee-Panles are in ./panels directory.
|
|
163
|
+
From within Blee and BISOS these panles are accessible under the
|
|
164
|
+
Blee "Panels" menu.
|
|
165
|
+
|
|
166
|
+
* Support
|
|
167
|
+
|
|
168
|
+
For support, criticism, comments and questions; please contact the
|
|
169
|
+
author/maintainer\\
|
|
170
|
+
[[http://mohsen.1.banan.byname.net][Mohsen Banan]] at:
|
|
171
|
+
[[http://mohsen.1.banan.byname.net/contact]]
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
# Local Variables:
|
|
175
|
+
# eval: (setq-local toc-org-max-depth 4)
|
|
176
|
+
# End:
|
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
=========================================
|
|
2
|
+
bisos.MODULE: Python Command-Services for
|
|
3
|
+
=========================================
|
|
4
|
+
|
|
5
|
+
:Author: Mohsen BANAN
|
|
6
|
+
:Date: <2024-02-19 Mon 16:27>
|
|
7
|
+
|
|
8
|
+
.. contents::
|
|
9
|
+
:depth: 3
|
|
10
|
+
..
|
|
11
|
+
|
|
12
|
+
Overview
|
|
13
|
+
========
|
|
14
|
+
|
|
15
|
+
bisos.MODULE is a python package that uses the PyCS-Framework for
|
|
16
|
+
NOTYET. It is a BISOS-Capability and a Standalone-BISOS-Package.
|
|
17
|
+
|
|
18
|
+
*bisos.MODULE* is based on PyCS-Foundation and can be used both as a
|
|
19
|
+
Command and as a Service (invoke/perform model of remote operations)
|
|
20
|
+
using RPYC for central management of multiple systems.
|
|
21
|
+
|
|
22
|
+
.. _table-of-contents:
|
|
23
|
+
|
|
24
|
+
Table of Contents TOC
|
|
25
|
+
=====================
|
|
26
|
+
|
|
27
|
+
- `Overview <#overview>`__
|
|
28
|
+
- `About BISOS — ByStar Internet Services Operating
|
|
29
|
+
System <#about-bisos-----bystar-internet-services-operating-system>`__
|
|
30
|
+
- `bisos.MODULE is a Command Services (PyCS)
|
|
31
|
+
Facility <#bisosmodule-is-a-command-services-pycs-facility>`__
|
|
32
|
+
- `Uses of bisos.MODULE <#uses-of-bisosmodule>`__
|
|
33
|
+
- `bisos.MODULE as a Standalone Piece of
|
|
34
|
+
BISOS <#bisosmodule-as-a-standalone-piece-of-bisos>`__
|
|
35
|
+
- `Installation <#installation>`__
|
|
36
|
+
|
|
37
|
+
- `With pip <#with-pip>`__
|
|
38
|
+
- `With pipx <#with-pipx>`__
|
|
39
|
+
|
|
40
|
+
- `Usage <#usage>`__
|
|
41
|
+
|
|
42
|
+
- `Locally (system command-line) <#locally-system-command-line>`__
|
|
43
|
+
- `Remotely (as a service –
|
|
44
|
+
Performer+Invoker) <#remotely-as-a-service----performerinvoker>`__
|
|
45
|
+
|
|
46
|
+
- `Performer <#performer>`__
|
|
47
|
+
- `Invoker <#invoker>`__
|
|
48
|
+
|
|
49
|
+
- `Use by Python script <#use-by-python-script>`__
|
|
50
|
+
|
|
51
|
+
- `bisos.MODULE Source Code is in writen in COMEEGA
|
|
52
|
+
(Collaborative Org-Mode Enhanced Emacs Generalized Authorship)
|
|
53
|
+
– <#bisosmodule-source-code-is-in-writen-in-comeega-collaborative-org-mode-enhanced-emacs-generalized-authorship----httpsgithubcombx-bleecomeega>`__\ https://github.com/bx-blee/comeega\ `. <#bisosmodule-source-code-is-in-writen-in-comeega-collaborative-org-mode-enhanced-emacs-generalized-authorship----httpsgithubcombx-bleecomeega>`__
|
|
54
|
+
- `The primary API for bisos.MODULE is
|
|
55
|
+
./bisos/MODULE/MODULE-csu.py. It is self documented in
|
|
56
|
+
COMEEGA. <#the-primary-api-for-bisosmodule-is-bisosmodulemodule-csupy-it-is-self-documented-in-comeega>`__
|
|
57
|
+
|
|
58
|
+
- `Documentation and Blee-Panels <#documentation-and-blee-panels>`__
|
|
59
|
+
|
|
60
|
+
- `bisos.MODULE Blee-Panels <#bisosmodule-blee-panels>`__
|
|
61
|
+
|
|
62
|
+
- `Support <#support>`__
|
|
63
|
+
|
|
64
|
+
About BISOS — ByStar Internet Services Operating System
|
|
65
|
+
=======================================================
|
|
66
|
+
|
|
67
|
+
Layered on top of Debian, **BISOS**: (By\* Internet Services Operating
|
|
68
|
+
System) is a unified and universal framework for developing both
|
|
69
|
+
internet services and software-service continuums that use internet
|
|
70
|
+
services. See `Bootstrapping ByStar, BISOS and
|
|
71
|
+
Blee <https://github.com/bxGenesis/start>`__ for information about
|
|
72
|
+
getting started with BISOS.
|
|
73
|
+
|
|
74
|
+
*bisos.MODULE* as a PyCS facility is a small piece of a much bigger
|
|
75
|
+
picture. **BISOS** is a foundation for **The Libre-Halaal ByStar Digital
|
|
76
|
+
Ecosystem** which is described as a cure for losses of autonomy and
|
|
77
|
+
privacy that we are experiencing in a book titled: `Nature of
|
|
78
|
+
Polyexistentials <https://github.com/bxplpc/120033>`__
|
|
79
|
+
|
|
80
|
+
bisos.MODULE is a Command Services (PyCS) Facility
|
|
81
|
+
==================================================
|
|
82
|
+
|
|
83
|
+
bisos.MODULE can be used locally on command-line or remotely as a
|
|
84
|
+
service. bisos.MODULE is a PyCS multi-unit command-service. PyCS is a
|
|
85
|
+
framework that converges developement of CLI and Services. PyCS is an
|
|
86
|
+
alternative to FastAPI, Typer and Click.
|
|
87
|
+
|
|
88
|
+
bisos.MODULE uses the PyCS Framework to:
|
|
89
|
+
|
|
90
|
+
#. Provide access to MODULE facilities through native python.
|
|
91
|
+
#. Provide local access to MODULE facilities on CLI.
|
|
92
|
+
#. Provide remote access to MODULE facilities through remote invocation
|
|
93
|
+
of python Expection Complete Operations using
|
|
94
|
+
`rpyc <https://github.com/tomerfiliba-org/rpyc>`__.
|
|
95
|
+
#. Provide remote access to MODULE facilities on CLI.
|
|
96
|
+
|
|
97
|
+
What is unique in the PyCS-Framework is that these four models are all a
|
|
98
|
+
single abstraction.
|
|
99
|
+
|
|
100
|
+
The core of PyCS-Framework is the *bisos.b* package (the
|
|
101
|
+
PyCS-Foundation). See https://github.com/bisos-pip/b for an overview.
|
|
102
|
+
|
|
103
|
+
Uses of bisos.MODULE
|
|
104
|
+
====================
|
|
105
|
+
|
|
106
|
+
Within BISOS, bisos.MODULE is used as a common facility.
|
|
107
|
+
|
|
108
|
+
bisos.MODULE as a Standalone Piece of BISOS
|
|
109
|
+
===========================================
|
|
110
|
+
|
|
111
|
+
bisos.MODULE is a standalone piece of BISOS. It can be used as a
|
|
112
|
+
self-contained Python package separate from BISOS. Follow the
|
|
113
|
+
installtion and usage instructions below for your own use.
|
|
114
|
+
|
|
115
|
+
Installation
|
|
116
|
+
============
|
|
117
|
+
|
|
118
|
+
The sources for the bisos.MODULE pip package is maintained at:
|
|
119
|
+
https://github.com/bisos-pip/MODULE.
|
|
120
|
+
|
|
121
|
+
The bisos.MODULE pip package is available at PYPI as
|
|
122
|
+
https://pypi.org/project/bisos.MODULE
|
|
123
|
+
|
|
124
|
+
You can install bisos.MODULE with pip or pipx.
|
|
125
|
+
|
|
126
|
+
With pip
|
|
127
|
+
--------
|
|
128
|
+
|
|
129
|
+
If you need access to bisos.MODULE as a python module, you can install
|
|
130
|
+
it with pip:
|
|
131
|
+
|
|
132
|
+
.. code:: bash
|
|
133
|
+
|
|
134
|
+
pip install bisos.MODULE
|
|
135
|
+
|
|
136
|
+
With pipx
|
|
137
|
+
---------
|
|
138
|
+
|
|
139
|
+
If you only need access to bisos.MODULE as a command on command-line,
|
|
140
|
+
you can install it with pipx:
|
|
141
|
+
|
|
142
|
+
.. code:: bash
|
|
143
|
+
|
|
144
|
+
pipx install bisos.MODULE
|
|
145
|
+
|
|
146
|
+
The following commands are made available:
|
|
147
|
+
|
|
148
|
+
- MODULE.cs
|
|
149
|
+
- roInv-MODULE.cs
|
|
150
|
+
- roPerf-MODULE.cs
|
|
151
|
+
|
|
152
|
+
These are all one file with 3 names. *roInv-MODULE.cs* and
|
|
153
|
+
*roPerf-MODULE.cs* are sym-links to *MODULE.cs*
|
|
154
|
+
|
|
155
|
+
Usage
|
|
156
|
+
=====
|
|
157
|
+
|
|
158
|
+
Locally (system command-line)
|
|
159
|
+
-----------------------------
|
|
160
|
+
|
|
161
|
+
``MODULE.cs`` can be invoked directly as
|
|
162
|
+
|
|
163
|
+
.. code:: bash
|
|
164
|
+
|
|
165
|
+
bin/MODULE.cs
|
|
166
|
+
|
|
167
|
+
Remotely (as a service – Performer+Invoker)
|
|
168
|
+
-------------------------------------------
|
|
169
|
+
|
|
170
|
+
You can also run
|
|
171
|
+
|
|
172
|
+
Performer
|
|
173
|
+
~~~~~~~~~
|
|
174
|
+
|
|
175
|
+
Run performer as:
|
|
176
|
+
|
|
177
|
+
.. code:: bash
|
|
178
|
+
|
|
179
|
+
bin/roPerf-MODULE.cs
|
|
180
|
+
|
|
181
|
+
Invoker
|
|
182
|
+
~~~~~~~
|
|
183
|
+
|
|
184
|
+
Run invoker as:
|
|
185
|
+
|
|
186
|
+
.. code:: bash
|
|
187
|
+
|
|
188
|
+
bin/roInv-MODULE.cs
|
|
189
|
+
|
|
190
|
+
Use by Python script
|
|
191
|
+
--------------------
|
|
192
|
+
|
|
193
|
+
bisos.MODULE Source Code is in writen in COMEEGA (Collaborative Org-Mode Enhanced Emacs Generalized Authorship) – https://github.com/bx-blee/comeega.
|
|
194
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
195
|
+
|
|
196
|
+
The primary API for bisos.MODULE is ./bisos/MODULE/MODULE-csu.py. It is self documented in COMEEGA.
|
|
197
|
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
198
|
+
|
|
199
|
+
Documentation and Blee-Panels
|
|
200
|
+
=============================
|
|
201
|
+
|
|
202
|
+
bisos.MODULE is part of ByStar Digital Ecosystem http://www.by-star.net.
|
|
203
|
+
|
|
204
|
+
This module's primary documentation is in the form of Blee-Panels.
|
|
205
|
+
Additional information is also available in:
|
|
206
|
+
http://www.by-star.net/PLPC/180047
|
|
207
|
+
|
|
208
|
+
bisos.MODULE Blee-Panels
|
|
209
|
+
------------------------
|
|
210
|
+
|
|
211
|
+
bisos.MODULE Blee-Panles are in ./panels directory. From within Blee and
|
|
212
|
+
BISOS these panles are accessible under the Blee "Panels" menu.
|
|
213
|
+
|
|
214
|
+
Support
|
|
215
|
+
=======
|
|
216
|
+
|
|
217
|
+
| For support, criticism, comments and questions; please contact the
|
|
218
|
+
author/maintainer
|
|
219
|
+
| `Mohsen Banan <http://mohsen.1.banan.byname.net>`__ at:
|
|
220
|
+
http://mohsen.1.banan.byname.net/contact
|