quirework 0.1.0__py3-none-any.whl

quirework/templates/backup.toml

@@ -0,0 +1,39 @@
+# How this provenance store is backed up. It sits in the store, beside
+# store.toml, and `quirework provenance store backup` reads it; `--help`
+# there says what each driver does. Claude Code deletes its transcripts
+# 30 days after they last changed, and from then on the store holds the
+# only copy of a session, so name at least one target.
+#
+# Each [targets.<name>] table is one destination. The name is yours, and
+# `store backup --target <name>` runs that one alone. Replace the example
+# below with your own, and uncomment any other you want.
+
+# rclone copies to any remote `rclone config` has set up: Google Drive,
+# SFTP, S3, or a crypt remote that encrypts before anything leaves the
+# machine. Give every store a folder of its own: a destination that holds
+# another store's files is refused.
+[targets.drive]
+driver = "rclone"
+destination = "remote:quirework-provenance/my-book"
+
+# directory copies in plain Python to a path that already exists, such as
+# a mounted share. It never creates that directory, so a share that did
+# not mount is refused instead of being filled on the local disk.
+# [targets.nas]
+# driver = "directory"
+# destination = "/mnt/backup/quirework-provenance/my-book"
+
+# git makes the store its own repository and every run a commit. History
+# keeps what the working tree drops, at the cost of disk: a pending capture
+# that grows is committed whole again on each run.
+# [targets.history]
+# driver = "git"
+# remote = "git@example.org:me/my-book-provenance.git"
+# branch = "main"
+
+# command runs a script kept at the store's top level, owned by you and
+# writable by nobody else. It gets QUIREWORK_STORE, QUIREWORK_STORE_ID and
+# QUIREWORK_BACKUP_TARGET, and keeps the backup's rules itself.
+# [targets.custom]
+# driver = "command"
+# command = ["backup.sh"]

quirework/templates/book.toml

@@ -0,0 +1,88 @@
+# Copy to quirework.toml at the root of a book written with Quarto.
+# Paths are relative to this file; local overrides go in the ignored
+# quirework.local.toml. Quirework never locates a project from its install.
+# For a site, start from `quirework config template site` instead.
+
+# Version of the configuration schema.
+schema = 2
+
+[project]
+# A display name for reports and configuration inspection.
+name = "Example Book"
+# Ignored working notes that may be discarded or reorganized freely.
+scratchpad = "scratchpad"
+# Ignored project material that must never be published.
+private = "private"
+
+[manuscript]
+# Contains _quarto.yml and the live manuscript sources.
+source = "manuscript"
+# Quarto project file used for reading order.
+quarto = "manuscript/_quarto.yml"
+# The chapter directory inside source; change to match your layout.
+chapters = "manuscript/sections"
+# Optional semantic register if your book uses annotation bindings.
+# spec = "manuscript/sections/_spec.md"
+# With a spec, point each section at the conversations that shaped it.
+# The sidecar points into the private corpus, so it stays private too.
+# spec_trail = "private/spec-trail.md"
+# Backfilling that trail from an existing corpus keeps a ledger of leads.
+# spec_trail_leads = "private/spec-trail-leads"
+# Optional book-wide annotations used by the red-pen review copy.
+# review_notes = "manuscript/sections/_review-notes.md"
+# Reader-facing documents that cite the spec or quote the canon.
+companion_dirs = ["companion"]
+# Working material is never treated as an authority by annotation checks.
+noncanonical_roots = ["scratchpad"]
+# Optional project terminology and formatting policy.
+# chapter_policy = "config/chapters.toml"
+
+[publish]
+# Authoritative SVG assets used to materialize render galleries.
+figures = "manuscript/sections/illustrations"
+# Generated output only. Keep this directory out of Git.
+build = "build"
+# Derived editions live outside the canon source tree.
+variants = "variants"
+
+[sops]
+# Project-owned procedures and their required-reading catalog.
+root = "procedures"
+catalog = "procedures/catalog.json"
+# Perspectives and questions are separate, independently versioned data.
+personas = "profiles"
+instruments = "questions"
+# The prefix belongs to the book, not to the installed tool.
+skill_prefix = "example-"
+
+[provenance]
+# A book can publish and run model plans without a private corpus.
+enabled = false
+# The ledger, committed with the book: which sessions were accepted,
+# which were removed and why, and the catalog built from them.
+# root = "private/provenance"
+# The store that keeps the captured sessions themselves, outside the
+# repository: a name under the provenance home, which provenance.home
+# in ~/.config/quirework/config.toml sets and which is otherwise
+# ~/.local/share/quirework/provenance. Create it with `quirework
+# provenance store init`, and back it up: `quirework config template
+# backup` prints the backup.toml the store reads.
+# store = "my-book"
+# Private redaction rules protect blind analyst copies, not primary data.
+# redaction_policy = "private/redactions.toml"
+
+[usage]
+# Which commands and procedures this project runs, and which model
+# seats it launches, recorded on this machine and read back by
+# `quirework usage`. Nothing is sent anywhere, no command arguments are
+# kept, and one shared store across your books is what makes the
+# comparison between them worth anything.
+# enabled = true
+# Omit to share the per-user store under the XDG state tree.
+# store = "~/.local/state/quirework/usage"
+
+[runs]
+# Omit to use a separate directory for this project in the XDG state tree.
+# store = "~/private/example-book-runs"
+# Reviewed output may live with the book; raw sessions stay private.
+reviews = ".quirework/reviews"

