Overview

bisos.sites is a python package for managing BISOS Sites – the /bisos/var/sites symlink base, the selected and per-site symlinks under it, and the /bisos/site symlink that BISOS tooling ultimately resolves through. It also umbrellas site registrar (boxes/containers inventory and performer) services.

bisos.sites is the converted, PyCS-native replacement for the Bash-ICM /bisos/core/bsip/bin/site_lib.sh library (vis_siteBisosBase, vis_siteBisosAdd, vis_siteBisosSelect).

Package Documentation At Github

The information below is a subset of the full of documentation for this bisos-pip package. More complete documentation is available at: https://github.com/bisos-pip/sites-cs

Realted Resources

Table of Contents TOC

• Overview

• Package Documentation At Github

• Realted Resources

• Installation

  • Installation With pip

  • Installation With pipx

• Part of BISOS and ByStar — ByStar Internet Services Operating System

• bisos.sites is a Command-Only PyCS Facility

• bisos.sites as a Standalone Piece of BISOS

• Usage

  • Sites Information

  • Site Base – obtain/update the selected site

  • Add or Select a Site (converted from sitelib.sh)

• Key Files

• Documentation and Blee-Panels

  • bisos.sites Blee-Panels

• Support

• Planned Improvements

  • Add py3/tests/ live-execution coverage for siteBase/siteBisosAdd/siteBisosSelect (currently smoke-tested only, never executed)

  • Document the /bisos/var/sites/<siteBxoId> and selected symlink layout with a diagram in the Blee-Panel

  • Revisit whether platfSiteBootstrap.py should be merged into or deprecated in favor of sitescsu.py

Installation

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

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

You can install bisos.sites with pip or pipx.

pip install bisos.sites

pipx install bisos.sites

Part of BISOS and ByStar — ByStar Internet Services Operating System

bisos.sites is part of BISOS.

bisos.sites is a Command-Only PyCS Facility

bisos.sites is a command-line tool. It is a PyCS single-unit command service. PyCS is a framework that converges development of CLI tools and services. PyCS is an alternative to FastAPI, Typer and Click.

bisos.sites uses the PyCS-Framework to:

1. Manage the /bisos/var/sites symlink base – per-site symlinks and the selected symlink that /bisos/site resolves through

2. Bootstrap and activate BISOS platform sites (platfSiteBootstrap-fps.cs, platfSitesActivate-fps.cs)

3. Serve as a registrar for site boxes and containers inventory (site-registrarsBoxInv-fps.cs, site-registrarsContainerInv-fps.cs) and their performer-side counterparts

The core of PyCS-Framework is the bisos.b package (the PyCS-Foundation). See bisos.b for an overview.

bisos.sites as a Standalone Piece of BISOS

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

Usage

sitesManage.cs -i sitesInfo

sitesManage.cs -i siteBase -- obtain
sitesManage.cs -p bpoId=<siteBxoId> -i siteBase -- update

sitesManage.cs -i siteBisosAdd <siteBxoId>       # create /bisos/var/sites/<siteBxoId>
sitesManage.cs -i siteBisosSelect <siteBxoId>    # update /bisos/var/sites/selected

Key Files

• py3/bin/sitesManage.cs – the primary CS binary; csuList includes bisos.sites.sites_csu.

• py3/bisos/sites/sites_csu.py – sitesInfo, siteBase, siteBisosAdd, siteBisosSelect, siteBisosBase() – site symlink-base management.

• py3/bisos/sites/platfSiteBootstrap.py / py3/bisos/sites/platfSiteBootstrap_fps.py – platform site bootstrap (primary site BPO-ID lookup, etc.); kept separate from sites_csu.py.

• py3/bisos/sites/site_registrarsBox{Inv,Perf}_fps.py / site_registrarsContainer{Inv,Perf}_fps.py – registrar inventory and performer Cmnds for boxes and containers.

Documentation and Blee-Panels

bisos.sites 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

Support

Planned Improvements