skeleton: package, schema, config, CLI, alembic, CI, deploy, docs
ci / lint-test-leaks (pull_request) Canceled after 0s

- cayceops core: env-only config (CAYCE_OPS_*), engine/session, ORM models
  with state machines (proposal/mail/content) and audited writes
- provider-agnostic LLM interface (null provider default, stdlib openai-compat)
- Typer CLI with lazy component loading (scanner/executor/maild/publisher/monitor)
- alembic 0001 initial schema; sqlite-portable JSON columns
- tests: 7 passing on throwaway sqlite; fixtures invented, never real data
- ci: ruff + alembic smoke + pytest + gitleaks(full history) in
  .gitea/workflows + .github/workflows; local gate = make check
- deploy: docker-compose (postgres 16) + hardened systemd units/timers
- docs: DECISIONS D1-D9; README project (grant text retired)
This commit is contained in:
2026-10-19 21:35:50 +00:00
parent dbabb26c22
commit 34a5f331ac
32 changed files with 2275 additions and 60 deletions
+3
View File
@@ -0,0 +1,3 @@
"""Cayce Ops — autonomous operations stack."""
__version__ = "0.1.0"
+154
View File
@@ -0,0 +1,154 @@
"""Cayce Ops CLI (Typer).
Component sub-apps are imported lazily so the skeleton CLI works before every
component module lands, and so one broken component can't take down the CLI.
"""
from __future__ import annotations
import typer
from cayceops import __version__
app = typer.Typer(name="cayceops", help="Cayce autonomous operations stack", no_args_is_help=True)
db_app = typer.Typer(name="db", help="Schema lifecycle")
app.add_typer(db_app)
@db_app.command("init")
def db_init() -> None:
"""Create all tables from ORM metadata (dev/test)."""
from cayceops.db import init_db
init_db()
typer.echo("schema created (metadata.create_all)")
@db_app.command("upgrade")
def db_upgrade() -> None:
"""Run Alembic migrations to head (production path)."""
from cayceops.db import upgrade_db
upgrade_db()
typer.echo("migrations applied")
@app.command()
def version() -> None:
"""Print the version."""
typer.echo(f"cayce-ops {__version__}")
def _load_component(name: str):
"""Import a component module by name (lazy)."""
import importlib
return importlib.import_module(f"cayceops.components.{name}")
# --- scanner -----------------------------------------------------------------
scanner_app = typer.Typer(name="scanner", help="Opportunity discovery (read-only)")
app.add_typer(scanner_app)
@scanner_app.command("run")
def scanner_run() -> None:
"""Scan configured sources and file proposals. Never executes anything."""
raise typer.Exit(_load_component("scanner").run())
# --- executor ----------------------------------------------------------------
executor_app = typer.Typer(name="executor", help="Execute approved proposals")
app.add_typer(executor_app)
@executor_app.command("run")
def executor_run() -> None:
"""Process approved proposals through registered action plugins."""
raise typer.Exit(_load_component("executor").run())
@executor_app.command("approve")
def executor_approve(
proposal_id: int, actor: str = typer.Option(..., help="Human approver id")
) -> None:
"""Approve a proposal (human action, audited)."""
raise typer.Exit(_load_component("executor").approve(proposal_id, actor))
@executor_app.command("reject")
def executor_reject(proposal_id: int, actor: str = typer.Option(...)) -> None:
"""Reject a proposal (human action, audited)."""
raise typer.Exit(_load_component("executor").reject(proposal_id, actor))
# --- maild -------------------------------------------------------------------
maild_app = typer.Typer(name="maild", help="Merchant mail negotiation")
app.add_typer(maild_app)
@maild_app.command("poll")
def maild_poll() -> None:
"""Poll IMAP, classify inbound mail, draft replies."""
raise typer.Exit(_load_component("maild").poll())
@maild_app.command("approve-draft")
def maild_approve(msg_id: int, actor: str = typer.Option(...)) -> None:
"""Approve a drafted reply so SMTP may send it."""
raise typer.Exit(_load_component("maild").approve_draft(msg_id, actor))
@maild_app.command("send-approved")
def maild_send() -> None:
"""Send all approved drafts via SMTP."""
raise typer.Exit(_load_component("maild").send_approved())
# --- publisher ---------------------------------------------------------------
publisher_app = typer.Typer(name="publisher", help="Themed content calendar")
app.add_typer(publisher_app)
@publisher_app.command("plan")
def publisher_plan() -> None:
"""Fill the calendar with drafts for the coming days (per theme rotation)."""
raise typer.Exit(_load_component("publisher").plan())
@publisher_app.command("image")
def publisher_image(item_id: int) -> None:
"""Render the brand image for a content item."""
raise typer.Exit(_load_component("publisher").make_image(item_id))
@publisher_app.command("approve")
def publisher_approve(item_id: int, actor: str = typer.Option(...)) -> None:
"""Approve a draft content item."""
raise typer.Exit(_load_component("publisher").approve(item_id, actor))
@publisher_app.command("publish-due")
def publisher_publish() -> None:
"""Publish approved content items that are due."""
raise typer.Exit(_load_component("publisher").publish_due())
# --- monitor -----------------------------------------------------------------
monitor_app = typer.Typer(name="monitor", help="Static status page")
app.add_typer(monitor_app)
@monitor_app.command("build")
def monitor_build() -> None:
"""Render the static status page (no sensitive data)."""
raise typer.Exit(_load_component("monitor").build())
def main() -> None: # pragma: no cover
app()
if __name__ == "__main__": # pragma: no cover
main()
+1
View File
@@ -0,0 +1 @@
"""Skeleton placeholder packages — one module per component lands in its own PR."""
+167
View File
@@ -0,0 +1,167 @@
"""Cayce Ops — configuration.
All configuration comes from environment variables prefixed with ``CAYCE_OPS_``.
No config files, no defaults that touch the network. See .env.example for the
full list with placeholder values.
"""
from __future__ import annotations
import os
from dataclasses import dataclass, field
def _bool(name: str, default: bool = False) -> bool:
raw = os.environ.get(name)
if raw is None:
return default
return raw.strip().lower() in {"1", "true", "yes", "on"}
def _int(name: str, default: int) -> int:
raw = os.environ.get(name)
if raw is None or not raw.strip():
return default
return int(raw)
def _list(name: str, default: list[str] | None = None) -> list[str]:
raw = os.environ.get(name)
if raw is None or not raw.strip():
return list(default or [])
return [item.strip() for item in raw.split(",") if item.strip()]
@dataclass(frozen=True)
class Config:
"""Snapshot of the process environment. Constructed once per CLI invocation."""
# --- core ---
database_url: str = field(
default_factory=lambda: os.environ.get(
"CAYCE_OPS_DATABASE_URL", "sqlite:///cayce-ops.db"
)
)
autonomous_mode: bool = field(
default_factory=lambda: _bool("CAYCE_OPS_AUTONOMOUS_MODE", False)
)
log_level: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_LOG_LEVEL", "INFO")
)
state_dir: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_STATE_DIR", ".")
)
media_dir: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_MEDIA_DIR", "./media")
)
# --- scanner ---
scanner_sources: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_SCANNER_SOURCES", "[]")
)
scanner_keywords: list[str] = field(
default_factory=lambda: _list(
"CAYCE_OPS_SCANNER_KEYWORDS",
["affiliate", "partnership", "bitcoin", "lightning", "travel"],
)
)
scanner_user_agent: str = field(
default_factory=lambda: os.environ.get(
"CAYCE_OPS_SCANNER_USER_AGENT", "cayce-ops-scanner/0.1"
)
)
# --- executor ---
autonomous_kinds: list[str] = field(
default_factory=lambda: _list("CAYCE_OPS_AUTONOMOUS_KINDS", [])
)
autonomous_daily_cap: int = field(
default_factory=lambda: _int("CAYCE_OPS_AUTONOMOUS_DAILY_CAP", 0)
)
max_attempts: int = field(
default_factory=lambda: _int("CAYCE_OPS_MAX_ATTEMPTS", 2)
)
enable_http_actions: bool = field(
default_factory=lambda: _bool("CAYCE_OPS_ENABLE_HTTP_ACTIONS", False)
)
# --- mail ---
imap_host: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_IMAP_HOST", "")
)
imap_port: int = field(default_factory=lambda: _int("CAYCE_OPS_IMAP_PORT", 993))
imap_user: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_IMAP_USER", "")
)
imap_password: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_IMAP_PASSWORD", "")
)
imap_mailbox: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_IMAP_MAILBOX", "INBOX")
)
smtp_host: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_SMTP_HOST", "")
)
smtp_port: int = field(default_factory=lambda: _int("CAYCE_OPS_SMTP_PORT", 587))
smtp_user: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_SMTP_USER", "")
)
smtp_password: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_SMTP_PASSWORD", "")
)
mail_from: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_MAIL_FROM", "")
)
# --- llm ---
llm_provider: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_LLM_PROVIDER", "null")
)
llm_model: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_LLM_MODEL", "")
)
llm_base_url: str = field(
default_factory=lambda: os.environ.get(
"CAYCE_OPS_LLM_BASE_URL", "https://api.openai.com/v1"
)
)
llm_api_key: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_LLM_API_KEY", "")
)
llm_review_threshold: float = field(
default_factory=lambda: float(
os.environ.get("CAYCE_OPS_LLM_REVIEW_THRESHOLD", "0.7")
)
)
# --- publisher / nostr ---
nostr_private_key: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_NOSTR_PRIVATE_KEY", "")
)
nostr_relays: list[str] = field(
default_factory=lambda: _list("CAYCE_OPS_NOSTR_RELAYS", [])
)
enable_facebook: bool = field(
default_factory=lambda: _bool("CAYCE_OPS_ENABLE_FACEBOOK", False)
)
facebook_page_token: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_FACEBOOK_PAGE_TOKEN", "")
)
enable_instagram: bool = field(
default_factory=lambda: _bool("CAYCE_OPS_ENABLE_INSTAGRAM", False)
)
instagram_user_id: str = field(
default_factory=lambda: os.environ.get("CAYCE_OPS_INSTAGRAM_USER_ID", "")
)
# --- monitor ---
monitor_output: str = field(
default_factory=lambda: os.environ.get(
"CAYCE_OPS_MONITOR_OUTPUT", "./status.html"
)
)
def load() -> Config:
"""Build the process Config snapshot."""
return Config()
+81
View File
@@ -0,0 +1,81 @@
"""Database engine, sessions and schema lifecycle helpers."""
from __future__ import annotations
from collections.abc import Iterator
from contextlib import contextmanager
from sqlalchemy import create_engine, text
from sqlalchemy.orm import Session, sessionmaker
from cayceops.models import Base
_engine = None
_factory: sessionmaker | None = None
def engine(url: str | None = None):
"""Return (and cache) the process SQLAlchemy engine."""
global _engine
if _engine is None:
from cayceops.config import load
_engine = create_engine(url or load().database_url, future=True)
return _engine
def reset_engine() -> None:
"""Drop the cached engine (used by tests and CLI re-entry)."""
global _engine, _factory
if _engine is not None:
_engine.dispose()
_engine = None
_factory = None
def session_factory():
global _factory
if _factory is None:
_factory = sessionmaker(bind=engine(), expire_on_commit=False, future=True)
return _factory
@contextmanager
def session_scope() -> Iterator[Session]:
"""Transactional scope: commit on success, rollback on error."""
s = session_factory()()
try:
yield s
s.commit()
except Exception:
s.rollback()
raise
finally:
s.close()
def init_db() -> None:
"""Create all tables from metadata (dev/test convenience).
Production uses Alembic migrations (``cayceops db upgrade``).
"""
Base.metadata.create_all(engine())
def upgrade_db() -> None:
"""Run Alembic migrations to head."""
from alembic.config import Config as AlembicConfig
from alembic import command
from cayceops.config import load
cfg = AlembicConfig("alembic.ini")
cfg.set_main_option("script_location", "alembic")
cfg.set_main_option("sqlalchemy.url", load().database_url)
command.upgrade(cfg, "head")
def current_revision() -> str | None:
with engine().connect() as conn:
row = conn.execute(text("SELECT version_num FROM alembic_version")).first()
return row[0] if row else None
+80
View File
@@ -0,0 +1,80 @@
"""LLM provider interface — provider-agnostic by design.
The default provider is ``null`` (no network calls, no LLM). Components must
degrade gracefully when the provider is null: rule-based fallbacks kick in.
Adding a provider = implementing ``LLMProvider.complete`` and registering it in
``get_provider``. Provider and model are selected exclusively via env vars
(``CAYCE_OPS_LLM_PROVIDER``, ``CAYCE_OPS_LLM_MODEL``).
"""
from __future__ import annotations
import json
import urllib.request
from typing import Protocol
class LLMProvider(Protocol):
name: str
def complete(self, prompt: str, *, system: str = "", timeout: float = 30.0) -> str:
"""Return the model's completion for the prompt. Raises on failure."""
... # pragma: no cover
class NullProvider:
"""No-op provider: never touches the network. Signals 'no LLM available'."""
name = "null"
def complete(self, prompt: str, *, system: str = "", timeout: float = 30.0) -> str:
raise RuntimeError("LLM provider is 'null': no LLM configured")
class OpenAICompatProvider:
"""Minimal OpenAI-compatible /chat/completions client (stdlib urllib only).
Works with OpenAI, OpenRouter, local llama.cpp/vLLM servers, etc.
"""
name = "openai-compat"
def __init__(self, base_url: str, api_key: str, model: str) -> None:
self.base_url = base_url.rstrip("/")
self.api_key = api_key
self.model = model
def complete(self, prompt: str, *, system: str = "", timeout: float = 30.0) -> str:
payload = {
"model": self.model,
"messages": (
([{"role": "system", "content": system}] if system else [])
+ [{"role": "user", "content": prompt}]
),
"temperature": 0.0,
}
req = urllib.request.Request(
f"{self.base_url}/chat/completions",
data=json.dumps(payload).encode(),
headers={
"Content-Type": "application/json",
"Authorization": f"Bearer {self.api_key}",
},
method="POST",
)
with urllib.request.urlopen(req, timeout=timeout) as resp: # noqa: S310 (base_url is operator-configured)
body = json.loads(resp.read().decode())
return body["choices"][0]["message"]["content"]
def get_provider(cfg=None) -> LLMProvider:
"""Build the provider named by CAYCE_OPS_LLM_PROVIDER (default: null)."""
from cayceops.config import load
cfg = cfg or load()
if cfg.llm_provider == "null":
return NullProvider()
if cfg.llm_provider == "openai-compat":
return OpenAICompatProvider(cfg.llm_base_url, cfg.llm_api_key, cfg.llm_model)
raise ValueError(f"unknown LLM provider: {cfg.llm_provider!r}")
+197
View File
@@ -0,0 +1,197 @@
"""ORM models and lifecycle states shared by every component.
Status machines
---------------
proposal: proposed -> approved -> running -> done | failed
proposed -> rejected
mail: (inbound) classified: approval|rejection|question|other|needs_review
(outbound draft) none -> drafted -> approved -> sent | skipped
content: draft -> approved -> published
"""
from __future__ import annotations
import enum
from datetime import UTC, datetime
from sqlalchemy import JSON, DateTime, Enum, Float, ForeignKey, Integer, String, Text
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
def utcnow() -> datetime:
return datetime.now(UTC)
class Base(DeclarativeBase):
pass
# --- proposals ---------------------------------------------------------------
class ProposalStatus(enum.StrEnum):
PROPOSED = "proposed"
APPROVED = "approved"
REJECTED = "rejected"
RUNNING = "running"
DONE = "done"
FAILED = "failed"
class ProposalSource(enum.StrEnum):
SCANNER = "scanner"
MANUAL = "manual"
class Proposal(Base):
__tablename__ = "proposals"
id: Mapped[int] = mapped_column(Integer, primary_key=True)
source: Mapped[ProposalSource] = mapped_column(
Enum(ProposalSource), default=ProposalSource.SCANNER
)
kind: Mapped[str] = mapped_column(String(64)) # affiliate|partnership|content_gap|other
title: Mapped[str] = mapped_column(String(512))
url: Mapped[str | None] = mapped_column(String(1024), nullable=True)
detail: Mapped[dict] = mapped_column(JSON, default=dict)
risk_score: Mapped[float] = mapped_column(Float, default=0.0)
status: Mapped[ProposalStatus] = mapped_column(
Enum(ProposalStatus), default=ProposalStatus.PROPOSED, index=True
)
attempts: Mapped[int] = mapped_column(Integer, default=0)
dedupe_key: Mapped[str | None] = mapped_column(String(256), unique=True, nullable=True)
approved_by: Mapped[str | None] = mapped_column(String(128), nullable=True)
approved_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=utcnow)
updated_at: Mapped[datetime] = mapped_column(
DateTime(timezone=True), default=utcnow, onupdate=utcnow
)
# --- audit -------------------------------------------------------------------
class AuditEntry(Base):
__tablename__ = "audit_log"
id: Mapped[int] = mapped_column(Integer, primary_key=True)
ts: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=utcnow, index=True)
actor: Mapped[str] = mapped_column(String(128)) # human username | auto:policy | daemon:<name>
proposal_id: Mapped[int | None] = mapped_column(
ForeignKey("proposals.id", ondelete="SET NULL"), nullable=True, index=True
)
action: Mapped[str] = mapped_column(String(64)) # approve|reject|execute|classify|...
detail: Mapped[dict] = mapped_column(JSON, default=dict)
result: Mapped[str] = mapped_column(String(32), default="ok") # ok | error
def audit(
sess,
actor: str,
action: str,
proposal_id: int | None = None,
detail: dict | None = None,
result: str = "ok",
) -> AuditEntry:
"""Record one audited action. Every component writes through this helper."""
entry = AuditEntry(
actor=actor,
action=action,
proposal_id=proposal_id,
detail=detail or {},
result=result,
)
sess.add(entry)
return entry
# --- mail --------------------------------------------------------------------
class MailDirection(enum.StrEnum):
INBOUND = "in"
OUTBOUND = "out"
class MailClassification(enum.StrEnum):
APPROVAL = "approval"
REJECTION = "rejection"
QUESTION = "question"
OTHER = "other"
NEEDS_REVIEW = "needs_review"
class DraftStatus(enum.StrEnum):
NONE = "none"
DRAFTED = "drafted"
APPROVED = "approved" # human approved the draft; SMTP may send it
SENT = "sent"
SKIPPED = "skipped"
class MailMessage(Base):
__tablename__ = "mail_messages"
id: Mapped[int] = mapped_column(Integer, primary_key=True)
direction: Mapped[MailDirection] = mapped_column(Enum(MailDirection))
message_id: Mapped[str | None] = mapped_column(String(998), nullable=True, index=True)
in_reply_to: Mapped[str | None] = mapped_column(String(998), nullable=True)
from_addr: Mapped[str | None] = mapped_column(String(320), nullable=True)
to_addr: Mapped[str | None] = mapped_column(String(320), nullable=True)
subject: Mapped[str | None] = mapped_column(String(998), nullable=True)
body: Mapped[str | None] = mapped_column(Text, nullable=True)
classification: Mapped[MailClassification | None] = mapped_column(
Enum(MailClassification), nullable=True
)
confidence: Mapped[float] = mapped_column(Float, default=0.0)
proposal_id: Mapped[int | None] = mapped_column(
ForeignKey("proposals.id", ondelete="SET NULL"), nullable=True, index=True
)
draft_status: Mapped[DraftStatus] = mapped_column(
Enum(DraftStatus), default=DraftStatus.NONE
)
draft_reply: Mapped[str | None] = mapped_column(Text, nullable=True)
processed_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
# --- content -----------------------------------------------------------------
class ContentStatus(enum.StrEnum):
DRAFT = "draft"
APPROVED = "approved"
PUBLISHED = "published"
class ContentItem(Base):
__tablename__ = "content_items"
id: Mapped[int] = mapped_column(Integer, primary_key=True)
theme: Mapped[str] = mapped_column(String(128))
channel: Mapped[str] = mapped_column(String(32)) # nostr|facebook|instagram
caption: Mapped[str] = mapped_column(Text)
media_path: Mapped[str | None] = mapped_column(String(1024), nullable=True)
link: Mapped[str | None] = mapped_column(String(1024), nullable=True)
status: Mapped[ContentStatus] = mapped_column(
Enum(ContentStatus), default=ContentStatus.DRAFT, index=True
)
scheduled_for: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
published_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
post_ref: Mapped[str | None] = mapped_column(String(512), nullable=True)
error: Mapped[str | None] = mapped_column(Text, nullable=True)
created_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=utcnow)
# --- daemon runs (monitor input) ---------------------------------------------
class DaemonRun(Base):
__tablename__ = "daemon_runs"
id: Mapped[int] = mapped_column(Integer, primary_key=True)
# scanner | executor | maild | publisher | monitor
daemon: Mapped[str] = mapped_column(String(32), index=True)
started_at: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=utcnow)
finished_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True)
status: Mapped[str] = mapped_column(String(16), default="ok") # ok | error
detail: Mapped[dict] = mapped_column(JSON, default=dict)