Packages
Install the meta-package and you get the whole family. Imports always live under almasix.orbit… thanks to pkgutil.extend_path.
pip install almasix-orbitEach package is also installable on its own when you only need forms, tables, or the support toolkit inside a non-panel app.
| PyPI package | Import | Role |
|---|---|---|
almasix-orbit |
almasix.orbit / almasix.orbit.panels |
Panels, resources, pages, relation managers, provider, LiveResource |
almasix-orbit-support |
almasix.orbit.support |
Component, colors, icons, HTML, evaluate |
almasix-orbit-schemas |
almasix.orbit.schemas |
Schema + layouts |
almasix-orbit-forms |
almasix.orbit.forms |
Form + fields |
almasix-orbit-tables |
almasix.orbit.tables |
Table, columns, filters |
almasix-orbit-actions |
almasix.orbit.actions |
Actions + CRUD presets |
almasix-orbit-infolists |
almasix.orbit.infolists |
Infolist + entries |
almasix-orbit-notifications |
almasix.orbit.notifications |
Notification + Notifier + stores |
almasix-orbit-widgets |
almasix.orbit.widgets |
Stats, charts, table widgets |
almasix-orbit-query-builder |
almasix.orbit.query_builder |
Constraints + apply |
Prefer these imports
Section titled “Prefer these imports”from almasix.orbit import Panel, PanelRegistry, Resource, Page, RelationManagerfrom almasix.orbit.forms import Form, TextInputfrom almasix.orbit.tables import Table, TextColumnfrom almasix.orbit.actions import CreateAction, EditAction, DeleteActionfrom almasix.orbit.infolists import Infolist, TextEntryfrom almasix.orbit.schemas import Section, Grid, Tabsfrom almasix.orbit.notifications import Notification, Notifier, get_notifierfrom almasix.orbit.widgets import StatsOverviewWidgetfrom almasix.orbit.query_builder import QueryBuilder, TextConstraintfrom almasix.orbit.support import Color, icon, evaluate, HtmlStringfrom almasix.orbit.testing import LiveResourceLiveResource lives in the panels package and is imported from almasix.orbit.testing — see Testing. Support helpers are documented in Support.
Community plugins
Section titled “Community plugins”Third-party packages register with .plugin(...) on a panel. Browse published listings on the plugin marketplace, install from Using a plugin, or publish your own via Get listed.
Dependencies
Section titled “Dependencies”Orbit expects Almasix, Conduit, and permission in the app environment. See Installation.