Metadata-Version: 2.4
Name: shiftory
Version: 0.1.0
Summary: Local-first, source-cited explanations for Git changes
Author: Shiftory contributors
License:                                  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.
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: graphora-kg==0.2.1
Requires-Dist: jsonschema<5,>=4.23
Requires-Dist: platformdirs<5,>=4.3
Provides-Extra: dev
Requires-Dist: build<2,>=1.2; extra == 'dev'
Requires-Dist: mypy<2,>=1.15; extra == 'dev'
Requires-Dist: packaging<26,>=24; extra == 'dev'
Requires-Dist: pytest-cov<7,>=6; extra == 'dev'
Requires-Dist: pytest<9,>=8.3; extra == 'dev'
Requires-Dist: ruff<1,>=0.11; extra == 'dev'
Requires-Dist: tomli==2.2.1; (python_version < '3.11') and extra == 'dev'
Requires-Dist: twine<7,>=6; extra == 'dev'
Requires-Dist: types-jsonschema<5,>=4.23; extra == 'dev'
Description-Content-Type: text/markdown

# Shiftory

> **We do not read code changes anymore, and at agent speed we cannot track every
> small piece. Shiftory does it for you without the sweat.**

Shiftory turns a Git comparison into deterministic, source-cited evidence, then
verifies and renders an agent-authored explanation. It accounts for every parsed
added and deleted line, textual hunk, and non-text change unit without treating a
language model—or Graphora—as the source of truth.

<p align="center">
  <img src="https://raw.githubusercontent.com/Naseem77/Shiftory/main/docs/assets/shiftory-demo.gif" alt="Animated Shiftory demo showing a 12,000-line Git diff becoming a source-cited, fully accounted human change explanation." width="960">
</p>

> [!IMPORTANT]
> **Shiftory explains changes; it does not review them.** Its output does not make
> bug findings, assign severity, rank risk, or recommend fixes. Verification proves
> accounting, citation references, schema conformance, and this communication
> boundary. It does not prove that the explanation is semantically correct.

## Install

Shiftory requires Python 3.10+ and Git. Install from PyPI when a release is
available:

```bash
python -m pip install shiftory
shiftory --version
```

To work from a source checkout:

```bash
python -m pip install -e '.[dev]'
shiftory --version
```

Graphora is pinned by the package to `graphora-kg==0.2.1`. Its required
`tree-sitter!=0.26.0,>=0.23` dependency is release-pinned to `tree-sitter==0.25.2`.

## Quick start

From the repository whose changes you want explained:

```bash
shiftory explain
```

With no scope flag, Shiftory compares `HEAD` with the complete working tree:
staged, unstaged, and non-ignored untracked content. The command creates a private
run, writes deterministic evidence and an explanation template, and prints a JSON
descriptor, then stops. The thin agent skill reads that descriptor, fills the
template, and invokes the recorded resume command; resume verifies before it
renders and emits the report.

For a manual two-phase run:

```bash
# Save the printed descriptor; it contains the exact evidence and template paths.
shiftory explain --graphora auto > run-descriptor.json

# After an agent fills the descriptor's explanation template:
shiftory explain \
  --resume /path/to/run/run.json \
  --explanation /path/to/run/explanation.json \
  --output shiftory-report.md
```