quirework/templates/run.toml

@@ -0,0 +1,32 @@
+# A deliberately tiny, single-turn model test. Preparation freezes this
+# plan but does not launch it. Starting it invokes the selected provider.
+
+# Human-readable purpose recorded with the run.
+title = "Read a fictional note"
+
+[[seats]]
+# Stable identity of this independent session within the run.
+id = "reader"
+# Native transport. Select a provider installed and configured locally.
+harness = "codex"
+# An inexpensive model, named by family: preparation resolves it to the
+# newest version the Codex catalog lists and freezes that. A version such
+# as "gpt-5.6-luna" pins the seat instead.
+model = "luna"
+# Low effort keeps this synthetic test small; real work chooses its own.
+effort = "low"
+
+[seats.policy]
+# No tool use is permitted in this assignment.
+tools = "none"
+# Require OS-enforced file isolation. Agy supports audited instead.
+filesystem = "enforced"
+# Replace the native base prompt to avoid unnecessary test overhead.
+# Supported by Codex and Claude; omit for providers without this feature.
+system_prompt = "Complete the small supplied task. Answer briefly."
+
+[[seats.turns]]
+# Turn order is explicit. A completed turn's answer is immutable.
+id = "one"
+# This is all the test material; no book or source repository is supplied.
+prompt = "A fictional note says the lantern is green. Reply only with the color."

quirework/templates/site.toml

@@ -0,0 +1,90 @@
+# Copy to quirework.toml at the root of a site, such as a Hugo blog.
+# Paths are relative to this file; local overrides go in the ignored
+# quirework.local.toml. Quirework never locates a project from its install.
+# For a book, start from `quirework config template book` instead.
+
+# Version of the configuration schema.
+schema = 2
+
+[project]
+# A display name for reports and configuration inspection.
+name = "Example Site"
+# Ignored project material that must never be published.
+private = "private"
+
+[manuscript]
+# The site's pages are the units of the work.
+format = "pages"
+# The directory the site generator renders.
+source = "content"
+# Each post is a page bundle, content/posts/<slug>/index.md, named by
+# its directory. Name collections instead to make other pages units too.
+pages = "posts/*/index.md"
+# [manuscript.collections.posts]
+# pages = "posts/*/index.md"
+# [manuscript.collections.pages]
+# pages = "*.md"
+# order = "title"
+# What messages call one unit.
+unit_name = "post"
+# Marks live outside the rendered tree, so no reader is ever served them.
+marks = "specs/{slug}/marks.md"
+# What several posts lean on, and what each post commits to on its own.
+spec = "specs/_site.md"
+unit_spec = "specs/{slug}/spec.md"
+# Briefs a post may grow from; `spec units` lists the ones not taken up.
+# ideas = "ideas/*/brief.md"
+# Working material is never treated as an authority by annotation checks.
+noncanonical_roots = ["ideas/"]
+# The frontmatter field a published post's revision is recorded in.
+# revision_field = "lastmod"
+# The sources the posts stand on, and plain-text captures of them.
+# sources = "research/sources.md"
+# source_copies = "research/copies/{slug}.txt"
+# With a spec, point each section at the conversations that shaped it.
+# spec_trail = "private/spec-trail.md"
+
+[publish]
+# The site's own configuration decides the render; Quirework builds it
+# into build/site and never into the directory the site deploys from.
+backend = "hugo"
+build = "build"
+# Where hugo.toml lives, when it is not the project root.
+# site = "."
+
+[text]
+# Posts one sentence per line, other Markdown at 72 columns, generated
+# trees left alone. The first matching row wins.
+modes = [
+  ["content/**/*.md", "sentence"],
+  ["public/**", "skip"],
+  ["resources/**", "skip"],
+  ["build/**", "skip"],
+  ["**/*.md", "column"],
+]
+# Voice rules a machine can hold: `quirework config template terminology`.
+# terminology = "quirework/terms.toml"
+
+[sops]
+# Project-owned procedures and their required-reading catalog.
+root = "procedures"
+catalog = "procedures/catalog.json"
+# The prefix belongs to the site, not to the installed tool.
+skill_prefix = "example-"
+
+[provenance]
+# A site can publish and run model plans without a private corpus.
+enabled = false
+# The ledger, committed with the site, and the store that keeps the
+# captured sessions outside it, under the provenance home that
+# provenance.home in ~/.config/quirework/config.toml sets. Back the
+# store up: `quirework config template backup` prints the backup.toml
+# it reads.
+# root = "private/provenance"
+# store = "my-site"
+
+[usage]
+# Which commands and procedures this project runs, and which model
+# seats it launches, recorded on this machine and read back by
+# `quirework usage`. Nothing is sent anywhere.
+# enabled = true

