KOI-net

This protocol and framework are the result of several iterations of KOI research, read more here.

KOI-net (Knowledge Organization Infrastructure Network) can be understood as both a network protocol for distributed knowledge processing, and as a Python framework for building nodes, networks, and applications on top of that protocol. This repo is the implementation of that framework.

For information about the KOI-net protocol, see the official specification.

Quick Start

Installation

(Optionally) create and activate a virtual environment, and install KOI-net:

$ pip install koi-net

Create a Simple Partial Node

The KOI-net framework is built around the dependency injection pattern. Node classes are containers for interdependent components implementing internal subsystems. Each node inherits from a base partial or full node class, which comes with ~36 default components. At a minimum, each node needs to implement a config component:

from koi_net.config import PartialNodeConfig, KoiNetConfig, PartialNodeProfile  

class MyPartialNodeConfig(PartialNodeConfig):
	koi_net: KoiNetConfig = KoiNetConfig(
		node_name="partial",
		node_profile=PartialNodeProfile()
	)

Which is set in the node container:

from koi_net.core import PartialNode

class MyPartialNode(PartialNode):
	config_schema = MyPartialNodeConfig

Finally, the main method can be set to build and run the node:

if __name__ == "__main__":
	MyPartialNode().run()

See examples/coordinator.py for a more complex example node, or see the docs for more information on the KOI-net framework.

This framework depends on rid-lib, the Python implementation of the RID protocol.

Documentation

This project uses Sphinx to generate documentation from docstrings. The docs.yml GitHub workflow automatically build and deploys the docs to GitHub Pages. To build the docs locally, run the following command:

$ uv run --extra docs sphinx-build -b html docs docs/_build/html

Download files

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

Source Distribution

koi_net-2.1.2.tar.gz (53.4 kB view details)

Uploaded Aug 6, 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.

koi_net-2.1.2-py3-none-any.whl (77.1 kB view details)

Uploaded Aug 6, 2026 Python 3

File details

Details for the file koi_net-2.1.2.tar.gz.

File metadata

Download URL: koi_net-2.1.2.tar.gz
Upload date: Aug 6, 2026
Size: 53.4 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for koi_net-2.1.2.tar.gz
Algorithm	Hash digest
SHA256	`4c31b0feebcf5a3cee95c26791e688dda0aff5d3f4ba3b3c293befda5abc60c9`
MD5	`a8a216d1d5996f586a5d9cf7bfa715d8`
BLAKE2b-256	`53832a19deb18ac401c924f97346f6c1a652feb7150757aa5c6f20ad5e37284c`

See more details on using hashes here.

Provenance

The following attestation bundles were made for koi_net-2.1.2.tar.gz:

Publisher: publish-to-pypi.yml on DynamicalSystemsGroup/koi-net

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: koi_net-2.1.2.tar.gz
- Subject digest: 4c31b0feebcf5a3cee95c26791e688dda0aff5d3f4ba3b3c293befda5abc60c9
- Sigstore transparency entry: 2361770356
- Sigstore integration time: Aug 6, 2026
Source repository:
- Permalink: DynamicalSystemsGroup/koi-net@7a4d631bcfec86a162d07d8f1b0a004b671c0f0f
- Branch / Tag: refs/heads/main
- Owner: https://github.com/DynamicalSystemsGroup
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish-to-pypi.yml@7a4d631bcfec86a162d07d8f1b0a004b671c0f0f
- Trigger Event: workflow_dispatch