ceres-engine 0.41.0__tar.gz

ceres_engine-0.41.0/.cargo/config.toml

@@ -0,0 +1,41 @@
+# This file sits at the repository root rather than beside the workspace, because cargo looks
+# for it by walking up from the directory it was invoked in. Builds start from both places,
+# the root when maturin builds the extension module and `rust/` for everything else, and only
+# a root copy is found from both.
+
+# Build artifacts stay inside the workspace's target/, the only directory `cargo clean`,
+# .gitignore, and CI's cache all cover. The path resolves against this file's directory, so
+# it names `rust/` rather than landing beside it.
+[build]
+build-dir = "rust/target/build"
+
+# The parallel rustc frontend, which the pinned nightly provides. This sits under a `cfg`
+# rather than under `[build]`, because `build.rustflags` is dropped entirely wherever a
+# `target` block sets its own, while `cfg` and triple blocks combine.
+[target.'cfg(all())']
+rustflags = ["-Zthreads=4"]
+
+# Compile the extension module and regenerate its Python type stubs in one step. `make fix`
+# and `make build` run this too, and CI fails when committed stubs drift.
+[alias]
+stubs = "build -p ceres-stubs"
+
+# Artifact dependencies, which `ceres-core` uses to build the native CLI binary alongside
+# the extension module and stage it into the wheel. Unstable, which the pinned nightly in
+# rust-toolchain.toml accounts for.
+[unstable]
+bindeps = true
+
+# The bundled SQLite compiles with math functions, which the subsampling SQL's `floor`
+# needs. CPython's own SQLite ships them, so the native engine has to match.
+[env]
+LIBSQLITE3_FLAGS = "-DSQLITE_ENABLE_MATH_FUNCTIONS"
+
+# Python extension modules leave interpreter symbols unresolved until import time, so the
+# linker has to be told to allow that. Maturin does not pass these itself, and without them
+# the extension fails to link on macOS with "symbol(s) not found for architecture arm64".
+[target.aarch64-apple-darwin]
+rustflags = ["-C", "link-arg=-undefined", "-C", "link-arg=dynamic_lookup"]
+
+[target.x86_64-apple-darwin]
+rustflags = ["-C", "link-arg=-undefined", "-C", "link-arg=dynamic_lookup"]

