blackboardx

A group of agents works on one problem. Each writes what it finds into a single shared record, every agent can read all of it, and no agent calls another; the record is the only channel between them. The blackboard literature calls a system skeletal when it supplies this structure with no domain knowledge inside, so that an application system is built on it by adding knowledge and control. blackboardx is skeletal in that sense. It supplies the board and the control component; an application creates a model by supplying its regions, their opening premise values, an admission rule, a termination predicate, and limits, and its agents register themselves into it.

The distribution name is blackboardx; the import name is blackboard. The documentation, including the API reference, is at https://moeinroghani.github.io/blackboardx/.

Install

pip install blackboardx
pip install 'blackboardx[postgres]'    # PostgresBoard
pip install 'blackboardx[mongodb]'     # MongoBoard

The base install has no runtime dependency: the board it ships, SqliteBoard, is backed by SQLite, which comes with Python. A deployment keeps the record in the database it already runs, and the adapter for one needs its driver.

Documentation


Quickstart	A run in full, in twenty lines
Concepts	What the board, the control component and a run are
Storage	Where the record is kept, and what an adapter owes
Guides	Writing an agent, admission rules, ending a run, testing
API reference	Every exported name

Example

from datetime import timedelta

from blackboard import (
    Agent,
    Level,
    Premise,
    RunLimits,
    Settled,
    SqliteBoard,
    create_model,
)

notifications = []

model = create_model(
    regions=[Level("platform"), Premise("window")],
    premises={"window": ["2026-08-16T20:00", "2026-08-16T22:00"]},
    limits=RunLimits(wall_clock=timedelta(minutes=10), idle=timedelta(seconds=1)),
    board=SqliteBoard("incident.sqlite3"),
)

model.control.register_agent(Agent(name="ocp", notify=notifications.append))

(notification,) = notifications
window = model.reader.read_premise("window").value
model.control.write("ocp", "platform", {"window": window, "findings": ["oom"]})
model.control.ack("ocp", notification.notification_id)

assert model.control.wait_closed(timeout=timedelta(seconds=10)) == Settled()

License

Apache-2.0. The license text is in LICENSE, and every distribution carries it.

Development Status
- 3 - Alpha
Intended Audience
- Developers
Operating System
- OS Independent
Programming Language
Typing
- Typed

Download files

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

Source Distribution

blackboardx-0.5.0.tar.gz (174.7 kB view details)

Uploaded Aug 25, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

blackboardx-0.5.0-py3-none-any.whl (34.9 kB view details)

Uploaded Aug 25, 2026 Python 3

File details

Details for the file blackboardx-0.5.0.tar.gz.

File metadata

Download URL: blackboardx-0.5.0.tar.gz
Upload date: Aug 25, 2026
Size: 174.7 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for blackboardx-0.5.0.tar.gz
Algorithm	Hash digest
SHA256	`cf868fc15b93970fcf9c428ede68735bf427bc45f9837bf87d3478171104a281`
MD5	`34b1573bea7bad2a58db26f57a665a19`
BLAKE2b-256	`afac6c67e317537dcf1d46ce2e76c2b7dad8a98fe427ca5ff95e79424964fe95`

See more details on using hashes here.

Provenance

The following attestation bundles were made for blackboardx-0.5.0.tar.gz:

Publisher: publish.yml on MoeinRoghani/blackboardx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: blackboardx-0.5.0.tar.gz
- Subject digest: cf868fc15b93970fcf9c428ede68735bf427bc45f9837bf87d3478171104a281
- Sigstore transparency entry: 2590570692
- Sigstore integration time: Aug 25, 2026
Source repository:
- Permalink: MoeinRoghani/blackboardx@8770dc51e84e254bfe732a48ae0cd3ed9086064c
- Branch / Tag: refs/heads/main
- Owner: https://github.com/MoeinRoghani
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@8770dc51e84e254bfe732a48ae0cd3ed9086064c
- Trigger Event: workflow_dispatch