Skip to content

bisos-pip/PyCS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bisos.PyCS: Python Command-Services Framework.

Panel Controls:: Show-All Overview Content | (1) | S&Q Save Quit Bury Links: ./panels/_nodeBase_/fullUsagePanel-en.org (Package Panel)

Overview

Python Command Services is a unified model and framework for development of both Commands and Services. Unlike Click, Docopt and Typer which are just for commands development and unlike FastAPI, Pydantic, gRPC and OpenAPI which are just for services development, PyCS does both. Native PyCS uses RPyC to transform commands into services.

bisos.PyCS is based on PyCS-Foundation (bisos.b) and can be used both as a Command and as a Service (invoke/perform model of remote operations) using RPyC for central management of multiple systems. PyCS-Framework extends the PyCS-Foundation by providing common additional modules which ease development of applications.

Table of Contents

About BISOS — ByStar Internet Services Operating System

Layered on top of Debian, BISOS: (By* Internet Services Operating System) is a unified and universal framework for developing both internet services and software-service continuums that use internet services. See Bootstrapping ByStar, BISOS and Blee for information about getting started with BISOS.

bisos.PyCS as a PyCS facility is a small piece of a much bigger picture. BISOS is a foundation for The Libre-Halaal ByStar Digital Ecosystem which is described as a cure for losses of autonomy and privacy that we are experiencing in a book titled: Nature of Polyexistentials

bisos.PyCS is a Command Services (PyCS) Facility

bisos.PyCS can be used locally on command-line or remotely as a service. bisos.PyCS is a PyCS multi-unit command-service. PyCS is a framework that converges developement of CLI and Services. PyCS is an alternative to FastAPI, Typer and Click.

bisos.PyCS uses the PyCS Framework to:

  1. Provide access to PyCS facilities through native python.
  2. Provide local access to PyCS facilities on CLI.
  3. Provide remote access to PyCS facilities through remote invocation of python Expection Complete Operations using rpyc.
  4. Provide remote access to PyCS facilities on CLI.

What is unique in the PyCS-Framework is that these four models are all a single abstraction.

The core of PyCS-Framework is the bisos.b package (the PyCS-Foundation). See https://github.com/bisos-pip/b for an overview.

Uses of bisos.PyCS

Within BISOS, bisos.PyCS is used as a common facility.

bisos.PyCS as a Standalone Piece of BISOS

bisos.PyCS is a standalone piece of BISOS. It can be used as a self-contained Python package separate from BISOS. Follow the installtion and usage instructions below for your own use.

Installation

The sources for the bisos.PyCS pip package is maintained at: https://github.com/bisos-pip/PyCS.

The bisos.PyCS pip package is available at PYPI as https://pypi.org/project/bisos.PyCS

You can install bisos.PyCS with pip or pipx.

With pip

If you need access to bisos.PyCS as a python module, you can install it with pip:

pip install bisos.PyCS

With pipx

If you only need access to bisos.PyCS as a command on command-line, you can install it with pipx:

pipx install bisos.PyCS

The following commands are made available:

  • PyCS.cs
  • roInv-PyCS.cs
  • roPerf-PyCS.cs

These are all one file with 3 names. roInv-PyCS.cs and roPerf-PyCS.cs are sym-links to PyCS.cs

Usage

Locally (system command-line)

PyCS.cs can be invoked directly as

bin/PyCS.cs

Remotely (as a service – Performer+Invoker)

You can also run

Performer

Run performer as:

bin/roPerf-PyCS.cs

Invoker

Run invoker as:

bin/roInv-PyCS.cs

Use by Python script

bisos.PyCS Source Code is in writen in COMEEGA (Collaborative Org-Mode Enhanced Emacs Generalized Authorship) – https://github.com/bx-blee/comeega.

The primary API for bisos.PyCS is ./bisos/PyCS/PyCS-csu.py. It is self documented in COMEEGA.

Documentation and Blee-Panels

bisos.PyCS is part of ByStar Digital Ecosystem http://www.by-star.net.

This module’s primary documentation is in the form of Blee-Panels. Additional information is also available in: http://www.by-star.net/PLPC/180047

bisos.PyCS Blee-Panels

bisos.PyCS Blee-Panles are in ./panels directory. From within Blee and BISOS these panles are accessible under the Blee “Panels” menu.

Support

For support, criticism, comments and questions; please contact the author/maintainer
Mohsen Banan at: http://mohsen.1.banan.byname.net/contact

About

Python Command Services

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published