Skip to content

The Hubuum ecosystem

The server owns the data model, permissions, and HTTP contracts. Companion projects provide interfaces for people and applications. Choose the interface that fits your workflow; all of them connect to a Hubuum server.

Component Use it for Documentation home
Hubuum server Data storage, API, authorization, background work, and administration This site
Web frontend Interactive inventory and administration in a browser Frontend guides
CLI Interactive terminal work, scripts, and shell automation CLI guide
Rust client Typed asynchronous and blocking Rust applications Rust client guides
Python client Typed synchronous and asynchronous Python applications Python client guides

The archived hubuum-python repository is an earlier implementation. The current Python client is hubuum-client-python.

One entry point, clear ownership

The organization landing page belongs in the separate hubuum/hubuum.github.io repository. It introduces the ecosystem and directs readers to each project. The .github repository supplies the GitHub organization profile, which can link to that landing page. See the site ownership plan.

This server site at /hubuum/ owns shared concepts, server operation, API behavior, and cross-project workflows. Companion repositories own their installation instructions, language-specific examples, command/UI reference, and release history.

Start with clients and interfaces for practical entry points and compatibility links. Client and server version numbers do not match automatically; consult each project's declared server targets.

Maintainers adding another client or interface should follow the ecosystem documentation contract. It allows each project to publish its own detailed documentation while sharing navigation and an organization-wide entry point.