The successful resume removes the private run directory by default. See
[Artifacts and retention](#artifacts-and-retention) before using sensitive
repositories.

## Install and invoke the agent skill

Install the bundled, thin skill into the current project:

```bash
shiftory install-skill --target copilot
```

This writes `.github/skills/shiftory/SKILL.md`. It refuses to overwrite different
content. Claude and generic layouts are also supported:

```bash
shiftory install-skill --target claude   # .claude/skills/shiftory/SKILL.md
shiftory install-skill --target generic  # skills/shiftory/SKILL.md
shiftory install-skill --target copilot --directory /custom/skill/directory
```

Then make one request to the agent:

> **Use Shiftory to explain my current Git changes.**

Add the desired scope to that request when needed, for example, “Use Shiftory to
explain commit `abc123`.” The skill delegates Git parsing, evidence generation,
verification, and rendering to the CLI; it does not reproduce those systems in
its prompt.

## Comparison scopes

Only one scope may be selected.

| Scope | Comparison |
|---|---|
| no flag | `HEAD` → staged + unstaged + non-ignored untracked working tree |
| `--staged` | `HEAD` → index |
| `--unstaged` | index → working tree |
| `--commit REV` | selected parent → commit; merge commits require `--parent N` |
| `--range BASE..HEAD` | the two resolved commits |
| `--range BASE...HEAD` | merge base of the endpoints → resolved right endpoint |
| `--branch NAME` | merge base of current `HEAD` and `NAME` → current `HEAD` |
| `--pr NUMBER` | merge base of immutable PR base/head SHAs → head SHA |

`--repo PATH` selects another checkout. `--pr` is the only analysis scope that
may contact a network: it uses an authenticated `gh` CLI and may fetch missing
objects from `--remote` (default `origin`). Other scopes use local Git objects,
the index, and the filesystem.

## Advanced CLI workflow

Collect canonical JSON evidence for staged changes:

```bash
shiftory analyze \
  --staged \
  --graphora auto \
  --context-lines 5 \
  --max-evidence-bytes 1000000 \
  --output evidence.json
```

Render the same evidence packet directly as Markdown:

```bash
shiftory analyze \
  --range 'main...feature' \
  --graphora off \
  --format markdown \
  --output evidence.md
```

After an agent writes `shiftory.explanation/v1`, validate it:

```bash
shiftory verify \
  --evidence evidence.json \
  --explanation explanation.json
```

Render only after verification succeeds:

```bash
shiftory render \
  --evidence evidence.json \
  --explanation explanation.json \
  --format markdown \
  --output report.md

shiftory render \
  --evidence evidence.json \
  --explanation explanation.json \
  --format json \
  --output report.json
```

Inspect the exact bundled contracts with `shiftory schema evidence`,
`shiftory schema explanation`, or `shiftory schema report`.

### Illustrative output

The following is an **illustrative, abbreviated sample**, not benchmark output.
Real IDs are deterministic hashes and the full appendix contains every owner.

```markdown
# Shiftory explanation

The value selection changes from the configured default to the explicit input.

## Behavioral before to after

### Select an explicit value

**Before:** The function returned the configured default.

**After:** The function returns the caller-provided value.

Evidence: `source_ab12`

Confidence: **extracted**

## Complete source-cited coverage appendix

- Changed lines: 4/4 (100%)
- Textual hunks: 1/1 (100%)
- Change units: 1/1 (100%)

> Shiftory verified accounting and citation references; it does not verify
> semantic correctness.
```

## What is accounted for

Shiftory models each file as:

```text
FileChange
└── ChangeUnit (text, binary, mode, rename, copy, submodule, unsupported)
    └── TextHunk
        └── ChangeSpan (contiguous changed lines on one side)
            └── ChangedLine
```

Each changed line, each span, and each non-text unit must have exactly one
explanation owner. Textual hunk and text-unit coverage is derived from complete
ownership of their descendant lines. Citations are independent references and
may be reused by multiple items without changing ownership counts.

Read [the evidence format](docs/evidence-format.md) for exact validation rules.

## Languages

Git accounting is language-independent. Every parseable patch receives the same
line/hunk/unit ledger even when structural enrichment is unavailable.

Graphora 0.2.1 recognizes Python, JavaScript/JSX, TypeScript/TSX, Go, Java, Rust,
C, C++, Ruby, and PHP files. It tries tree-sitter first and falls back to regular
expressions; fallback facts are downgraded where appropriate. Graphora facts are
optional enrichment, not coverage truth.

“Static tests” are source-level call relationships to files Graphora recognizes
as tests. They are not executed tests or runtime coverage. See
[Limitations](docs/limitations.md).

## Privacy and local state

Git analysis and Graphora enrichment are local by default; `--pr` alone uses
`gh` and may fetch missing objects. The CLI sends no telemetry, prompts, reports,
or product memory and does not itself send source to an LLM. The agent workflow
does intentionally give the invoked agent the bounded evidence file, so that
agent and its host's data-handling policy still apply.

Graphora needs source snapshots. Shiftory stores derived, repository-scoped
snapshots and graph data beneath the platform cache directory. Common credential
filenames and key suffixes are excluded, but source and changed text can still be
sensitive. Inspect and clear the current repository's cache with:

```bash
shiftory cache status
shiftory cache clear
```

Use `--cache-dir PATH` or `SHIFTORY_CACHE_DIR` to relocate it. `--no-cache`
disables cache-backed snapshots; combine it with `--graphora off` when no
structural enrichment is wanted.

### Artifacts and retention

`shiftory explain` stores runs under the platform state directory, or
`SHIFTORY_RUN_DIR` when set. Directories are owner-only and files are written
owner-readable/writable. An awaiting-explanation run remains available so the
agent can resume it. A successfully finalized run is deleted unless either:

```bash
shiftory explain \
  --resume /path/to/run/run.json \
  --explanation /path/to/run/explanation.json \
  --keep-artifacts

SHIFTORY_KEEP_ARTIFACTS=1 shiftory explain \
  --resume /path/to/run/run.json \
  --explanation /path/to/run/explanation.json
```

New failed runs retain `diagnostic.json` and report their artifact path. Shiftory
does not automatically expire retained runs or repository caches; clear them
deliberately according to your retention policy.

## Public benchmarks

All three Graphora 0.2.1 scenarios passed the complete cold and warm product path.
They were published together from one clean committed Shiftory tree; each metrics
artifact records that exact source commit, tree, manifest, and executed-code identity.

| Scenario | Base → head | Files | Hunks | Changed lines (+/−) | Spans |
|---|---|---:|---:|---:|---:|
| Click optional flag value | `7f7bbe4569ea68e8dabee232eade069ef3310aea` → `91de59c6c8abc8251e7af551cd4546cc964288af` | 3 | 5 | 52 (49/3) | 8 |
| Axios spec FormData/Blob | `65e8d1e28ce829f47a837e45129730e541950d3c` → `6ac574e00a06731288347acea1e8246091196953` | 9 | 22 | 359 (304/55) | 48 |
| ripgrep repeated flags | `c8e755f11f31b6da04329cdc7433747bba70150f` → `d83bab4d3f29a0176a20ea004c2cba44058d4210` | 2 | 14 | 2,026 (1,470/556) | 38 |

| Scenario | Complete path cold / warm (s) | Evidence JSON / Markdown (bytes) | Report Markdown (bytes) | Report reduction vs evidence Markdown | Line / span / hunk / unit coverage | Assertions (pass/fail/skip) | Deterministic | Artifacts |
|---|---:|---:|---:|---:|---:|---:|:---:|---|
| Click optional flag value | 3.124221 / 1.115434 | 67,082 / 33,774 | 5,320 | 28,454 bytes (84.25%) | 52/52 · 8/8 · 5/5 · 3/3 (100% each) | 31/0/0 | yes | [metrics](docs/benchmarks/click-optional-flag-value/metrics-v1.json) · [report](docs/benchmarks/click-optional-flag-value/report.md) |
| Axios spec FormData/Blob | 3.569890 / 1.290953 | 230,567 / 119,540 | 25,775 | 93,765 bytes (78.44%) | 359/359 · 48/48 · 22/22 · 11/11 (100% each) | 71/0/0 | yes | [metrics](docs/benchmarks/axios-spec-formdata-blob/metrics-v1.json) · [report](docs/benchmarks/axios-spec-formdata-blob/report.md) |
| ripgrep repeated flags | 4.564976 / 2.717400 | 1,243,642 / 673,829 | 135,985 | 537,844 bytes (79.82%) | 2,026/2,026 · 38/38 · 14/14 · 2/2 (100% each) | 40/0/0 | yes | [metrics](docs/benchmarks/ripgrep-repeated-flags/metrics-v1.json) · [report](docs/benchmarks/ripgrep-repeated-flags/report.md) |

Across the three scenarios, all 142 machine assertions passed with no failures or
skips, every accounting dimension reached 100%, and every cold/warm canonical
semantic bundle matched.

These are per-run values recorded on macOS 15.6.1 arm64 with 8 logical CPUs,
25,769,803,776 bytes of memory, Python 3.11.6, Git 2.53.0,
`graphora-kg==0.2.1`, and `tree-sitter==0.25.2`; wall times qualify only that
machine and environment. Cold and warm canonical semantic bundles matched after
excluding environment, acquisition and run timing, and local and installation
paths.

The generated metrics contain the complete private-safe `repository:src`
implementation manifest, executed package-code digest, runner digest, and
golden-input digest.

Coverage is measurable **accounting**, not a semantic-correctness or prose-quality
score. Machine assertions check the listed selected observable facts, evidence,
and report wiring; they do not prove complete behavior. The published prose comes
from version-controlled golden templates and is not a measured model-quality
result. The separate [manual quality rubric](benchmarks/quality-rubric.schema.json)
is optional. See the exact
[benchmark methodology](docs/benchmark-methodology.md).

## Documentation

- [Architecture and data flow](docs/architecture.md)
- [Evidence and explanation formats](docs/evidence-format.md)
- [Limitations and confidence boundaries](docs/limitations.md)
- [Benchmark methodology](docs/benchmark-methodology.md)
- [Published benchmark metrics and reports](#public-benchmarks)
- [Contributing](CONTRIBUTING.md)

## Development

```bash
python -m pip install -e '.[dev]'
ruff format --check .
ruff check .
mypy src/shiftory
pytest
python -m build
python -m twine check dist/*
```

CI is expected to enforce formatting, linting, strict typing, tests, schema and
package-data checks, clean-wheel installation, documentation links, license
inventory, and the repository's offline benchmark smoke checks. See
[CONTRIBUTING.md](CONTRIBUTING.md) for compatibility and generated-artifact
rules.

## License

Shiftory is licensed under Apache-2.0. See [LICENSE](LICENSE) and the repository's
third-party notices.
