runprint 0.1.0__tar.gz

runprint-0.1.0/LICENSE

@@ -0,0 +1,176 @@
+                                 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 exemplary 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

runprint-0.1.0/PKG-INFO

@@ -0,0 +1,278 @@
+Metadata-Version: 2.4
+Name: runprint
+Version: 0.1.0
+Summary: Run anything. Capture everything needed to reproduce it.
+Author: Runprint Contributors
+License-Expression: Apache-2.0
+Keywords: reproducibility,research,ml,experiment-tracking,provenance
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0.0
+Requires-Dist: rich>=12.0.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Dynamic: license-file
+
+# Runprint (QR)
+
+**Reproducible Research Execution Wrapper**
+
+> *“Run anything. Capture everything needed to reproduce it.”*
+
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+
+Runprint (`qr`) is a lightweight, framework-agnostic, local-first execution wrapper for AI and scientific research experiments. It sits outside your experiment code, runs any command, and automatically captures code state (including uncommitted Git diffs), runtime environment, hardware configuration, execution logs, and structured metrics into an auditable, reproducible run record.
+
+---
+
+## Key Features
+
+- **Framework-Agnostic**: Wrap any arbitrary process (Python, Bash, C++, simulation binaries) without modifying your training loops.
+- **Local-First**: All manifests, metadata, and logs are stored in `.qr/`. Zero accounts, zero cloud dependencies, zero external servers.
+- **Dirty Git Snapshotting**: Never lose an experiment to uncommitted changes. `qr` captures `git.diff` alongside the commit hash.
+- **Reproducibility Contract**: Transparent categorization of run reproducibility (`TRACEABLE`, `RESTORABLE`, `REPRODUCIBLE`).
+- **Live Tee Logging**: Streams `stdout` and `stderr` directly to your terminal while persisting clean log files to disk.
+- **Atomic & Crash-Safe**: Runs are protected against `Ctrl+C` and crashes with pre-run manifests and atomic writes.
+- **Isolated Worktree Rerun**: Rerun past experiments in clean, dedicated Git worktrees without disturbing your active workspace.
+- **Integrity Doctor & Run Diff**: Built-in health diagnostics (`qr doctor`) and side-by-side run comparisons (`qr diff`).
+- **Tiny Python SDK**: Optional semantic logging (`qr.log`), artifact registration (`qr.artifact`), dataset tracking (`qr.input_dataset`), and notes (`qr.note`).
+
+---
+
+## Installation
+
+Clone the repository and install in editable mode:
+
+```bash
+git clone https://github.com/minhquang0407/Runprint.git
+cd Runprint
+pip install -e .
+```
+
+> **Tip**: If `qr` is installed in a user script directory not yet on your system `PATH`, you can execute commands via `python -m qr.cli <command>`.
+
+---
+
+## CLI Usage Guide
+
+### 1. Initialize a Project (`qr init`)
+Initialize a repository for experiment tracking:
+```bash
+qr init
+```
+This creates the `.qr/` directory, project configuration (`project.json`), and the local runs store.
+
+---
+
+### 2. Execute an Experiment (`qr run`)
+Prefix any command with `qr run --`:
+
+```bash
+# Basic run
+qr run -- python train.py --config configs/baseline.yaml
+
+# Run with tags
+qr run --tag baseline --tag vision -- python train.py --epochs 50
+
+# Run a Bash script or external binary
+qr run --tag simulation -- bash scripts/run_eval.sh
+```
+
+**Automatic Dirty Tree Detection:**
+If your repository has uncommitted changes, `qr` automatically captures the patch into `git.diff`:
+```text
+[!] Working tree contains uncommitted changes. Snapshotting diff:
+  - train.py
+  - model.py
+  - configs/baseline.yaml
+
+Run QR-20260914-A7F2 [baseline, vision] started (09:12:04)
+... training output ...
+Run completed: exit=0, duration=14.2s (QR-20260914-A7F2)
+```
+
+---
+
+### 3. List Recorded Experiments (`qr list`)
+View your experiment history:
+
+```bash
+# List recent runs
+qr list
+
+# Limit results
+qr list --limit 10
+
+# Filter by tag
+qr list --tag baseline
+```
+
+**Example Output:**
+```text
+                              QR Experiment Runs                               
+┌──────────────────┬───────────┬──────────────────┬───────────┬──────────┬─────────┬───────┬─────────────────────┐
+│ Run ID           │ Status    │ Tags             │ Command   │ Duration │ Commit  │ Dirty │ Started             │
+├──────────────────┼───────────┼──────────────────┼───────────┼──────────┼─────────┼───────┼─────────────────────┤
+│ QR-20260914-A7F2 │ completed │ baseline, vision │ python... │    14.2s │ 7cc8be0 │  yes  │ 2026-09-14 09:12:04 │
+└──────────────────┴───────────┴──────────────────┴───────────┴──────────┴─────────┴───────┴─────────────────────┘
+```
+
+---
+
+### 4. Inspect Run Provenance (`qr show`)
+Inspect full source code state, hardware, runtime, registered artifacts, and metrics:
+
+```bash
+qr show QR-20260914-A7F2
+```
+
+**Detailed Report:**
+- **Status & Exit Code**: Outcome and total runtime duration.
+- **Tags**: Assigned experiment tags.
+- **Source**: Commit hash, branch, and uncommitted diff indicator.
+- **Runtime**: OS platform, Python version, package lock (`environment/pip-freeze.txt`).
+- **Hardware**: CPU cores, total RAM, NVIDIA GPU model and driver version.
+- **Inputs**: Declared dataset URIs and cryptographic SHA256 fingerprints.
+- **Metrics**: Summary of metrics logged via the SDK.
+- **Artifacts**: Model checkpoints and output files registered with sizes and checksums.
+- **Reproducibility Contract**: Traceability, restorability score, and parent run lineage.
+
+---
+
+### 5. Re-execute an Experiment (`qr rerun`)
+Rerun a previous experiment with automated preflight reproducibility validation:
+
+```bash
+# Basic rerun (in current working directory)
+qr rerun QR-20260914-A7F2
+
+# Isolated rerun in a dedicated temporary Git worktree (Recommended)
+qr rerun QR-20260914-A7F2 --isolated
+
+# Bypass dataset fingerprint mismatch if dataset was updated intentionally
+qr rerun QR-20260914-A7F2 --allow-dataset-mismatch
+```
+
+**Preflight Checks Performed:**
+- `[OK] Git Commit`: Verifies commit exists in local git history.
+- `[OK] Dirty Patch`: Verifies `git.diff` applies cleanly.
+- `[OK] Environment Lock`: Verifies package lock exists.
+- `[OK] Dataset Fingerprint`: Re-hashes input datasets and verifies integrity.
+- `[!] Hardware/OS Difference`: Warns if rerun is performed on different GPUs or platforms.
+
+The rerun creates a **new run** linked to the parent (`Lineage: Parent=QR-20260914-A7F2`), preserving full historical lineage.
+
+---
+
+### 6. Compare Two Experiments (`qr diff`)
+Compare configuration, source code, duration, and metrics between two runs:
+
+```bash
+qr diff QR-20260914-A7F2 QR-20260914-B8C1
+```
+
+**Comparison Matrix:**
+- Compares executed command and argument changes.
+- Compares Git commits and dirty patches.
+- Compares execution duration and status.
+- Computes numerical metric deltas (e.g. `accuracy: 0.7550` vs `0.8800 (+0.1250)`).
+
+---
+
+### 7. Diagnose & Auto-Repair (`qr doctor`)
+Check repository health, detect runs interrupted by power loss or crashes, and sync caches:
+
+```bash
+# Run integrity diagnostics
+qr doctor
+
+# Auto-repair orphaned runs and rebuild SQLite index
+qr doctor --fix
+```
+
+---
+
+## Tiny Python SDK
+
+The Python SDK is optional and framework-agnostic. If a script is executed outside of `qr run`, all SDK calls gracefully degrade to safe no-ops.
+
+```python
+import qr
+
+# 1. Declare input dataset (auto-calculates SHA256 fingerprint if omitted)
+qr.input_dataset(
+    name="medvqa",
+    uri="data/medvqa_v1.csv",
+    version="v1.0"
+)
+
+# 2. Log structured metrics per step/epoch (saved to metrics.jsonl)
+for epoch in range(epochs):
+    loss, acc = train_step()
+    qr.log({
+        "epoch": epoch,
+        "loss": round(float(loss), 4),
+        "accuracy": round(float(acc), 4)
+    })
+
+# 3. Register output artifacts (checksum & size tracked, file not duplicated)
+qr.artifact("checkpoints/best_model.pt", kind="model", metadata={"accuracy": 0.88})
+
+# 4. Add human or script annotations
+qr.note("Completed warmup phase, learning rate decayed by factor of 0.1")
+```
+
+---
+
+## Local Storage Layout
+
+All data is self-contained inside your repository:
+
+```text
+my-project/
+├── train.py
+├── configs/
+├── .git/
+└── .qr/
+    ├── project.json            # Project identification and configuration
+    ├── index.sqlite            # Fast local cache for qr list (rebuildable)
+    ├── worktrees/              # Temporary checkouts for isolated reruns
+    └── runs/
+        └── QR-20260914-A7F2/
+            ├── manifest.json   # Machine-readable provenance manifest (Schema v0.1)
+            ├── git.diff        # Uncommitted diff patch (binary supported)
+            ├── stdout.log      # Complete stdout stream
+            ├── stderr.log      # Complete stderr stream
+            ├── metrics.jsonl   # Structured metrics stream
+            ├── artifacts.json  # Registered artifact references and checksums
+            └── environment/
+                └── pip-freeze.txt  # Snapshot of installed packages
+```
+
+---
+
+## Testing
+
+Run the automated test suite:
+
+```bash
+pytest tests/ -v
+```
+
+---
+
+## License
+
+Licensed under the [Apache License, Version 2.0](LICENSE).