codestrand 0.1.0__py3-none-macosx_11_0_arm64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,4 @@
1
+ [diffend] Oversized file quarantined before diffing.
2
+ name: codestrand-0.1.0.data/scripts/codestrand
3
+ size: 109962480 bytes
4
+ sha256: 3be99ff44a2c0d43a7956a009182313e39e40195da92dfd80f9a2201ae168664
@@ -0,0 +1,191 @@
1
+ Metadata-Version: 2.4
2
+ Name: codestrand
3
+ Version: 0.1.0
4
+ Classifier: Development Status :: 2 - Pre-Alpha
5
+ Classifier: Environment :: Console
6
+ Classifier: Intended Audience :: Developers
7
+ Classifier: Operating System :: MacOS :: MacOS X
8
+ Classifier: Operating System :: Microsoft :: Windows
9
+ Classifier: Operating System :: POSIX :: Linux
10
+ Classifier: Programming Language :: Rust
11
+ Classifier: Topic :: Multimedia :: Graphics
12
+ Classifier: Topic :: Software Development :: Version Control :: Git
13
+ License-File: LICENSE
14
+ License-File: LICENSE-APACHE
15
+ License-File: assets/material/LICENSE.txt
16
+ Summary: A Git history visualiser with restrained 3D depth and animated diffs
17
+ Keywords: git,visualization,history,animation
18
+ License-Expression: MIT OR Apache-2.0
19
+ Requires-Python: >=3.11
20
+ Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
21
+ Project-URL: Homepage, https://github.com/owenlamont/codestrand
22
+ Project-URL: Issues, https://github.com/owenlamont/codestrand/issues
23
+ Project-URL: Repository, https://github.com/owenlamont/codestrand
24
+
25
+ # Codestrand
26
+
27
+ ![Codestrand logo](assets/codestrand.svg)
28
+
29
+ A Git history visualiser exploring how software takes shape over time.
30
+
31
+ Codestrand aims to retain Gource's moving developers and growing directory graph,
32
+ adding restrained 3D depth and animated diff fragments. A repository is a strand
33
+ of changes, each commit woven into the structure the last ones left behind.
34
+
35
+ **Status: layout study.** Playback lays out a local repository or a built-in synthetic
36
+ history with persistent file positions, gliding contributors, coordinated commit
37
+ beams, labels and diff fragments. Preview and numbered PNG export share one
38
+ deterministic simulation. Built-in video encoding is not implemented. Licensed MIT OR
39
+ Apache-2.0.
40
+
41
+ ## Visual goal
42
+
43
+ - A mostly planar graph of repositories, directories and persistent file objects.
44
+ - Gentle layout relaxation as files appear, disappear or move, preserving spatial
45
+ continuity instead of rebuilding the layout for each commit.
46
+ - Developer avatars flying on a plane above the files, gliding toward the centroid
47
+ of each commit's affected files.
48
+ - One coordinated commit event: translucent connections from the avatar to every
49
+ touched file, coloured to match the developer.
50
+ - Diff fragments descending into files for additions and rising out for removals.
51
+ New files assemble; deleted files disappear after their connections are visible.
52
+ - File-type markers, readable labels and less detail at overview scale, with
53
+ aggregation for large commits and crowded directories.
54
+ - Multiple repositories with shared contributor identities as a longer-term goal.
55
+
56
+ Explore a Tron-like neon style: steady glow, luminous connections and smooth motion.
57
+ Aim for a flashy presentation with no strobing and no loss of readability. Preserve
58
+ crisp file shapes and labels, and restrain brightness where activity overlaps.
59
+ The probe currently selects the neon theme; additional visual styles remain future work.
60
+
61
+ ## Prototype direction
62
+
63
+ The probe uses Bevy 0.20.1. A short, scripted visual study should guide the final
64
+ playback architecture; local Git inspection runs independently of the renderer.
65
+
66
+ Compare avatar motion, beam shapes, diff direction and layout continuity using a
67
+ small synthetic history, including a deliberately crowded commit. The first study
68
+ should reveal whether the visual language remains readable in motion.
69
+
70
+ PNG export uses explicit frame indices, with one outstanding capture at a time and
71
+ confirmed writes before completion. The probe records logical state in `frames.csv`.
72
+ Encode the PNGs with external FFmpeg; streaming raw frames remains future work.
73
+
74
+ ## Inspect local history
75
+
76
+ ```sh
77
+ cargo run --locked -- inspect /path/to/repository --revision HEAD
78
+ ```
79
+
80
+ Inspection reads complete local working or bare repositories without modifying them.
81
+ The experimental JSON contains parent-before-child commits, raw identities and paths,
82
+ and first-parent file changes.
83
+ See [the Git import issue](https://github.com/owenlamont/codestrand/issues/5)
84
+ for implementation decisions and validation results.
85
+
86
+ Create a deterministic 100-commit test repository with
87
+ `uv run --script scripts/import_fixture.py NEW_REPOSITORY_DIRECTORY`.
88
+
89
+ ## Play history
90
+
91
+ ```sh
92
+ cargo run --locked -- preview
93
+ cargo run --locked --release -- preview --repository /path/to/repository
94
+ cargo run --locked --release -- export frames --repository /path/to/repository \
95
+ --start 1000 --commits 200 --commit-seconds 0.1
96
+ ```
97
+
98
+ Without `--repository`, the synthetic history plays, including a move between
99
+ directories, deletions and a 65-file commit. `--start` lays out and settles earlier
100
+ commits before playback; `--commits` limits what plays after it. Preview loops;
101
+ Escape closes the window. WASD pans in free-camera mode, right-drag orbits, and
102
+ the scroll wheel zooms. Tab follows/cycles currently visible contributors; WASD
103
+ returns to free mode. Follow also returns to free mode when the target fades out.
104
+ Space smoothly restores the fit-to-scene camera in half a second. The caption
105
+ shows the camera mode and follow target. Export always uses the default camera and
106
+ writes 1280×720 frames for the whole playback at 30 fps unless `--frames` or `--fps`
107
+ say otherwise. The output directory must not
108
+ already exist. Commits touching more than 24 files aim beams at directories instead.
109
+
110
+ Repository playback caches the latest first-parent timeline and diff counts as JSON
111
+ under the platform user cache directory (`codestrand/`), namespaced by a hash of the
112
+ canonical common Git directory, shared by linked worktrees. A resolved commit ID and
113
+ a format/import/timeline version
114
+ identify the snapshot; a different tip replaces the snapshot after a full import.
115
+ Playback range and speed reuse the complete timeline. Cache failures regenerate
116
+ without blocking playback; `--no-cache` skips cache reads and writes. Inspection
117
+ and repositories using Git replacement objects always import directly.
118
+ Messages, signatures, blob IDs and hunks are not cached. Bump `CACHE_VERSION` in
119
+ `src/timeline.rs` when cached semantics change.
120
+
121
+ Rendering changes also need the graphics export check and visual inspection:
122
+
123
+ ```sh
124
+ cargo test --locked --test render_export -- --ignored
125
+ ```
126
+
127
+ See [the video export issue](https://github.com/owenlamont/codestrand/issues/9)
128
+ for the verified 10-second MP4 proof and playback results.
129
+
130
+ To reproduce the proof, install uv and FFmpeg/ffprobe with the libx264 encoder:
131
+
132
+ ```sh
133
+ cargo build --locked -j 2
134
+ uv run --script scripts/video_proof.py target/debug/codestrand video-proof
135
+ ```
136
+
137
+ On Windows, use `target/debug/codestrand.exe`. The output directory must be new.
138
+ Run the script with `--help` for output retention and cleanup instructions.
139
+
140
+ ## Contributor aliases
141
+
142
+ Preview and export read `contributors.toml` from the user configuration directory:
143
+
144
+ - Linux: `~/.config/codestrand/` (or `$XDG_CONFIG_HOME/codestrand/` when set).
145
+ - macOS: `~/Library/Application Support/codestrand/`.
146
+ - Windows: `%APPDATA%\codestrand\`.
147
+
148
+ Override the file with `--contributors /path/to/contributors.toml`:
149
+
150
+ ```toml
151
+ [[contributor]]
152
+ name = "Owen Lamont" # display name
153
+ emails = ["owen@personal.example", "owen@work.example"]
154
+ ```
155
+
156
+ Emails match case-insensitively; duplicate emails are errors. Matching names never merge
157
+ people with different nonempty emails. Unlisted emails keep separate identities,
158
+ displayed with the name from the last commit in playback order. Commits without an email
159
+ are grouped by author name. A missing default file is fine; an explicit missing file,
160
+ unknown key or malformed TOML is an error. Edits take effect on cache hits; original
161
+ authors and repository history remain unchanged.
162
+
163
+ ## Development
164
+
165
+ Rust 1.99.1, rustfmt and Clippy are pinned in `rust-toolchain.toml`.
166
+ Install [prek](https://prek.j178.dev/) to run the checks shared with CI.
167
+
168
+ ```sh
169
+ prek install --install-hooks --overwrite
170
+ cargo run --locked -- --help
171
+ prek run --all-files
172
+ cargo test --locked --all-targets
173
+ ```
174
+
175
+ CPU tests cover timing, lifecycle ordering and CLI behaviour without creating a
176
+ renderer. CI runs the checks on Linux, macOS and Windows. Rendering changes also need
177
+ a local GPU or software-renderer export and visual inspection.
178
+
179
+ The lint setup follows [ryl](https://github.com/owenlamont/ryl): rustfmt, strict
180
+ Clippy, Markdown and YAML checks, spelling, workflow linting and file hygiene.
181
+ Changes go through feature branches and pull requests.
182
+
183
+ ## Acknowledgements
184
+
185
+ - [Material Icon Theme](https://github.com/material-extensions/vscode-material-icon-theme)
186
+ (MIT) — file icons.
187
+ - [Bevy](https://bevy.org/) — rendering and application framework.
188
+ - [resvg](https://github.com/linebender/resvg) — startup SVG rasterisation.
189
+ - [gix](https://github.com/GitoxideLabs/gitoxide) — Git history access.
190
+ - [Gource](https://gource.io/) — inspiration for animated Git history.
191
+
@@ -0,0 +1,8 @@
1
+ codestrand-0.1.0.data/scripts/codestrand,sha256=O-mf9EosDUOnlWoAkYIxPjnkAZXakt_YD5oiAa4WhmQ,109962480
2
+ codestrand-0.1.0.dist-info/METADATA,sha256=umyG43-_WLRQkY2v-ORWs6lO-8e9KrvqXI7Qy4Bc4c8,8797
3
+ codestrand-0.1.0.dist-info/WHEEL,sha256=Fvrs5zUKO4nQbE5Fttn9y8loVOWxn3I3-bRdoW2U0nw,102
4
+ codestrand-0.1.0.dist-info/licenses/LICENSE,sha256=KfrTdQjO1Mt9pyKzCBBcXw57W91bcDXepTgiX7o3E6w,1068
5
+ codestrand-0.1.0.dist-info/licenses/LICENSE-APACHE,sha256=Yseh419WQGiW16p8pS0MwNJyrAIrXSeW59aQXbijY2o,9723
6
+ codestrand-0.1.0.dist-info/licenses/assets/material/LICENSE.txt,sha256=zaswFNT2m0nd4rhegXkiCMct5hOqau1_eptcZgm4lnA,1085
7
+ codestrand-0.1.0.dist-info/sboms/codestrand.cyclonedx.json,sha256=zdvvh5JTgqSgh_E_H49eWr-zwW2W3KkNMspJFyRB_Ys,600836
8
+ codestrand-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: maturin (1.16.0)
3
+ Root-Is-Purelib: false
4
+ Tag: py3-none-macosx_11_0_arm64
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Owen Lamont
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,176 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
@@ -0,0 +1,8 @@
1
+ The MIT License (MIT)
2
+ Copyright (c) 2025 Material Extensions
3
+
4
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
5
+
6
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
7
+
8
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.