quirework/templates/tells.toml

@@ -0,0 +1,64 @@
+# Example machine-habit policy. Point text.tells_policy at this file.
+#
+# `text tells` reports two kinds of habit a language model leaves in prose
+# it drafted. One is the contrast move, which says what a thing is by
+# saying what it is not; its detectors are built in. The other is the
+# phrases listed below. Both only warn: a phrase your subject needs is not
+# a habit, and the author rules on every hit.
+#
+# The phrases are a dated seed, not a standard. They come from Graphite,
+# "AI Tells" (2026), https://graphite.io/five-percent/research/ai-tells,
+# which compared 10,000 human articles with articles on the same topics
+# from nine models: GPT-4.1, GPT-5, GPT-5.6 Sol, GPT-6 Astra, Claude
+# Opus 4, 4.6 and 5, and Gemini 2.5 Pro and 3.1 Pro. Its measurements are
+# CC BY 4.0, so keep this attribution with any list derived from them.
+# Tells shift between model versions (only 45% carried over between two
+# successive GPT releases), so this list ages with the models that draft
+# your prose, and an empty warning from a stale list proves nothing.
+#
+# To refresh it, for the models that draft your prose:
+#   1. Take a measurement of each phrase's rate in model and in human
+#      writing on the same topics. The study publishes one; a newer study
+#      or a paired sample of your own will do.
+#   2. Keep a phrase when a drafting model uses it at least ten times as
+#      often as human writers, across at least a hundred of that model's
+#      documents, so that a rare phrase cannot qualify by chance.
+#   3. Count it in your own prose, and keep it only where it occurs more
+#      than once, in more than one unit.
+#   4. Read every hit in context before keeping the rule.
+#   5. Record the date and the models here.
+# Phrases readers already associate with machines, such as "delve" or
+# "tapestry", have faded from newer models' output and no longer pass
+# step 2. A project may list them anyway, on the grounds of what its
+# readers believe; say so in the reason.
+
+# Pairs of project-relative directory and filename glob to inspect.
+scope_glob = [["manuscript", "*.qmd"]]
+# Basenames in a different register can be excluded deliberately.
+exclude_names = ["sources.qmd"]
+# The contrast detectors are English. Set false for prose in another
+# language, and keep only the phrases.
+contrast = true
+
+# Each case-insensitive regular expression, matched one sentence at a time,
+# maps to why it reads as machine-made. `^` anchors at the sentence start.
+# Write a phrase uncontracted, as a model writes it: it also matches the
+# sentence with its contractions spelled out, so "is the whole" finds
+# "that's the whole".
+# Seeded 2026 from the study above; the multiples are against human writing.
+[phrases]
+"\\brather than\\b" = "the connective GPT-6 Astra and Claude Opus 5 overuse most, about 20 times the human rate"
+"\\bnot (?:simply|merely|just) (?:a|an|the|about|that)\\b" = "GPT's corrective intensifier, up to 150 times the human rate; say what the thing is"
+"\\bsingle most\\b" = "a Claude and Gemini superlative; rank only what the argument ranks"
+"\\bless (?:like|as) (?:an? |the )?\\w+(?: \\w+)? (?:and more|than)\\b" = "Claude Opus 5's 'less like X and more like Y' frame"
+"\\bgenuine(?:ly)?\\b" = "Claude's intensifier; it asserts what the sentence should show"
+"\\bthe honest\\b" = "Claude Opus 5 claims candor instead of showing it"
+"\\bquietly\\b" = "Claude Opus 5's adverb for undramatic change; name the change"
+"\\bneed not\\b" = "GPT-6 Astra's corrective hedge; say what does happen"
+"\\bfurthermore\\b" = "Gemini's formal transition"
+"\\btaken together\\b" = "a summarizing turn from Claude Opus 5 and GPT-6 Astra"
+"\\brather than treating\\b|\\bthan treating\\b" = "GPT's corrective setup, almost absent from human writing"
+"\\bit(?: is|'s) worth \\w+ing\\b" = "announces that something deserves attention instead of giving it"
+"^none of (?:this|that)\\b" = "a summarizing pivot at the turn of a paragraph"
+"\\b(?:matters|mattered) (?:enormously|because)\\b|\\bdistinction matters\\b" = "justifies a point by announcing that it matters; show why"
+"\\bearns? its (?:place|keep)\\b|\\bexactly the kind\\b|\\bthe practical takeaway\\b" = "Claude Opus 5 phrasings almost absent from human writing"