ceres_engine-0.41.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Applied Physics Laboratory - University of Washington
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ceres_engine-0.41.0/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: ceres-engine
+Version: 0.41.0
+Requires-Dist: aiosmtplib>=5.1,<6
+Requires-Dist: anyio>=4.13,<5
+Requires-Dist: apscheduler>=3.11.2,<4
+Requires-Dist: asgiref>=3.11.1,<4
+Requires-Dist: jinja2>=3.1,<4
+Requires-Dist: mistune>=3.2,<4
+Requires-Dist: objsize>=0.8.0
+Requires-Dist: pydantic-extra-types>=2.11,<3
+Requires-Dist: pydantic-settings>=2.13.1,<3
+Requires-Dist: pydantic>=2.12.5,<3
+Requires-Dist: pyjwt>=2.11,<3
+Requires-Dist: pyyaml>=6,<7
+Requires-Dist: rich>=14.3.2,<15
+Requires-Dist: setproctitle>=1.3.7,<2
+Requires-Dist: typing-extensions>=4.15.0
+Requires-Dist: uuid-utils>=0.14.1
+Requires-Dist: uvloop>=0.22.1 ; platform_system == 'Darwin' or platform_system == 'Linux'
+Requires-Dist: watchfiles>=1.1.1,<2
+Requires-Dist: starlette>=1,<2
+License-File: LICENSE
+Summary: A Python framework for data collection, monitoring and device control.
+Author-email: Jake Ploskey <jploskey@uw.edu>
+License-Expression: MIT
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Changelog, https://github.com/OOI-RCA-APL/ceres/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://ooi-rca-apl.github.io/ceres/
+Project-URL: Source, https://github.com/OOI-RCA-APL/ceres
+
+# Ceres
+
+<!-- coverage:badge -->
+![Python Coverage: 87%](https://img.shields.io/badge/python%20coverage-87%25-yellowgreen)
+![Rust Coverage: 72%](https://img.shields.io/badge/rust%20coverage-72%25-yellow)
+<!-- /coverage:badge -->
+
+Ceres is a Python framework for building data collection, monitoring, and device control systems. It takes ideas from service management tools like Docker and SystemD, scales them down, and applies them to Python objects called _components_.
+
+Components are async Python classes that run concurrently, communicate through events, and persist their state in a database. They can connect to remote instruments over TCP, parse incoming data into structured records, emit alerts, and be managed through a CLI or web console.
+
+![architecture](https://ooi-rca-apl.github.io/ceres/images/architecture.png)
+
+## Where Ceres Is Used
+
+Ceres was built at the University of Washington Applied Physics Laboratory (APL) to power instrument drivers for the [Ocean Observatories Initiative (OOI)](https://oceanobservatories.org/) Regional Cabled Array (RCA). Ceres runs on Linux, macOS, and Windows. In its current production deployment, it runs on physical Linux servers connected to oceanographic instruments (acoustic current profilers, pressure gauges, pH sensors, etc.), collecting and processing real-time data streams over TCP.
+
+That said, Ceres is a general-purpose framework. It can manage any collection of async Python components that need lifecycle control, event handling, scheduling, and persistence.
+
+## Quick Example
+
+```python
+from ceres import Component, routine, sleep
+
+
+class Counter(Component):
+    initial: int
+    delta: int = 1
+
+    @routine
+    async def count(self) -> None:
+        count = self.initial
+        while True:
+            self.system.log.info(count)
+            await sleep(1)
+            count += self.delta
+```
+
+```yaml
+# ceres.yaml
+database:
+  type: sqlite
+  path: ./database.sqlite
+
+components:
+  - name: counter-a
+    class: counter.Counter
+    arguments:
+      initial: 5
+  - name: counter-b
+    class: counter.Counter
+    arguments:
+      initial: 100
+      delta: -5
+```
+
+```sh
+ceres run all             # Run both components in the foreground.
+ceres service start       # Or run as a background service.
+ceres status              # Check engine and component states.
+ceres start all           # Start all components.
+ceres enable all          # Auto-start components on engine startup.
+ceres service stop        # Stop the background service.
+```
+
+## Documentation
+
+The documentation is published at
+[ooi-rca-apl.github.io/ceres](https://ooi-rca-apl.github.io/ceres/).
+
+Start here:
+
+- [Installing](https://ooi-rca-apl.github.io/ceres/installing/): Install Ceres and set up a project.
+- [Getting Started](https://ooi-rca-apl.github.io/ceres/getting-started/): Build your first Ceres project from scratch.
+- [Components](https://ooi-rca-apl.github.io/ceres/components/): The core abstraction, routines, events, records.
+- [Connections](https://ooi-rca-apl.github.io/ceres/connections/): Connect to remote instruments and parse data.
+- [Writing a Driver](https://ooi-rca-apl.github.io/ceres/writing-a-driver/): Build an instrument driver end to end.
+- [Deployment](https://ooi-rca-apl.github.io/ceres/deployment/): Run Ceres as a production service.
+
+Reference, generated from the code and checked in CI:
+
+- [Configuration](https://ooi-rca-apl.github.io/ceres/reference/configuration/): Every `ceres.yaml` key.
+- [CLI](https://ooi-rca-apl.github.io/ceres/reference/cli/): Every command and option.
+- [HTTP API](https://ooi-rca-apl.github.io/ceres/reference/http-api/): Every route the engine serves.
+- [Python API](https://ooi-rca-apl.github.io/ceres/reference/python-api/): Every name `ceres` exports.
+
+Contributing:
+
+- [Development](https://ooi-rca-apl.github.io/ceres/development/): Set up a dev environment and contribute to Ceres.
+

ceres_engine-0.41.0/ceres/__init__.py

@@ -0,0 +1,232 @@
+__all__ = [
+    # .cli
+    "main",
+    # .address
+    "Address",
+    "AddressSelector",
+    "DynamicAddress",
+    # .alert
+    "Alert",
+    # .channel
+    "Channel",
+    "ChannelReader",
+    "OutputChannel",
+    # .concurrency
+    "cancel",
+    "concurrently",
+    "sleep",
+    "spawn",
+    # .component
+    "Bound",
+    "Component",
+    "ComponentAccessLevel",
+    "ComponentSystem",
+    "Output",
+    "FileOutput",
+    "ProcedureType",
+    "StreamingOutput",
+    "action",
+    "listener",
+    "query",
+    "routine",
+    "sieve",
+    # .config
+    "Config",
+    "ConfigCheckType",
+    # .connection
+    "Buffer",
+    "Chunk",
+    "Connection",
+    "ConnectionException",
+    "ConnectionField",
+    "ConnectionInactive",
+    "ConnectionLost",
+    "SplitByChunk",
+    "SplitByDelay",
+    "SplitByLine",
+    "SplitByRegex",
+    "Splitter",
+    "TCPSource",
+    "UNIXSocketSource",
+    "Unsplit",
+    # .connectivity
+    "Connectivity",
+    # .data
+    "DataObject",
+    # .database
+    "Database",
+    "DatabaseType",
+    # .directory
+    "Directory",
+    # .dispatcher
+    "Dispatch",
+    "DispatchWriter",
+    "Dispatcher",
+    "HTMLDispatchWriter",
+    # .engine
+    "Engine",
+    # .entity
+    "Entity",
+    "EntityType",
+    # .event
+    "Event",
+    "StandardEvent",
+    # .group
+    "Group",
+    "GroupMembership",
+    # .item
+    "Item",
+    "ItemType",
+    # .level
+    "Level",
+    # .loaded
+    "Loaded",
+    "Loader",
+    # .logs
+    "LogEntry",
+    # .message
+    "Message",
+    "MessageData",
+    "MessageDirection",
+    # .notifier
+    "Notification",
+    "Notifier",
+    "SMTPNotifier",
+    # .particle
+    "BinaryParticle",
+    "BinaryRegexParticle",
+    "DynamicParticleData",
+    "ParseableParticle",
+    "ParseFailed",
+    "Particle",
+    "ParticleData",
+    "RegexParticle",
+    "GroupedRegexParticle",
+    # .permission
+    "GroupPermission",
+    "PermissionTargetType",
+    "UserPermission",
+    # .record
+    "Record",
+    "RecordType",
+    # .reference
+    "Ref",
+    "Reference",
+    "unref",
+    # .schedule
+    "Schedule",
+    "ScheduleType",
+    # .server
+    "Client",
+    "Server",
+    "TCPClient",
+    "TCPServer",
+    "UNIXSocketClient",
+    "UNIXSocketServer",
+    # .setting
+    "Setting",
+    # .sieve
+    "Sieve",
+    # .statistics
+    "Statistics",
+    # .status
+    "Status",
+    # .timing
+    "utc",
+    # .user
+    "User",
+    # .variable
+    "Variable",
+    # .version
+    "__version__",
+    "Workspace",
+]
+
+from ceres.__internal__.lazy import __lazy_imports__
+
+with __lazy_imports__(__name__, export=True):
+    from ceres.__internal__.cli.main import main
+    from ceres.address import Address, AddressSelector, DynamicAddress
+    from ceres.alert import Alert
+    from ceres.channel import Channel, ChannelReader, OutputChannel
+    from ceres.component import (
+        Bound,
+        Component,
+        ComponentAccessLevel,
+        ComponentSystem,
+        FileOutput,
+        Output,
+        ProcedureType,
+        StreamingOutput,
+        action,
+        listener,
+        query,
+        routine,
+        sieve,
+    )
+    from ceres.concurrency import cancel, concurrently, sleep, spawn
+    from ceres.config import Config, ConfigCheckType
+    from ceres.connection import (
+        Buffer,
+        Chunk,
+        Connection,
+        ConnectionException,
+        ConnectionField,
+        ConnectionInactive,
+        ConnectionLost,
+        SplitByChunk,
+        SplitByDelay,
+        SplitByLine,
+        SplitByRegex,
+        Splitter,
+        TCPSource,
+        UNIXSocketSource,
+        Unsplit,
+    )
+    from ceres.connectivity import Connectivity
+    from ceres.data import DataObject
+    from ceres.database import Database, DatabaseType
+    from ceres.directory import Directory
+    from ceres.dispatcher import Dispatch, Dispatcher, DispatchWriter, HTMLDispatchWriter
+    from ceres.engine import Engine
+    from ceres.entity import Entity, EntityType
+    from ceres.event import Event, StandardEvent
+    from ceres.group import Group, GroupMembership
+    from ceres.item import Item, ItemType
+    from ceres.level import Level
+    from ceres.loaded import Loaded, Loader
+    from ceres.logs import LogEntry
+    from ceres.message import Message, MessageData, MessageDirection
+    from ceres.notifier import Notification, Notifier, SMTPNotifier
+    from ceres.particle import (
+        BinaryParticle,
+        BinaryRegexParticle,
+        DynamicParticleData,
+        GroupedRegexParticle,
+        ParseableParticle,
+        ParseFailed,
+        Particle,
+        ParticleData,
+        RegexParticle,
+    )
+    from ceres.permission import GroupPermission, PermissionTargetType, UserPermission
+    from ceres.record import Record, RecordType
+    from ceres.reference import Ref, Reference, unref
+    from ceres.schedule import Schedule, ScheduleType
+    from ceres.server import (
+        Client,
+        Server,
+        TCPClient,
+        TCPServer,
+        UNIXSocketClient,
+        UNIXSocketServer,
+    )
+    from ceres.setting import Setting
+    from ceres.sieves import Sieve
+    from ceres.statistics import Statistics
+    from ceres.status import Status
+    from ceres.timing import utc
+    from ceres.user import User
+    from ceres.variable import Variable
+    from ceres.version import __version__
+    from ceres.workspace import Workspace

ceres_engine-0.41.0/ceres/__internal__/app/__init__.py

@@ -0,0 +1,5 @@
+"""The API's engine-side operations.
+
+The native server owns HTTP and reaches the engine through `host.Host`, whose named
+operations live in `operations` and whose logic lives in `handlers`.
+"""

ceres_engine-0.41.0/ceres/__internal__/app/handlers/__init__.py

@@ -0,0 +1,6 @@
+"""Engine operations behind the API's routes.
+
+Each module holds the logic one route family needs, free of any transport concern. The
+native server reaches them through the host's named operations, and the tests exercise
+them directly.
+"""