Metadata-Version: 2.2
Name: bisos.crypt
Version: 0.15
Summary: bisos.crypt:  BPO Based Encryption/Decryption Facilities that provide vault, symetric and PKCS encryption, decryption, and hashing capabilities.
Author: Mohsen Banan
Author-email: libre@mohsen.1.banan.byname.net
Maintainer: Mohsen Banan
Maintainer-email: libre@mohsen.1.banan.byname.net
License: AGPL
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: bisos
Requires-Dist: bisos.b
Requires-Dist: bisos.bpo
Requires-Dist: bisos.common
Requires-Dist: bisos.csPlayer
Requires-Dist: bisos.currents
Requires-Dist: bisos.pals
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: license
Dynamic: maintainer
Dynamic: maintainer-email
Dynamic: requires-dist
Dynamic: summary

===============================================================================================================================================
bisos.crypt: BPO Based Encryption/Decryption Facilities that provide vault, symetric and PKCS encryption, decryption, and hashing capabilities.
===============================================================================================================================================

.. contents::
   :depth: 3
..

Overview
========

bisos.crypt is a python package that uses the PyCS-Framework for NOTYET.
It is a BISOS-Capability and a Standalone-BISOS-Package.

*bisos.crypt* is based on PyCS-Foundation 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.

.. _table-of-contents:

Table of Contents TOC
=====================

-  `Overview <#overview>`__
-  `Part of BISOS — ByStar Internet Services Operating
   System <#part-of-bisos-----bystar-internet-services-operating-system>`__
-  `bisos.crypt is a Command Services (PyCS)
   Facility <#bisoscrypt-is-a-command-services-pycs-facility>`__
-  `Uses of bisos.crypt <#uses-of-bisoscrypt>`__
-  `bisos.crypt as a Standalone Piece of
   BISOS <#bisoscrypt-as-a-standalone-piece-of-bisos>`__
-  `Installation <#installation>`__

   -  `Installation With pip <#installation-with-pip>`__
   -  `Installation With pipx <#installation-with-pipx>`__

-  `Usage <#usage>`__

   -  `Locally (system command-line) <#locally-system-command-line>`__
   -  `Remotely (as a service –
      Performer+Invoker) <#remotely-as-a-service----performerinvoker>`__

      -  `Performer <#performer>`__
      -  `Invoker <#invoker>`__

   -  `Use by Python script <#use-by-python-script>`__

      -  `bisos.crypt Source Code is in writen in COMEEGA (Collaborative
         Org-Mode Enhanced Emacs Generalized Authorship)
         – <#bisoscrypt-source-code-is-in-writen-in-comeega-collaborative-org-mode-enhanced-emacs-generalized-authorship----httpsgithubcombx-bleecomeega>`__\ https://github.com/bx-blee/comeega\ `. <#bisoscrypt-source-code-is-in-writen-in-comeega-collaborative-org-mode-enhanced-emacs-generalized-authorship----httpsgithubcombx-bleecomeega>`__
      -  `The primary API for bisos.crypt is ./bisos/crypt/crypt-csu.py.
         It is self documented in
         COMEEGA. <#the-primary-api-for-bisoscrypt-is-bisoscryptcrypt-csupy-it-is-self-documented-in-comeega>`__

-  `Documentation and Blee-Panels <#documentation-and-blee-panels>`__

   -  `bisos.crypt Blee-Panels <#bisoscrypt-blee-panels>`__

-  `Support <#support>`__

Part of 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 <https://github.com/bxGenesis/start>`__ for information about
  getting started with BISOS.
| **BISOS** is a foundation for **The Libre-Halaal ByStar Digital
  Ecosystem** which is described as a cure for losses of autonomy and
  privacy in a book titled: `Nature of
  Polyexistentials <https://github.com/bxplpc/120033>`__

*bisos.crypt* is part of BISOS.

bisos.crypt is a Command Services (PyCS) Facility
=================================================

bisos.crypt can be used locally on command-line or remotely as a
service. bisos.crypt 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.crypt uses the PyCS Framework to:

#. Provide access to crypt facilities through native python.
#. Provide local access to crypt facilities on CLI.
#. Provide remote access to crypt facilities through remote invocation
   of python Expection Complete Operations using
   `rpyc <https://github.com/tomerfiliba-org/rpyc>`__.
#. Provide remote access to crypt 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.crypt
===================

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

bisos.crypt as a Standalone Piece of BISOS
==========================================

bisos.crypt 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.crypt pip package is maintained at:
https://github.com/bisos-pip/crypt.

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

You can install bisos.crypt with pip or pipx.

Installation With pip
---------------------

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

.. code:: bash

   pip install bisos.crypt

Installation With pipx
----------------------

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

.. code:: bash

   pipx install bisos.crypt

The following commands are made available:

-  crypt.cs
-  roInv-crypt.cs
-  roPerf-crypt.cs

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

Usage
=====

Locally (system command-line)
-----------------------------

``crypt.cs`` can be invoked directly as

.. code:: bash

   bin/crypt.cs

Remotely (as a service – Performer+Invoker)
-------------------------------------------

You can also run

Performer
~~~~~~~~~

Run performer as:

.. code:: bash

   bin/roPerf-crypt.cs

Invoker
~~~~~~~

Run invoker as:

.. code:: bash

   bin/roInv-crypt.cs

Use by Python script
--------------------

bisos.crypt 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.crypt is ./bisos/crypt/crypt-csu.py. It is self documented in COMEEGA.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Documentation and Blee-Panels
=============================

bisos.crypt 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.crypt Blee-Panels
-----------------------

bisos.crypt 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 <http://mohsen.1.banan.byname.net>`__ at:
  http://mohsen.1.banan.byname.net/contact