quirework/templates/terminology.toml

@@ -0,0 +1,20 @@
+# Example advisory terminology policy. Point text.terminology at this file.
+
+# Pairs of project-relative directory and filename glob to inspect.
+scope_glob = [["manuscript", "*.qmd"]]
+# Explicit exceptions are path suffix, nearby text, and rationale triples.
+allow = []
+# Basenames in a different register can be excluded deliberately.
+exclude_names = ["sources.qmd"]
+
+# Each regular expression maps to a plain alternative. These findings
+# invite judgment; the tool never replaces a word automatically.
+[terms]
+"utili[sz]e" = "use"
+
+# Phrases the project has retired, each mapped to what replaced it. Unlike
+# terms these gate: `text check` fails while one is in reader-facing prose,
+# headings and tables included, and only an `allow` keep excuses a use.
+# Each is matched as written, in any case and across a line break.
+[retired]
+# "old coinage" = "the plain phrase that replaced it"

quirework/templates/tmpfiles.conf

@@ -0,0 +1,42 @@
+# Quirework cache cleanup, for systemd-tmpfiles.
+#
+# Nothing empties the XDG cache directory on its own. The specification
+# permits deleting cached data at any time but obliges no one to do it, and a
+# stock Linux system ships no cleaner for it, which is why a working machine's
+# ~/.cache grows without bound. This rule is how a directory under it becomes
+# collectible: systemd-tmpfiles-clean.timer runs daily in the user session and
+# applies whatever it finds here.
+#
+# Install it, and optionally apply it at once rather than waiting for the
+# timer:
+#
+#   quirework config template tmpfiles \
+#     --out ~/.config/user-tmpfiles.d/quirework.conf
+#   systemd-tmpfiles --user --clean
+#
+# A distribution package puts the same file in
+# /usr/share/user-tmpfiles.d/quirework.conf instead, where a user's own copy
+# in ~/.config still overrides it.
+#
+# Everything Quirework keeps in the cache is derived: downloaded tools such as
+# an EPUB validator, redacted renderings, staging for an analysis. Losing any
+# of it costs a rebuild, never a result. Run records are deliberately NOT here
+# -- they are evidence, they live under the XDG state directory, and no rule
+# in this file should ever reach them.
+#
+# The private runner homes of confined seats live here too, under homes/, so
+# a finished run's home goes with the rest. A run left untouched for the whole
+# age loses its homes the same way; it then refuses to resume a session and
+# says the cache was cleared, and its records are untouched. The `x` line
+# keeps the tag that tells backup tools to skip the homes, which nothing
+# rewrites until the next seat launches.
+#
+# `e` cleans the contents of a directory that already exists and never creates
+# one, so this stays inert until Quirework has cached something. An entry is
+# removed only when its access, modification and status times are all older
+# than the age, so a project you are still working in keeps its cache and an
+# abandoned one does not.
+#
+# Type Path                             Mode User Group Age
+e      %C/quirework                     -    -    -     30d
+x      %C/quirework/homes/CACHEDIR.TAG