From 7a633117140afcee8686a08ec9e428e7d765bdd5 Mon Sep 17 00:00:00 2001 From: Wolf Date: Wed, 23 Sep 2026 12:30:10 +0200 Subject: [PATCH] Rename the package roledesk to app The boilerplate's rule: the deploy kit's Dockerfile, the APP_CONFIG, APP_PASSWORD and APP_DATA variables and its commands all assume a package called app, so a project renames its display title and nothing else. The console script is `app`, and the launch entry runs `uv run app serve --port 8790`. The domain noun stays `role`. Co-Authored-By: Claude Opus 5.5 --- .claude/launch.json | 2 +- CLAUDE.md | 6 ++++- {roledesk => app}/__init__.py | 0 {roledesk => app}/cli.py | 26 +++++++++++----------- {roledesk => app}/config.py | 6 ++--- {roledesk => app}/jobs/__init__.py | 10 ++++----- {roledesk => app}/jobs/cascade.py | 6 ++--- {roledesk => app}/jobs/embed.py | 8 +++---- {roledesk => app}/jobs/extract.py | 6 ++--- {roledesk => app}/jobs/pull.py | 8 +++---- {roledesk => app}/jobs/score.py | 8 +++---- {roledesk => app}/models.py | 2 +- {roledesk => app}/storage/__init__.py | 6 ++--- {roledesk => app}/storage/schema.py | 0 {roledesk => app}/storage/store.py | 4 ++-- {roledesk => app}/web/__init__.py | 2 +- {roledesk => app}/web/api.py | 4 ++-- {roledesk => app}/web/app.py | 10 ++++----- {roledesk => app}/web/deps.py | 4 ++-- {roledesk => app}/web/pages.py | 8 +++---- {roledesk => app}/web/static/app.css | 0 {roledesk => app}/web/static/app.js | 0 {roledesk => app}/web/templates/index.html | 2 +- config.example.yaml | 6 ++--- plugins/ats.py | 8 +++---- pyproject.toml | 8 +++---- tests/test_architecture.py | 22 +++++++++--------- tests/test_extract.py | 6 ++--- tests/test_pull.py | 4 ++-- tests/test_score.py | 10 ++++----- tests/test_storage.py | 4 ++-- tests/test_web.py | 4 ++-- 32 files changed, 102 insertions(+), 98 deletions(-) rename {roledesk => app}/__init__.py (100%) rename {roledesk => app}/cli.py (92%) rename {roledesk => app}/config.py (95%) rename {roledesk => app}/jobs/__init__.py (81%) rename {roledesk => app}/jobs/cascade.py (94%) rename {roledesk => app}/jobs/embed.py (94%) rename {roledesk => app}/jobs/extract.py (98%) rename {roledesk => app}/jobs/pull.py (95%) rename {roledesk => app}/jobs/score.py (98%) rename {roledesk => app}/models.py (99%) rename {roledesk => app}/storage/__init__.py (72%) rename {roledesk => app}/storage/schema.py (100%) rename {roledesk => app}/storage/store.py (99%) rename {roledesk => app}/web/__init__.py (73%) rename {roledesk => app}/web/api.py (98%) rename {roledesk => app}/web/app.py (85%) rename {roledesk => app}/web/deps.py (86%) rename {roledesk => app}/web/pages.py (86%) rename {roledesk => app}/web/static/app.css (100%) rename {roledesk => app}/web/static/app.js (100%) rename {roledesk => app}/web/templates/index.html (98%) diff --git a/.claude/launch.json b/.claude/launch.json index a7df7de..98c9429 100644 --- a/.claude/launch.json +++ b/.claude/launch.json @@ -6,7 +6,7 @@ "runtimeExecutable": "uv", "runtimeArgs": [ "run", - "roledesk", + "app", "serve", "--port", "8790" diff --git a/CLAUDE.md b/CLAUDE.md index 3931c6c..ef3232b 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -27,4 +27,8 @@ Good example: # Rule: -`desk` and `pipeline` are imported from ../news and never edited here. +The package is `app`, following the boilerplate: the deploy kit, `APP_CONFIG`, `APP_PASSWORD` and `APP_DATA` assume that name. The domain noun is `role`, so "job" only ever means queued work. + +# Rule: + +`pipeline/`, `auth/` and `deploy/` are downstream copies of `../boilerplate`, `desk/` of `../news`. They are refreshed with `git archive`, and a fix lands upstream first, otherwise the next refresh reverts it. diff --git a/roledesk/__init__.py b/app/__init__.py similarity index 100% rename from roledesk/__init__.py rename to app/__init__.py diff --git a/roledesk/cli.py b/app/cli.py similarity index 92% rename from roledesk/cli.py rename to app/cli.py index 604b2c2..eef6024 100644 --- a/roledesk/cli.py +++ b/app/cli.py @@ -1,4 +1,4 @@ -"""`roledesk serve | job pull|extract|embed|score | companies seed|add|check | db init`.""" +"""`app serve | job pull|extract|embed|score | companies seed|add|check | db init`.""" from __future__ import annotations @@ -9,12 +9,12 @@ import sys from pathlib import Path from typing import TYPE_CHECKING -from roledesk import config as config_mod +from app import config as config_mod if TYPE_CHECKING: - from roledesk.storage import Store + from app.storage import Store -#: The one plugin this app ships lives outside the `roledesk` package, in +#: The one plugin this app ships lives outside the `app` package, in #: `plugins/`, so it is discovered by `desk.sources.registry` the same way a #: user's own drop-in plugin would be. `companies` and `job pull` both want #: its plain functions (`is_known_target`, `careers_url`, `fetch_board`) as @@ -26,7 +26,7 @@ if str(_ROOT) not in sys.path: def build_parser() -> argparse.ArgumentParser: - parser = argparse.ArgumentParser(prog="roledesk", + parser = argparse.ArgumentParser(prog="app", description="A job-search engine on desk.") parser.add_argument("-c", "--config", default=None, help="path to roles.yaml") parser.add_argument("-v", "--verbose", action="store_true") @@ -60,7 +60,7 @@ def main(argv: list[str] | None = None) -> int: format="%(asctime)s %(levelname)s %(name)s: %(message)s") try: if args.command == "serve": - from roledesk.web import serve + from app.web import serve config_mod.load(args.config) # a config error here, not in uvicorn return serve(args.host, args.port, args.config) if args.command == "job": @@ -79,8 +79,8 @@ def run_job(args: argparse.Namespace) -> int: ended: one line per task, from each task's final job. `pull` is a cascade, so it prints a line for every stage it went through.""" from pipeline import FINAL, JobQueue, Jobs, TASKS - from roledesk import jobs - from roledesk.storage import Store + from app import jobs + from app.storage import Store config = config_mod.load(args.config) store = Store(config.database) @@ -117,7 +117,7 @@ def run_job(args: argparse.Namespace) -> int: def run_companies(args: argparse.Namespace) -> int: - from roledesk.storage import Store + from app.storage import Store config = config_mod.load(args.config) store = Store(config.database) @@ -162,11 +162,11 @@ def seed_companies(store: Store, path: str) -> dict[str, int]: def add_company(store: Store, board: str, name: str) -> int: - """`roledesk companies add greenhouse:acme "Acme"`: fetch the board first + """`app companies add greenhouse:acme "Acme"`: fetch the board first and refuse if it does not answer, is not a known host, or the company already exists. Port of seedgen's `-add`.""" from plugins.ats import careers_url as careers_url_of, fetch_board, is_known_target - from roledesk.models import company_key + from app.models import company_key if not is_known_target(board): print(f"companies add: {board!r} is not host:slug for a known ATS host", @@ -197,7 +197,7 @@ def add_company(store: Store, board: str, name: str) -> int: def check_companies(store: Store) -> int: - """`roledesk companies check`: every `ats` board, fetched once. Prints a + """`app companies check`: every `ats` board, fetched once. Prints a line per board that did not answer and exits 1 if any did not.""" from plugins.ats import fetch_board @@ -216,7 +216,7 @@ def check_companies(store: Store) -> int: def init_db(args: argparse.Namespace) -> int: """Create the file, or bring it to the current schema.""" - from roledesk.storage import LATEST, Store + from app.storage import LATEST, Store config = config_mod.load(args.config) store = Store(config.database) diff --git a/roledesk/config.py b/app/config.py similarity index 95% rename from roledesk/config.py rename to app/config.py index 4959f95..73b6b83 100644 --- a/roledesk/config.py +++ b/app/config.py @@ -14,14 +14,14 @@ import yaml from pydantic import Field, ValidationError from desk.config import AgentConfig, ModelTaskConfig, Section, WorkersConfig -from roledesk.models import Gate, Weights +from app.models import Gate, Weights DEFAULT_PATH = Path(os.environ.get("ROLEDESK_CONFIG", "roles.yaml")) class ExtractConfig(ModelTaskConfig): """Turning a posting's title and text into the gate columns. See - roledesk/jobs/extract.py. Off by default, so nobody is billed by surprise: + app/jobs/extract.py. Off by default, so nobody is billed by surprise: on the API backend every batch is a paid call.""" enabled: bool = False @@ -32,7 +32,7 @@ class ExtractConfig(ModelTaskConfig): class EmbedConfig(Section): """Turning a role into a vector for `fit`. Needs sentence-transformers; without it `embed` says so and does nothing, and `score` leaves fit out. - See roledesk/jobs/embed.py.""" + See app/jobs/embed.py.""" #: Recorded on every vector. Changing it drops the old vectors, which are #: a different geometry and never comparable. diff --git a/roledesk/jobs/__init__.py b/app/jobs/__init__.py similarity index 81% rename from roledesk/jobs/__init__.py rename to app/jobs/__init__.py index 02ea355..a2593f9 100644 --- a/roledesk/jobs/__init__.py +++ b/app/jobs/__init__.py @@ -10,18 +10,18 @@ every task in `pipeline.TASKS`. from __future__ import annotations -from roledesk.jobs import cascade, embed, extract, pull, score -from roledesk.jobs.score import seed_agents +from app.jobs import cascade, embed, extract, pull, score +from app.jobs.score import seed_agents #: What `JobQueue(bootstrap=...)` and `pipeline.worker --bootstrap` are given. -BOOTSTRAP = "roledesk.jobs:bootstrap" +BOOTSTRAP = "app.jobs:bootstrap" def bootstrap(config_path: str = "") -> tuple[object, object]: """roledesk's `(config, store)` from the config file alone, for a job run in its own process or by `python -m pipeline.worker`.""" - from roledesk import config as config_mod - from roledesk.storage import Store + from app import config as config_mod + from app.storage import Store config = config_mod.load(config_path or None) return config, Store(config.database) diff --git a/roledesk/jobs/cascade.py b/app/jobs/cascade.py similarity index 94% rename from roledesk/jobs/cascade.py rename to app/jobs/cascade.py index 3e42696..f2cf15d 100644 --- a/roledesk/jobs/cascade.py +++ b/app/jobs/cascade.py @@ -26,9 +26,9 @@ from typing import Any from desk.tools import agent from pipeline import TASKS, Tally, Task -from roledesk.jobs import embed, extract, pull, score # noqa: F401 -- registers the jobs +from app.jobs import embed, extract, pull, score # noqa: F401 -- registers the jobs -STEP = "roledesk.jobs.cascade:step" +STEP = "app.jobs.cascade:step" CASCADES: dict[str, tuple[str, ...]] = { "pull": ("pull", "extract", "embed", "score"), @@ -98,7 +98,7 @@ def step(config: Any, store: Any, tally: Tally, payload: dict[str, Any], *, return out -#: What `roledesk job ` and the Jobs view offer. `pull` is the whole +#: What `app job ` and the Jobs view offer. `pull` is the whole #: chain; the others are one stage each, on their own. TASKS["pull"] = partial(task, "pull", cascade="pull") for _name in ("extract", "embed", "score"): diff --git a/roledesk/jobs/embed.py b/app/jobs/embed.py similarity index 94% rename from roledesk/jobs/embed.py rename to app/jobs/embed.py index 15b2486..defc876 100644 --- a/roledesk/jobs/embed.py +++ b/app/jobs/embed.py @@ -16,9 +16,9 @@ from typing import Any from desk.tools import embedding from pipeline import NULL, Notice, RunContext, job -from roledesk.config import Config -from roledesk.models import Role -from roledesk.storage import Store +from app.config import Config +from app.models import Role +from app.storage import Store log = logging.getLogger(__name__) @@ -49,7 +49,7 @@ def unavailable(exc: BaseException) -> Notice: "and scores leave fit out.", fix="Install it into roledesk's environment: " "`uv pip install sentence-transformers`.", - detail=str(exc), where="roledesk.jobs.embed") + detail=str(exc), where="app.jobs.embed") @job("embed", "Embedding roles", solo=True, resource="cpu") diff --git a/roledesk/jobs/extract.py b/app/jobs/extract.py similarity index 98% rename from roledesk/jobs/extract.py rename to app/jobs/extract.py index 70eee3e..f64a0a1 100644 --- a/roledesk/jobs/extract.py +++ b/app/jobs/extract.py @@ -28,9 +28,9 @@ from typing import Any from desk import modeltask from desk.modeltask import ModelTask from pipeline import NULL, RunContext, Task, job -from roledesk.config import Config -from roledesk.models import PERMITS, REMOTE, SENIORITIES, ExtractResult, Role -from roledesk.storage import Store +from app.config import Config +from app.models import PERMITS, REMOTE, SENIORITIES, ExtractResult, Role +from app.storage import Store # `FUNCTIONS` is the `ats` plugin's vocabulary, reached the way `web/pages.py` # reaches it, so the classifier and the model answer in the same nine words. diff --git a/roledesk/jobs/pull.py b/app/jobs/pull.py similarity index 95% rename from roledesk/jobs/pull.py rename to app/jobs/pull.py index faa1817..479afb9 100644 --- a/roledesk/jobs/pull.py +++ b/app/jobs/pull.py @@ -22,8 +22,8 @@ from typing import Any from pipeline import NULL, RunContext, Tally, Task, job -from roledesk.config import Config -from roledesk.storage import Store +from app.config import Config +from app.storage import Store log = logging.getLogger(__name__) @@ -32,7 +32,7 @@ log = logging.getLogger(__name__) #: holding all 190-odd boards' worth of retries against a single attempt. BATCH_SIZE = 10 -SETTLE = "roledesk.jobs.pull:close_boards" +SETTLE = "app.jobs.pull:close_boards" def _now() -> str: @@ -104,7 +104,7 @@ def close_boards(config: Config, store: Store, tally: Tally, *, def pull_task() -> Task: - """The pull on its own. `roledesk.jobs.cascade` makes it the first stage + """The pull on its own. `app.jobs.cascade` makes it the first stage of the chain that `TASKS["pull"]` starts.""" return Task(kind="pull_batch", finder=_boards, name="pull", label="Reading every board", settle=SETTLE) diff --git a/roledesk/jobs/score.py b/app/jobs/score.py similarity index 98% rename from roledesk/jobs/score.py rename to app/jobs/score.py index db53556..fdba1ee 100644 --- a/roledesk/jobs/score.py +++ b/app/jobs/score.py @@ -32,10 +32,10 @@ from typing import Any import numpy as np from pipeline import NULL, RunContext, job -from roledesk.config import Config -from roledesk.jobs import embed -from roledesk.models import Agent, Candidate, Gate, Weights -from roledesk.storage import Store +from app.config import Config +from app.jobs import embed +from app.models import Agent, Candidate, Gate, Weights +from app.storage import Store log = logging.getLogger(__name__) diff --git a/roledesk/models.py b/app/models.py similarity index 99% rename from roledesk/models.py rename to app/models.py index 7f11f5e..14b9bd1 100644 --- a/roledesk/models.py +++ b/app/models.py @@ -139,7 +139,7 @@ class Role(Model): class ExtractResult(ModelTaskResult): - """What one run of `extract` did. See roledesk/jobs/extract.py.""" + """What one run of `extract` did. See app/jobs/extract.py.""" #: Roles the model answered for, whether or not it found anything to fill. extracted: int = 0 diff --git a/roledesk/storage/__init__.py b/app/storage/__init__.py similarity index 72% rename from roledesk/storage/__init__.py rename to app/storage/__init__.py index 3340be7..b4eea12 100644 --- a/roledesk/storage/__init__.py +++ b/app/storage/__init__.py @@ -1,4 +1,4 @@ -"""Where things are kept. One door: `from roledesk.storage import Store`. +"""Where things are kept. One door: `from app.storage import Store`. schema.py the tables, and the numbered migrations that bring an older file to the current shape @@ -10,7 +10,7 @@ package on purpose, and the connection plumbing here is a deliberate copy. from __future__ import annotations -from roledesk.storage.schema import LATEST -from roledesk.storage.store import Store +from app.storage.schema import LATEST +from app.storage.store import Store __all__ = ["LATEST", "Store"] diff --git a/roledesk/storage/schema.py b/app/storage/schema.py similarity index 100% rename from roledesk/storage/schema.py rename to app/storage/schema.py diff --git a/roledesk/storage/store.py b/app/storage/store.py similarity index 99% rename from roledesk/storage/store.py rename to app/storage/store.py index c214b3d..eb6950f 100644 --- a/roledesk/storage/store.py +++ b/app/storage/store.py @@ -20,12 +20,12 @@ from uuid import uuid4 import numpy as np from desk.models import Item -from roledesk.models import ( +from app.models import ( AFFINITY, REMOTE, STATUSES, Agent, Application, ApplicationEvent, Candidate, Company, Gate, Role, ScoredRole, Subscription, Weights, company_key, place_key, title_key, ) -from roledesk.storage import schema +from app.storage import schema #: Text columns a plugin may fill from `Item.raw` under the same name. An #: empty value never overwrites a filled column, so an upsert from a board that diff --git a/roledesk/web/__init__.py b/app/web/__init__.py similarity index 73% rename from roledesk/web/__init__.py rename to app/web/__init__.py index d9729c8..5efb954 100644 --- a/roledesk/web/__init__.py +++ b/app/web/__init__.py @@ -2,6 +2,6 @@ from __future__ import annotations -from roledesk.web.app import create_app, serve +from app.web.app import create_app, serve __all__ = ["create_app", "serve"] diff --git a/roledesk/web/api.py b/app/web/api.py similarity index 98% rename from roledesk/web/api.py rename to app/web/api.py index 8c75502..ede70f6 100644 --- a/roledesk/web/api.py +++ b/app/web/api.py @@ -12,10 +12,10 @@ from typing import Annotated from fastapi import APIRouter, HTTPException, Query, Response from pydantic import BaseModel, Field -from roledesk.models import ( +from app.models import ( AFFINITY, Agent, Application, Company, Gate, ScoredRole, Status, Weights, ) -from roledesk.web.deps import StoreDep +from app.web.deps import StoreDep router = APIRouter(prefix="/api", tags=["roledesk"]) diff --git a/roledesk/web/app.py b/app/web/app.py similarity index 85% rename from roledesk/web/app.py rename to app/web/app.py index 29bf222..1f3df50 100644 --- a/roledesk/web/app.py +++ b/app/web/app.py @@ -10,11 +10,11 @@ from fastapi.staticfiles import StaticFiles from pipeline import Jobs from pipeline.web import connect -from roledesk import config as config_mod -from roledesk import jobs -from roledesk.storage import Store -from roledesk.web.api import router as api_router -from roledesk.web.pages import router as pages_router +from app import config as config_mod +from app import jobs +from app.storage import Store +from app.web.api import router as api_router +from app.web.pages import router as pages_router WEB = Path(__file__).resolve().parent diff --git a/roledesk/web/deps.py b/app/web/deps.py similarity index 86% rename from roledesk/web/deps.py rename to app/web/deps.py index e40d149..7e0b2cd 100644 --- a/roledesk/web/deps.py +++ b/app/web/deps.py @@ -6,7 +6,7 @@ it as a dependency rather than closing over it, the same split newsdesk's importable, and testable, on its own. Not a `yield` dependency: `Store` holds no connection between calls (see -`roledesk/storage/store.py`), so there is nothing to close, and building one +`app/storage/store.py`), so there is nothing to close, and building one per request would take SQLite's write lock for a plain read. """ @@ -17,7 +17,7 @@ from typing import Annotated from fastapi import Depends from starlette.requests import HTTPConnection -from roledesk.storage import Store +from app.storage import Store def get_store(request: HTTPConnection) -> Store: diff --git a/roledesk/web/pages.py b/app/web/pages.py similarity index 86% rename from roledesk/web/pages.py rename to app/web/pages.py index c7b326e..a3e9bd7 100644 --- a/roledesk/web/pages.py +++ b/app/web/pages.py @@ -3,10 +3,10 @@ hands the browser an empty shell — the filter bar, the section headers, the `