leo-cub 0.0.2__py3-none-win_amd64.whl

leo_cub-0.0.2.dist-info/METADATA

@@ -0,0 +1,162 @@
+Metadata-Version: 2.4
+Name: leo-cub
+Version: 0.0.2
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Text Editors
+Classifier: Topic :: Utilities
+License-File: LICENSE
+Summary: Automation-safe library and CLI for Leo outline files
+Keywords: leo-editor,outline,cli,tui,automation
+Author-email: Ville Vainio <vivainio@gmail.com>
+License: MIT OR Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/vivainio/leo-cub
+Project-URL: Repository, https://github.com/vivainio/leo-cub
+
+# leo-cub
+
+`leo-cub` is an experimental Rust library and command-line tool for reading,
+validating, browsing, and modifying [Leo Editor](https://leo-editor.github.io/leo-editor/)
+outlines.
+
+The installed command is `cub`; the Rust library namespace is `leo`.
+
+## Screenshot
+
+<img width="1836" height="933" alt="image" src="https://github.com/user-attachments/assets/2ff24163-62a2-487b-aaf5-a9ec8c2beb73" />
+
+## Why
+
+Leo outlines are not ordinary XML trees. A GNX identifies shared vnode content,
+while an outline position identifies one occurrence of that vnode. Cloned nodes
+can therefore appear in several places. `leo-cub` keeps those concepts separate
+and exposes transactional operations intended for scripts and AI tools.
+
+## Current features
+
+- Parse and validate `.leo` XML outlines.
+- Preserve XML outside the rewritten `<vnodes>` and `<tnodes>` sections.
+- Represent clone identity separately from outline positions.
+- Apply atomic JSON operation batches with optional text preconditions.
+- Parse Leo 5 thin derived-file sentinels.
+- Reconstruct `@file`, `@thin`, and `@file-thin` hierarchies and bodies.
+- Resolve ancestor `@path` directives in the TUI.
+- Browse outlines with a small Ratatui interface.
+- Highlight node bodies with Syntect, using `@language` or source extensions.
+- Open a derived node's full source file at its sentinel line using `$VISUAL` or
+  `$EDITOR`.
+
+## Install
+
+Install the `cub` command from PyPI with
+[pipx](https://pipx.pypa.io/) (recommended for command-line applications):
+
+```sh
+pipx install leo-cub
+```
+
+You can also use `pip install leo-cub`, or download the appropriate archive
+from the [latest GitHub release](https://github.com/vivainio/leo-cub/releases/latest).
+
+## TUI
+
+```sh
+cub tui outline.leo
+```
+
+The browser resolves external thin files in memory.
+
+## TUI keybindings
+
+### Browsing and display
+
+| Key | Action |
+| --- | --- |
+| `j`, `↓` / `k`, `↑` | Select next/previous node |
+| `l`, `→`, `Enter` | Expand selected node |
+| `h`, `←` | Collapse selected node |
+| `Home` / `End` | Select the first/last visible node |
+| `Ctrl-P` | Find a headline incrementally; use `↑`/`↓` to cycle matches |
+| `o` | Open the full external source file at the node sentinel |
+| `y` | Toggle syntax highlighting |
+
+### Outline editing
+
+| Key | Action |
+| --- | --- |
+| `Ctrl-I` or `Tab` | Insert a new sibling and enter headline editing |
+| `Ctrl-H` or `Backspace` | Edit the selected headline |
+| `Ctrl-↑`, `Ctrl-↓` | Move among siblings |
+| `Ctrl-←`, `Ctrl-→` | Promote or demote the selected node |
+| `Ctrl-S` | Save outline changes |
+| `q` or `Esc` | Quit; press twice to discard unsaved changes |
+
+### Headline editing
+
+| Key | Action |
+| --- | --- |
+| Printable characters | Append to the headline |
+| `Backspace` | Delete the previous character |
+| `Enter` | Accept the headline |
+| `Esc` | Cancel editing; a newly inserted node is removed |
+
+Use `--no-derived` to display only the hierarchy physically present in the
+`.leo` XML file.
+
+For source navigation, `cub` recognizes common position arguments for Vim,
+Neovim, Nano, Emacs, VS Code, Helix, and Kakoune. Other editors receive the file
+path without a line argument.
+
+## Headless commands
+
+```sh
+cub inspect outline.leo
+cub validate outline.leo
+cub diff before.leo after.leo
+cub inspect-derived path/to/derived.py --summary
+cub refresh-derived outline.leo 0 path/to/derived.py --dry-run
+cub apply outline.leo operations.json --dry-run
+```
+
+An operation batch is a JSON object:
+
+```json
+{
+  "operations": [
+    {
+      "op": "set-body",
+      "node": "ekr.20260811210000.1",
+      "expected": "old body",
+      "body": "new body"
+    }
+  ]
+}
+```
+
+Operations are applied to a copy and committed only if the complete batch is
+valid. `expected` provides optimistic conflict detection for headline and body
+edits.
+
+## Status and safety
+
+This project is early and the file format support is incomplete. In particular,
+it does not yet write thin derived files, dynamically interpret every
+`@comment`/`@delims` change, or fully reconstruct all doc-part forms. Keep
+backups and use `--dry-run` when testing write operations on important outlines.
+
+The TUI overlays derived files without modifying either the outline or external
+source files. Derived descendants are read-only in the outline editor; use `o`
+to edit their full external source. Unsaved outline changes require a second
+`q` before they are discarded.
+
+## License
+
+MIT
+

leo_cub-0.0.2.dist-info/RECORD

@@ -0,0 +1,6 @@
+leo_cub-0.0.2.data/scripts/cub.exe,sha256=RoJKAF-LfKW1Dovd9_4nZGndwpxyaPY4GUFuHgw4-ng,4187648
+leo_cub-0.0.2.dist-info/METADATA,sha256=ol4qBsdDH698Z4wLe3W56WhqR0lk46-Yn0vOyq9lM3M,5444
+leo_cub-0.0.2.dist-info/WHEEL,sha256=2zDlIYIdD4m4N3p5DVEG3iJhGLdhsBQgdH-FqVkAur8,94
+leo_cub-0.0.2.dist-info/licenses/LICENSE,sha256=cSxMTdD2s8xxO_iE_sg59qOiPSGFW7U_RwdJ2RXSh3g,1098
+leo_cub-0.0.2.dist-info/sboms/leo-cub.cyclonedx.json,sha256=WPuyShLMa53bbjlIGMcrNOKFH8tmMJl8ARkl6aB3vrQ,213747
+leo_cub-0.0.2.dist-info/RECORD,,

leo_cub-0.0.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.14.1)
+Root-Is-Purelib: false
+Tag: py3-none-win_amd64

leo_cub-0.0.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 leo-cub contributors
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.