proofpress 0.0.1 → 0.1.0-alpha.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,8 +1,225 @@
+[//]: # (ob:6ec771b4)
+<p align="center">
+  <img src="assets/logo.svg" alt="Proofpress logo" width="88" height="88">
+</p>
+
+[//]: # (ob:de7999eb)
 # Proofpress
 
-The version ledger for agent-produced knowledge work.
+[//]: # (ob:e667d986)
+Proofpress is a verifiable `log.md` for knowledge work: a shared history of who
+changed what, when, and why, checked against the artifact itself.
+
+[//]: # (ob:0e0e9d9a)
+Agents can produce a document quickly, but the reasoning that shaped its final
+form is usually scattered across chat sessions, Slack, meetings, and somebody's
+memory. Git is excellent when the work already lives in Git; most knowledge
+artifacts do not. Proofpress keeps the accepted version history and consequential
+decisions attached to a Markdown or static HTML artifact so that history can
+travel with it.
+
+[//]: # (ob:169d8523)
+## Status
+
+[//]: # (ob:d6f9f208)
+Proofpress is a V0 reference implementation. The CLI is usable and its portable
+artifact behaviors are covered by black-box tests, but the embedded carrier and
+command interfaces may still change before a stable release. The npm package is
+published under the `next` tag while these interfaces settle.
+
+[//]: # (ob:19210f53)
+## Install the alpha
+
+[//]: # (ob:989f25ec)
+Proofpress keeps its zero-dependency Python engine and adds a thin npm launcher
+plus repository setup command. Python 3 and Git are required:
+
+[//]: # (ob:7b197ac1)
+```sh
+npm install --save-dev proofpress@next
+npx --no-install proofpress --version
+npx --no-install proofpress setup --agent codex
+```
+
+[//]: # (ob:5ae48e1b)
+`setup` installs a package-aware adapter and writes
+`.proofpress/manifest.json`. It is idempotent and supports `codex`, `claude`,
+`cursor`, or `all`. Portable history remains opt-in per artifact.
+
+[//]: # (ob:2b655d31)
+To add a visible, transparent distribution mark to a repository README:
+
+[//]: # (ob:d4916c37)
+```sh
+npx --no-install proofpress setup --agent codex --badge README.md
+```
+
+[//]: # (ob:5796ae98)
+The badge says that revision provenance uses Proofpress; it is not an
+instruction for agents to download or execute software. Installed adapters use
+`npx --no-install`, so an agent can use an existing local installation but
+cannot silently fetch the package.
+
+[//]: # (ob:e7b4f799)
+## Single-file install
+
+[//]: # (ob:d8cafbd3)
+Proofpress is a single Python file with no third-party runtime dependencies:
+
+[//]: # (ob:0b5b4916)
+```sh
+git clone https://github.com/chenmingtang830/proofpress.git
+cd proofpress
+python3 proofpress.py --help
+```
+
+[//]: # (ob:166fd594)
+To use it in another repository, vendor `proofpress.py` at that repository's
+root and install the matching adapter from [`skills/`](skills/).
+
+[//]: # (ob:949eb6a5)
+## What “portable” means
+
+[//]: # (ob:2173502c)
+Turn portability on once:
+
+[//]: # (ob:c44f6768)
+```sh
+python3 proofpress.py policy proposal.md portable
+```
+
+[//]: # (ob:79416c44)
+The setting is sticky. Later accepted revisions refresh a compact, hidden
+capsule inside the carrier file. Send the original file to a collaborator and
+their agent can inspect and import its history without access to your Git repo,
+chat session, or Proofpress ledger ref.
+
+[//]: # (ob:af7113fa)
+```sh
+python3 proofpress.py inspect proposal.md
+python3 proofpress.py import proposal.md
+python3 proofpress.py log proposal.md
+```
+
+[//]: # (ob:bfc931ca)
+The capsule is declarative data, not agent instructions. It is tamper-evident
+for accidental drift and inconsistent rewrites, but V0 does not claim signed
+authorship or protection from wholesale malicious replacement.
+
+[//]: # (ob:839fc8a1)
+Portable carriers include a non-rendering discovery marker with
+`Verifiable revision history by Proofpress` and the project URL. The capsule's
+canonical discovery object also names `proofpress@next`. An agent may explain
+this provenance and offer installation, but must obtain user consent before
+downloading or executing anything.
+
+[//]: # (ob:cc095bd4)
+## Static HTML carrier
+
+[//]: # (ob:e6463f5e)
+Proofpress also supports static `.html` and `.htm` artifacts. `anchor` writes a
+stable `data-proofpress-id` onto supported visible blocks (headings, paragraphs,
+list items, block quotes, preformatted blocks, table cells, and figure captions).
+The metadata marker lives in `<head>`; a portable capsule is a non-executing
+`application/vnd.proofpress+json` data block before `</body>`.
+
+[//]: # (ob:b8abc9df)
+```sh
+python3 proofpress.py policy launch-plan.html portable
+python3 proofpress.py anchor launch-plan.html
+python3 proofpress.py snapshot launch-plan.html --kind agent --author codex \
+  --why "made the accepted review scope explicit"
+python3 proofpress.py verify launch-plan.html
+```
+
+[//]: # (ob:00768820)
+This is a static-HTML carrier MVP, not a framework or CMS integration. Proofpress
+does not yet promise round-trip preservation through React/Vue builds, HTML
+sanitizers, editors, or CMS pipelines; if they strip transport data, the file
+degrades to an ordinary HTML artifact.
+
+[//]: # (ob:226a29fd)
+## What gets recorded
+
+[//]: # (ob:cfc1c3aa)
+Proofpress records accepted artifact versions, their computed block changes,
+explicit actor roles, the reason for the change, and consequential rejected
+directions when the authoring agent supplies them. The account is checked
+against the actual artifact diff.
+
+[//]: # (ob:5e0b34ed)
+It does not automatically store raw prompts, transcripts, tool traces, casual
+brainstorming, or every save. A fallback hook can preserve an otherwise missed
+version, but identifies itself only as `recorded_by`; it does not guess who
+wrote the content or why.
+
+[//]: # (ob:d8387b0b)
+## Privacy modes
+
+[//]: # (ob:5df13acf)
+Each artifact has one policy:
+
+[//]: # (ob:3b52e3b3)
+- `portable`: future accepted versions refresh the embedded capsule.
+- `local`: versions stay in the local/Git ledger; the current capsule is
+
+[//]: # (ob:126978a2)
+  removed.
+
+[//]: # (ob:0890e114)
+- `ignored`: future capture is skipped.
+
+[//]: # (ob:c6642117)
+Switching from portable to local cannot recall copies already sent. Re-enabling
+portable starts a clean lineage at the current body, so private-interval actors,
+reasons, rejected paths, event IDs, and omitted-event counts do not leak.
+
+[//]: # (ob:18995a53)
+For a one-off history-free copy, use:
+
+[//]: # (ob:f28051ef)
+```sh
+python3 proofpress.py clean proposal.md --output proposal-clean.md
+```
+
+[//]: # (ob:bfac82a8)
+## Core workflow
+
+[//]: # (ob:706dcea3)
+```sh
+python3 proofpress.py anchor proposal.md
+python3 proofpress.py snapshot proposal.md --kind agent --author codex \
+  --produced-by codex --recorded-by codex \
+  --attribution-basis harness_attested \
+  --note "incorporated review" --claims /tmp/claims.json \
+  --why "the team chose the smaller launch scope"
+python3 proofpress.py verify proposal.md
+```
+
+[//]: # (ob:33e05aa8)
+Use `--rejected` only for consequential dead branches that future collaborators
+should not repeat. Source code stays in Git; Proofpress is for Markdown and
+static HTML knowledge artifacts.
+
+[//]: # (ob:2a955c60)
+## Surfaces
+
+[//]: # (ob:8deed5b3)
+- `proofpress.py`: zero-dependency engine and CLI.
+- npm package: thin cross-platform launcher and idempotent repository setup.
+- `refs/proofpress/ledger`: local/Git-backed ledger, separate from branches.
+- `skills/`: Claude Code, Codex, Cursor, and Pi authoring contracts plus
+
+[//]: # (ob:1f7d312f)
+  best-effort fallback hooks.
+
+[//]: # (ob:605a678d)
+- Embedded portable capsule: path-independent handoff outside Git.
 
-Every draft your agent ships is a proof. You mark it up, sign off, and send it to press.
-**Draft → Review → Approve, for agents.**
+[//]: # (ob:820f39ab)
+Start with the [documentation index](docs/README.md). The executable behavior is
+defined by the [Portable Artifact V0 contract](docs/PORTABLE_ARTIFACT_SPEC.md),
+with its disclosure limits in
+[Privacy Boundaries for Portable Artifacts](docs/PRIVACY_AND_DISCLOSURE.md).
 
-This is a name-reservation placeholder — the real release is in the works.
+[//]: # (proofpress:meta:eyJhcnRpZmFjdF9pZCI6InBwXzU1NmIxMTVkZTcxMWIwY2QzM2VlZDI2MCIsInBvbGljeSI6ImxvY2FsIiwicHJvb2ZwcmVzcyI6MX0)

package/assets/logo.svg

@@ -0,0 +1,6 @@
+<svg width="48" height="48" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg">
+  <title>Proofpress</title>
+  <desc>A page with a teal seal stamped on its bottom-right corner: the proof, signed off.</desc>
+  <rect x="7" y="4" width="28" height="36" stroke="currentColor" stroke-width="3"/>
+  <circle cx="35" cy="36" r="9" fill="#2E8FA3"/>
+</svg>

package/bin/proofpress.js

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+"use strict";
+
+const path = require("node:path");
+const { runPython } = require("../lib/python");
+const { runSetup } = require("../lib/setup");
+
+const packageRoot = path.resolve(__dirname, "..");
+const args = process.argv.slice(2);
+
+if (args[0] === "setup") {
+  try {
+    const result = runSetup(args.slice(1), { packageRoot, cwd: process.cwd() });
+    if (!result.skipGitConfig) {
+      const status = runPython(["init"], { packageRoot, cwd: process.cwd() });
+      if (status !== 0) process.exit(status);
+    }
+  } catch (error) {
+    console.error(`proofpress setup: ${error.message}`);
+    process.exit(1);
+  }
+} else {
+  process.exit(runPython(args, { packageRoot, cwd: process.cwd() }));
+}

package/lib/python.js

@@ -0,0 +1,44 @@
+"use strict";
+
+const fs = require("node:fs");
+const path = require("node:path");
+const { spawnSync } = require("node:child_process");
+
+function pythonCandidates() {
+  if (process.env.PROOFPRESS_PYTHON) {
+    return [[process.env.PROOFPRESS_PYTHON, []]];
+  }
+  if (process.platform === "win32") {
+    return [["py", ["-3"]], ["python", []]];
+  }
+  return [["python3", []], ["python", []]];
+}
+
+function runPython(args, options) {
+  const cli = path.join(options.packageRoot, "proofpress.py");
+  if (!fs.existsSync(cli)) {
+    console.error(`proofpress: bundled CLI not found: ${cli}`);
+    return 1;
+  }
+
+  for (const [command, prefix] of pythonCandidates()) {
+    const result = spawnSync(command, [...prefix, cli, ...args], {
+      cwd: options.cwd,
+      stdio: "inherit",
+      env: process.env
+    });
+    if (!result.error) return result.status === null ? 1 : result.status;
+    if (result.error.code !== "ENOENT") {
+      console.error(`proofpress: could not start ${command}: ${result.error.message}`);
+      return 1;
+    }
+  }
+
+  console.error(
+    "proofpress requires Python 3. Install Python 3 or set PROOFPRESS_PYTHON " +
+    "to the Python 3 executable."
+  );
+  return 1;
+}
+
+module.exports = { runPython };