Skip to main content

bisos.startAiActivity: Install AI Collaborative Development Templates

Project description

Overview

bisos.startAiActivity installs the ByStar AI collaborative development template set (CLAUDE.md, AI-AGENTS.org, AI-WORKFLOW.org, AI-Activity.org, AI-DevStatus.org, AI-WorkPlan.org) into any project directory or git repo root, wiring it for collaborative development with Claude Code.

bisos.startAiActivity is a python package that uses the PyCS-Framework. It provides the startAiActivity.cs command and a pure-Python dblock expansion engine (py-dblock.cs) for updating org-mode dynamic blocks without Emacs.

Table of Contents TOC

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 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

bisos.startAiActivity is part of BISOS. It is a standalone package that can be used independently of the full BISOS environment.

bisos.startAiActivity is a Command-Only PyCS Facility

bisos.startAiActivity 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.startAiActivity uses the PyCS-Framework to:

  1. Install AI collaborative development templates (symlinks and safe-copies) into any project directory or git repo root.

  2. Expand b:ai:file/particulars org-mode dynamic blocks in installed files using pure Python, without requiring Emacs or bx-dblock.

  3. Manage persistent user-config parameters (e.g. templates base path) via ~/.config/bisos/startAiActivity.cs/.

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

Post-Installation Setup

After installing, configure the templates base directory. If /bisos/apps/defaults/ai-templates exists on your system it is used as the default automatically. Otherwise, set it explicitly:

startAiActivity.cs -i userConfig_set --parName=templates --parValue=/path/to/ai-templates

Verify the setting:

startAiActivity.cs -i userConfig_get --parName=templates

The AI templates are maintained at: https://github.com/bisos/defaults/tree/master/ai-templates

Installation

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

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

You can install bisos.startAiActivity with pip or pipx.

Installation With pip

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

pip install bisos.startAiActivity

Installation With pipx

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

pipx install bisos.startAiActivity

The following commands are made available:

  • startAiActivity.cs — installs AI collaborative development templates

  • py-dblock.cs — updates org-mode dynamic blocks in files (pure Python)

Post-Installation Basic Testing

After installation, run:

startAiActivity.cs
startAiActivity.cs -i userConfig_get --parName=templates

Usage

Set Templates Base Directory

startAiActivity.cs -i userConfig_set --parName=templates --parValue=/path/to/ai-templates

Install Templates Into a Project

Install into the current directory:

startAiActivity.cs -i initiate --activity=bisos-pip

Install at the git repo root:

startAiActivity.cs -i initiate --root=repo --activity=bisos-pip

Available activities match subdirectories under the templates base (e.g. bisos-pip, bisos-core, xu-single, blee-panels, lcnt). Run startAiActivity.cs -i examples to see all available activities.

Update Dblocks in Org Files

py-dblock.cs -i updateDblocks AI-WorkPlan.org AI-DevStatus.org

Key Files

An overview of the relevant files of the bisos.startAiActivity package:

py3/bin/startAiActivity.cs

The main CS-MU (Command-Services Multi-Unit). Provides the initiate, userConfig_get, and userConfig_set commands. Uses bisos.b.userConfig_csu for persistent parameter management.

py3/bin/py-dblock.cs

A CS command that applies pure-Python org-mode dblock expansion to one or more files. Imports dblock_particulars to register the b:ai:file/particulars handler.

py3/bisos/startAiActivity/updateDblock.py

General dblock dispatch engine. Handlers register under a signature string via registerHandler(sig, fn). expandAll(filePath) does a single-pass regex substitution over the file, dispatching each ####+BEGIN: <signature> block to its registered handler.

py3/bisos/startAiActivity/dblock_particulars.py

Self-registering handler for the b:ai:file/particulars dblock signature. Derives the activity from the AI-Activity.org symlink and builds the companion-docs list by scanning the directory.

PyPi and Github Packaging

All bisos-pip repos in the https://github.com/bisos-pip github organization follow the same structure. They all have setup.py files driven by pypiProc.sh.

Documentation and Blee-Panels

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

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

See file:./panels/bisos.startAiActivity/_nodeBase_/fullUsagePanel-en.org for a starting point.

Support

For support, criticism, comments and questions; please contact the author/maintainer

Planned Improvements

  • Upload to PyPI and test as pipx install

  • Write fullUsagePanel-en.org Blee-Panel

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bisos_startaiactivity-0.1.tar.gz (27.0 kB view details)

Uploaded Source

File details

Details for the file bisos_startaiactivity-0.1.tar.gz.

File metadata

  • Download URL: bisos_startaiactivity-0.1.tar.gz
  • Upload date:
  • Size: 27.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.2

File hashes

Hashes for bisos_startaiactivity-0.1.tar.gz
Algorithm Hash digest
SHA256 1e246a09f11db9f725e3785c8f6e4f9cb0b5c5cb20e4d8b8fe3c7fafcced6428
MD5 79b135831bbc9c02ac1bb64e93d3d447
BLAKE2b-256 9c2029f5b6aa6a0e4d726f3eea7d9291f9447ee1c71231da655ff6ddeb789a8d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page