cxtree 0.1.0__tar.gz

cxtree-0.1.0/.gitignore

@@ -0,0 +1,210 @@
+abstract.yaml
+abstract-tree.yaml
+context.md
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

cxtree-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14

cxtree-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Aiumi Net
+
+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.

cxtree-0.1.0/PKG-INFO

@@ -0,0 +1,448 @@
+Metadata-Version: 2.4
+Name: cxtree
+Version: 0.1.0
+Summary: Generate focused, token-efficient LLM context files from your project.
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: click>=8.1
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0
+Description-Content-Type: text/markdown
+
+# cxtree
+
+[![PyPI](https://img.shields.io/pypi/v/cxtree)](https://pypi.org/project/cxtree/)
+[![GitHub](https://img.shields.io/badge/github-aiumi--net%2Fcxtree-blue)](https://github.com/aiumi-net/cxtree)
+
+> Generate focused, token-efficient LLM context files from your project.
+
+`cxtree` walks a project directory and produces a structured Markdown file
+containing the directory tree and relevant source files as code blocks — ready
+to paste into any LLM chat as context.
+
+The key idea: instead of dumping everything into the context window, you control
+exactly what the LLM sees — per directory, per file, per class, per function —
+using a YAML configuration file.
+
+---
+
+## Installation
+
+```bash
+pip install cxtree
+```
+
+Or with [uv](https://github.com/astral-sh/uv):
+
+```bash
+uv add cxtree
+```
+
+---
+
+## Quick start
+
+```bash
+# 1. Generate abstract-tree.yaml in your project root
+cxtree init
+
+# 2. Edit abstract-tree.yaml to configure what the LLM sees (optional)
+
+# 3. Generate context.md
+cxtree create
+```
+
+Then paste `context.md` into any LLM chat.
+
+---
+
+## Commands
+
+All commands accept `-r / --root` to point at a project directory other than `.`.
+
+### `init`
+
+Traverses the project, discovers files, and writes `abstract-tree.yaml` to the
+project root. If a file already exists it is preserved — only new entries are
+added.
+
+```bash
+cxtree init
+cxtree init -r path/to/project
+```
+
+**`--folder` flag** — stores both `abstract-tree.yaml` and `context.md` inside a
+`.abstract-tree/` subdirectory (which gets a `.gitignore` that excludes its
+contents from git). Useful for keeping the project root clean.
+
+```bash
+cxtree init --folder
+```
+
+Switching between folder and normal mode re-runs automatically and cleans up the
+previous location.
+
+---
+
+### `create`
+
+Reads `abstract-tree.yaml` and generates `context.md`.
+
+```bash
+cxtree create
+cxtree create -o docs/llm-context.md   # custom output path
+```
+
+---
+
+### `leafs`
+
+Splits the flat root `abstract-tree.yaml` into per-directory `abstract.yaml`
+child files. Useful for large projects where many directories need fine-grained
+control.
+
+```bash
+cxtree leafs
+```
+
+Each directory with file-level entries gets its own `abstract.yaml`. The root
+file is reduced to directory stubs. Re-running `leafs` on an already-split
+project merges changes back first, then re-splits.
+
+---
+
+### `flatten`
+
+The reverse of `leafs`. Reads all child `abstract.yaml` files and merges their
+entries back into the root file, then deletes them.
+
+```bash
+cxtree flatten             # flatten everything
+cxtree flatten domain      # flatten only the domain/ subtree
+cxtree flatten domain.users
+```
+
+---
+
+### `tree`
+
+Prints a coloured directory tree of the project respecting the same exclusion
+rules as `init`.
+
+```bash
+cxtree tree
+```
+
+Folders are shown in yellow, `.py` files in blue, everything else in white.
+
+---
+
+### `rm`
+
+Removes all generated files: `context.md`, `abstract-tree.yaml`, and all child
+`abstract.yaml` files.
+
+```bash
+cxtree rm
+```
+
+---
+
+## abstract-tree.yaml
+
+`abstract-tree.yaml` is the root configuration file. It has two sections:
+
+1. A `cxtree:` header block with project-wide settings.
+2. Directory and file entries that control what the LLM sees.
+
+### Header block
+
+```yaml
+cxtree:
+  x_root: docs           # default tag for the whole project
+  is_flat: true          # true = only root file used; false = leaf mode
+  ext_found: [py, toml]  # written by init — informational only
+  config:
+    x_rm_empty_lines: false       # strip all blank lines from output
+    x_rm_empty_lines_docs: true   # strip blank lines from doc-only sections
+    include:
+      x_extensions: [py]          # file extensions included in context
+    exclude:
+      x_startswith: [".", "__"]   # skip files/dirs starting with these prefixes
+      x_folders: [".venv", "node_modules", "__pycache__"]
+```
+
+### Directory entries
+
+Directories use dot-notation keys with `is_dir: true`. `init` generates these
+automatically.
+
+```yaml
+domain:
+  is_dir: true
+
+domain.users:
+  is_dir: true
+  models.py: docs
+  auth.py: include
+```
+
+### File entries
+
+Files are nested under their directory key (or at root level for files in the
+project root). The value controls what the LLM sees.
+
+```yaml
+domain.users:
+  is_dir: true
+  models.py: docs          # show docstrings only
+  auth.py: include         # show full source
+  legacy.py: exclude       # hide completely
+  base.py: "Shared base classes — no details needed."  # replace with text
+```
+
+---
+
+## Tags
+
+Tags control how a file (or symbol) is rendered.
+
+| Tag | What the LLM sees |
+|---|---|
+| `docs` | Docstrings only — code bodies are replaced with `# ...` |
+| `code` | Code bodies only — docstrings are stripped |
+| `include` | Full source: code + docstrings |
+| `exclude` | Hidden — not included in context at all |
+
+Tags are inherited top-down. The `x_root` value in the header is the starting
+point; any entry without an explicit tag inherits from its parent.
+
+---
+
+## Symbol-level configuration
+
+For Python files you can configure individual classes and functions.
+
+```yaml
+domain.users:
+  is_dir: true
+  auth.py:
+    x_abstract:
+      - "Authentication service — login, logout, token validation."
+    class:
+      AuthService:
+        x_abstract:
+          - "Handles login, logout and token validation."
+        def:
+          login: docs          # show docstring only
+          logout: docs
+          validate_token: include   # show full source
+          _sign: exclude       # hide private helper
+    def:
+      create_token: docs
+```
+
+`__init__`, `__post_init__`, `__new__` and other lifecycle dunders are always
+skipped — they are never emitted even with `include`.
+
+`x_abstract` on a file or class sets a description shown above its content.
+Use a list for multi-line descriptions:
+
+```yaml
+auth.py:
+  x_abstract:
+    - "Authentication service."
+    - "Tokens are HMAC-signed. No external JWT library required."
+```
+
+---
+
+## Text replacements
+
+Assign any string to a directory or file entry to replace it entirely with that
+text. No further content is shown.
+
+```yaml
+domain.legacy:
+  is_dir: true
+  old_service.py: "Deprecated. Superseded by domain.users.services."
+```
+
+Multiline replacement using a YAML list:
+
+```yaml
+domain.users:
+  is_dir: true
+  models.py:
+    - "User entity with id, username, email, is_active, roles."
+    - "Session entity binding a user_id to a token and expiry."
+```
+
+### `x_hard_abstract` (directory-level)
+
+Setting `x_hard_abstract` on a directory entry replaces the entire directory
+with a single summary line — no files inside are walked.
+
+```yaml
+workers:
+  is_dir: true
+  x_hard_abstract: "Background workers for cleanup and reporting."
+```
+
+Set it to `"off"` to disable the override without removing the key:
+
+```yaml
+workers:
+  is_dir: true
+  x_hard_abstract: "off"
+```
+
+---
+
+## abstract-leaf.yaml
+
+Place an `abstract-leaf.yaml` file inside any directory to provide the
+highest-priority flat overrides for that directory. Entries here override
+everything else — tags, symbol config, even the `include_extensions` filter.
+
+```yaml
+# domain/abstract-leaf.yaml
+notifications: "Email and SMS dispatchers — not relevant for this task."
+models.py: "User entity and Notification entity."
+```
+
+**Keys = filenames or subdirectory names** within that directory only.
+Values must be plain strings.
+
+To deactivate an entry without deleting it, prefix the key with `.` or `__`
+(the default `exclude_startswith` prefixes):
+
+```yaml
+# disabled — notifications/ is walked normally
+.notifications: "Email and SMS dispatchers — not relevant for this task."
+```
+
+`abstract-leaf.yaml` is never included in the context output itself.
+
+---
+
+## Inline source tags
+
+Fine-tune what gets shown inside a function or method body using inline comments.
+
+### `# ++` — show N lines from this point
+
+The number of `+` characters determines how many lines are shown starting from
+and including the tagged line. `# ++` = 2 lines, `# +++` = 3 lines, etc.
+
+```python
+def build_app(config: AppConfig) -> dict:
+    user_svc = UserService(config.db_url)  # ++
+    notif_svc = NotificationService(...)
+    # ← both lines above are shown; rest of body is compressed to # ...
+```
+
+### `# ---` — hide N lines
+
+The number of `-` characters determines how many lines are hidden. The tagged
+line and the N−1 lines that follow are replaced by a single `# ---` placeholder.
+`# ---` = 3 lines hidden, `# ----` = 4 lines, etc.
+
+```python
+def process(self, request: dict) -> dict:
+    token = header[len(prefix):]  # ---
+    request["_token"] = token     # ← this line is hidden (part of the 3)
+    return request
+```
+
+Both tags preserve the indentation of the tagged line in the placeholder.
+
+---
+
+## Leaf mode (per-directory child files)
+
+Run `leafs` to split the flat root file into one `abstract.yaml` per directory.
+This is useful when many directories need independent, detailed configuration.
+
+```
+project/
+├── abstract-tree.yaml        # root — directory stubs only
+├── domain/
+│   └── abstract.yaml         # file entries for domain/
+└── api/
+    └── abstract.yaml         # file entries for api/
+```
+
+Child `abstract.yaml` files use the same tag and symbol syntax. They are
+identified by `abstract-depth:` (set automatically by `leafs`) which must match
+the directory's actual depth from the project root.
+
+### `x_is_flat` and `x_hard_abstract` in child abstracts
+
+A subdirectory entry inside a child abstract can carry two control keys:
+
+```yaml
+# domain/abstract.yaml
+abstract-depth: 1
+parent-dirs: [domain]
+
+users:
+  is_dir: true
+  x_is_flat: false          # false = keep its own child abstract
+  x_hard_abstract: "off"    # placeholder — replace "off" with text to activate
+```
+
+- `x_is_flat: true` — merge this subdirectory back into the parent on the next
+  `leafs` run instead of keeping its own child abstract.
+- `x_hard_abstract: "<text>"` — replace the entire subdirectory with a summary
+  in the context output. `"off"` = feature inactive.
+
+---
+
+## Folder mode
+
+Use `--folder` to keep generated files out of the project root:
+
+```bash
+cxtree init --folder
+cxtree create    # reads and writes inside .abstract-tree/
+```
+
+The `.abstract-tree/` directory contains:
+
+```
+.abstract-tree/
+├── .gitignore          # excludes everything inside from git
+├── abstract-tree.yaml
+└── context.md
+```
+
+Switch back to normal mode by running `init` without `--folder`:
+
+```bash
+cxtree init       # deletes .abstract-tree/, writes to project root
+```
+
+---
+
+## Example workflow
+
+```bash
+# Initial setup
+cxtree init
+
+# Review abstract-tree.yaml, tune tags and descriptions, then generate
+cxtree create
+
+# For large projects: split into per-directory files
+cxtree leafs
+
+# Edit individual abstract.yaml files in each directory, then regenerate
+cxtree create
+
+# Merge a subtree back (e.g. after simplifying domain/)
+cxtree flatten domain
+
+# Clean up everything
+cxtree rm
+```