gitex 0.2.18__py3-none-any.whl → 0.3.0__py3-none-any.whl

gitex/__init__.py

@@ -1 +1 @@
-__version__ = "0.2.18"
+__version__ = "0.3.0"

gitex/picker/textuals.py

@@ -105,7 +105,7 @@ class _PickerApp(App):  # pylint: disable=too-many-public-methods
 
     def _format_label(self, file_node: FileNode) -> Text:
         """Generate label with colored checkbox and name based on selection state."""
-        mark = "[x]" if file_node.path in self.selected_paths else "[ ]"
+        mark = "[✓]" if file_node.path in self.selected_paths else "[ ]"
         label = f"{mark} {file_node.name}"
         if file_node.path in self.selected_paths:
             return Text(label, style="bold green")
@@ -134,9 +134,9 @@ class _PickerApp(App):  # pylint: disable=too-many-public-methods
 
         file_node: FileNode = node.data
         
-        # If the parent itself is explicitly selected, mark it Green [x]
+        # If the parent itself is explicitly selected, mark it Green [✓]
         if file_node.path in self.selected_paths:
-            mark = "[x]"
+            mark = "[✓]"
             style = "bold green"
         else:
             # Check children to see if we need a partial state [-]
@@ -146,7 +146,7 @@ class _PickerApp(App):  # pylint: disable=too-many-public-methods
             
             if child_paths and len(selected_children) == len(child_paths):
                 # All UI children selected (and parent not in set? shouldn't happen often if logic holds)
-                mark = "[x]"
+                mark = "[✓]"
                 style = "bold green"
             elif selected_children:
                 # Some children selected

gitex-0.3.0.dist-info/METADATA

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: gitex
+Version: 0.3.0
+Summary: Terminal tool to prep codebases for LLMs
+Author-email: zozaai <info@zozaai.com>
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: click<8.2,>=8.0
+Requires-Dist: textual>=5.2.0
+Requires-Dist: questionary==2.1.0
+Requires-Dist: pathspec<1.0,>=0.10.1
+Requires-Dist: pydantic
+Requires-Dist: GitPython
+Provides-Extra: test
+Requires-Dist: pytest>=8.0; extra == "test"
+Requires-Dist: pytest-cov>=5.0; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+
+<p align="center">
+  <a href="https://excalidraw.com/#json=FcO55BsQn51s2Pqqt5rrK,oh1x03sJwQH__qTI1Zd1tw">
+    <img src="docs/logo.jpeg" alt="gitex logo" width="20%" />
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/zozaai/gitex/actions/workflows/ci.yml">
+    <img src="https://github.com/zozaai/gitex/actions/workflows/ci.yml/badge.svg" alt="CI" />
+  </a>
+  <a href="https://codecov.io/gh/zozaai/gitex">
+    <img src="https://codecov.io/gh/zozaai/gitex/branch/main/graph/badge.svg" alt="codecov" />
+  </a>
+</p>
+
+<p align="center">  
+  🛠️ Terminal tool to prep your codebase (whole or partial) for LLMs, clean, compress, and convert it into prompt-ready text! 🚀📦
+</p>
+
+<p align="center">
+  <img src="docs/demo1.gif" alt="gitex animated demo" width="100%" />
+</p>
+
+
+
+## 📥 Installation
+
+Install the package via pip:
+
+```bash
+pip install gitex
+```
+
+## 🐳 Docker install (no Python/pip)
+
+If you only have Docker and want `gitex` as a normal command:
+
+```bash
+git clone https://github.com/zozaai/gitex
+cd gitex
+./scripts/install-gitex-docker.sh
+```
+
+
+## 📋 Clipboard support (Linux)
+
+#### Ubuntu/Debian
+```bash
+# Wayland (recommended):
+sudo apt install -y wl-clipboard
+
+# X11 alternatives:
+sudo apt install -y xclip
+# or
+sudo apt install -y xsel
+```
+
+## ▶️ Usage
+
+`gitex` helps you bundle your codebase into a single, LLM-friendly text format. It respects your `.gitignore` by default and provides several ways to filter content.
+
+### Basic Examples
+```bash
+gitex .                                 # Process current directory and copy to clipboard
+gitex -i                                # Launch the interactive TUI to pick specific files/folders
+gitex /path/to/repo --force             # Force process a directory even if it's not a Git repo
+gitex . --no-files                      # Render the directory tree ONLY (omit file contents)
+```
+
+### Advanced Filtering & Combinations
+```bash
+gitex . -a                              # Include hidden files (those starting with .)
+gitex . -g                              # Ignore .gitignore rules (process everything)
+gitex . -ag                             # Combine: Show hidden files AND ignore .gitignore
+gitex . -iv                             # Interactive selection with verbose output to terminal
+gitex . -v                              # Verbose: Print to terminal AND copy to clipboard
+gitex . > codebase.txt                  # Redirect output to a text file
+```
+
+### Intelligence Features
+```bash
+gitex . -ds                             # Extract only Python docstrings and signatures
+gitex . --map-dependencies              # Analyze code relationships (imports, inheritance, calls)
+```
+
+## 🙏 Acknowledgments
+This project draws inspiration from [repo2txt](https://github.com/abinthomasonline/repo2txt) by [@abinthomasonline](https://github.com/abinthomasonline).  
+Big thanks for laying the groundwork for converting repositories into prompt-ready text!
+
+---
+
+<details>
+<summary><b>📚 Click to expand: Docstring Extraction Details</b></summary>
+
+### Python Docstring Extraction
+Extract and format docstrings and function/class signatures from Python files, inspired by Sphinx. Perfect for providing high-level context to LLMs without implementation noise.
+
+*   **Extract from all Python files:**  
+    `gitex . --extract-docstrings`
+*   **Extract from a specific class or function:**  
+    `gitex . --extract-docstrings gitex.renderer.Renderer`
+*   **Include classes/functions even if they have no docstrings:**  
+    `gitex . --extract-docstrings --include-empty-classes`
+
+</details>
+
+<details>
+<summary><b>🔗 Click to expand: Dependency & Relationship Mapping Details</b></summary>
+
+### Architecture Analysis
+Analyze and visualize code architecture, dependencies, and relationships in your codebase. Essential for understanding how components interact before diving into implementation details.
+
+*   **Full analysis:** `gitex . --map-dependencies`
+*   **Focus on imports:** `gitex . --map-dependencies imports`
+*   **Focus on inheritance:** `gitex . --map-dependencies inheritance` 
+*   **Focus on function calls:** `gitex . --map-dependencies calls`
+
+**What it maps:**
+*   📦 **Import dependencies** - Which files depend on which other files.
+*   🏗️ **Class inheritance hierarchies** - Parent-child relationships between classes.
+*   🔄 **Function call relationships** - Which functions call which other functions.
+*   📊 **Summary statistics** - Overview of codebase complexity and external dependencies.
+
+</details>

{gitex-0.2.18.dist-info → gitex-0.3.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-gitex/__init__.py,sha256=3RGPra41WobAbWeoPRqR_JXeysqFvK3H3AP1g9gjj3g,23
+gitex/__init__.py,sha256=VrXpHDu3erkzwl_WXrqINBm9xWkcyUy53IQOj042dOs,22
 gitex/dependency_mapper.py,sha256=alQ_3Bua-VCI-CtwMZH9vJYrLjlLFrYxbuYrydGFiMI,18236
 gitex/docstring_extractor.py,sha256=glqS3aihTP_FWBS76uB9TAojkH-8Qv9Rgflp75mWzXs,5037
 gitex/main.py,sha256=dvPKfUvQ7rqta9-UDZw265aRzKOhrT4hdIVFmo-aLkQ,6576
@@ -8,14 +8,14 @@ gitex/utils.py,sha256=ivweFCUly8QEqNWV3NtF2fCTEaz3ukjYYt40ROKxkvE,2181
 gitex/picker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 gitex/picker/base.py,sha256=g3XOQBcy7o28ItwThxmqi7Hf_ZIK5KYKTUuFCumb3nA,3240
 gitex/picker/questionary.py,sha256=eMwn5eHbephpjKP-cGUBSKZNaHaklqbsZFHuWevTYU4,2208
-gitex/picker/textuals.py,sha256=mXiU4jLd-hCTkdH9Bk3O27UAi3_Mj-9GvdbgUEgZxTA,10393
+gitex/picker/textuals.py,sha256=UzDXIyqmlYBl1LWavvo_A6mZDBph8d6P-Dn0-MKzWKE,10401
 tests/test_cli.py,sha256=T3V6TffCkSQAHlt7m4MYL-V-ADsIe89E2XCR3AktoVs,4987
 tests/test_fences.py,sha256=00tzli0cG8yNxzAUobOj797SBJtTVAwVpbL7b5_nRIM,4313
 tests/test_render.py,sha256=DaRMPRDfqSteVO4Z6BIkF777V1cpXwnaGYSqbBUU3mk,7223
 tests/test_skip_binaries.py,sha256=r9izOgpb284y8bN7p_M9-5VixokW0WFA2npmAmxdMLk,1905
-tests/test_textual.py,sha256=V7zG1hhpAaxEFFWaGCaY2PFDBjfogCnjRD1wGUTXKEU,9887
-gitex-0.2.18.dist-info/METADATA,sha256=hOQIpFjygOyL-E_UZ7ht0x0GQGqGs8MwKC1W2hWF7f4,4335
-gitex-0.2.18.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-gitex-0.2.18.dist-info/entry_points.txt,sha256=YVGHi9Ock94uICcjGxm_eHtwBv3_RCiwpBKwIkMJhGI,41
-gitex-0.2.18.dist-info/top_level.txt,sha256=N-r2BJX8y5Wlkh3VtRSBC8jagKMDxFDP9iOwpN1H2do,12
-gitex-0.2.18.dist-info/RECORD,,
+tests/test_textual.py,sha256=EPH5hOaAM7N4eJN6aTz5rqFvRoDd0OyjIrhfoMNzaFY,9897
+gitex-0.3.0.dist-info/METADATA,sha256=KakrgE3gUDghEmJXXZoWDDDJ2yR8Ow5rNS2JN_bSjIQ,5083
+gitex-0.3.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+gitex-0.3.0.dist-info/entry_points.txt,sha256=YVGHi9Ock94uICcjGxm_eHtwBv3_RCiwpBKwIkMJhGI,41
+gitex-0.3.0.dist-info/top_level.txt,sha256=N-r2BJX8y5Wlkh3VtRSBC8jagKMDxFDP9iOwpN1H2do,12
+gitex-0.3.0.dist-info/RECORD,,

tests/test_textual.py

@@ -100,7 +100,7 @@ async def test_toggle_file_selection(mock_file_tree):
         
         # Toggle ON
         await pilot.press("space")
-        assert "[x]" in str(target_node.label)
+        assert "[✓]" in str(target_node.label)
         assert "root/root_file.txt" in app.selected_paths
         
         # Toggle OFF
@@ -122,7 +122,7 @@ async def test_recursive_selection(mock_file_tree):
         # Toggle folder ON
         await pilot.press("space")
         
-        assert "[x]" in str(folder_ui_node.label)
+        assert "[✓]" in str(folder_ui_node.label)
         assert "root/folder/file1.py" in app.selected_paths
         assert "root/folder/file2.py" in app.selected_paths
         
@@ -156,8 +156,8 @@ async def test_partial_selection_visuals(mock_file_tree):
         tree.select_node(file2_ui_node)
         await pilot.press("space")
         
-        # Now parent should be fully checked [x]
-        assert "[x]" in str(folder_ui_node.label)
+        # Now parent should be fully checked [✓]
+        assert "[✓]" in str(folder_ui_node.label)
 
 
 @pytest.mark.asyncio
@@ -285,7 +285,7 @@ async def test_unused_toggle_recursively_method(mock_file_tree):
         assert "root/folder/file1.py" in app.selected_paths
         
         # Check that it updated the UI label
-        assert "[x]" in str(folder_node.label)
+        assert "[✓]" in str(folder_node.label)
         
         # Toggle off
         app._toggle_recursively(folder_node, select=False)

gitex-0.2.18.dist-info/METADATA

@@ -1,115 +0,0 @@
-Metadata-Version: 2.4
-Name: gitex
-Version: 0.2.18
-Summary: Terminal tool to prep codebases for LLMs
-Author-email: zozaai <info@zozaai.com>
-License: MIT
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Requires-Dist: click<8.2,>=8.0
-Requires-Dist: textual>=5.2.0
-Requires-Dist: questionary==2.1.0
-Requires-Dist: pathspec<1.0,>=0.10.1
-Requires-Dist: pydantic
-Requires-Dist: GitPython
-Provides-Extra: test
-Requires-Dist: pytest>=8.0; extra == "test"
-Requires-Dist: pytest-cov>=5.0; extra == "test"
-Requires-Dist: pytest-asyncio; extra == "test"
-
-
-
-<p align="center">
-  <a href="https://excalidraw.com/#json=FcO55BsQn51s2Pqqt5rrK,oh1x03sJwQH__qTI1Zd1tw">
-    <img src="docs/logo.jpeg" alt="Jet Voice Block Diagram" width="125%" />
-  </a>
-</p>
-
-
-# gitex
-
-🛠️ Terminal tool to prep your 🧠 codebase (whole or partial) for LLMs — clean, compress, and convert it into prompt-ready text! 🚀📦
-
-[![CI](https://github.com/zozaai/gitex/actions/workflows/ci.yml/badge.svg)](https://github.com/zozaai/gitex/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/zozaai/gitex/branch/main/graph/badge.svg)](https://codecov.io/gh/zozaai/gitex)
-
-
-
-## 📝 To-Do
-- [x] Display GitHub repository structure
-- [x] Select files/directories to include
-- [ ] Filter files by extensions
-- [x] Generate formatted text file
-- [x] Copy text to clipboard
-- [ ] Download generated text
-- [x] Support for private repositories
-- [ ] Download zip of selected files
-- [x] Local directory support
-- [x] make into pypi package
-
-## ✨ Features
-
-
-### 📚 Docstring Extraction
-Extract and format docstrings and function/class signatures from Python files, inspired by Sphinx. Perfect for providing high-level context to LLMs without implementation noise.
-- Extract from all Python files: `gitex . --extract-docstrings`
-- Extract from a specific class or function: `gitex . --extract-docstrings gitex.renderer.Renderer`
-- Control empty classes: `gitex . --extract-docstrings --include-empty-classes`
-
-### 🔗 Dependency & Relationship Mapping  
-Analyze and visualize code architecture, dependencies, and relationships in your codebase. Essential for understanding how components interact before diving into implementation details.
-- **Full analysis**: `gitex . --map-dependencies`
-- **Focus on imports**: `gitex . --map-dependencies imports`
-- **Focus on inheritance**: `gitex . --map-dependencies inheritance` 
-- **Focus on function calls**: `gitex . --map-dependencies calls`
-
-**What it maps:**
-- 📦 **Import dependencies** - Which files depend on which other files
-- 🏗️ **Class inheritance hierarchies** - Parent-child relationships between classes
-- 🔄 **Function call relationships** - Which functions call which other functions
-- 📊 **Summary statistics** - Overview of codebase complexity and external dependencies
-
-=======
-- **Docstring Extraction**: Extract and format docstrings and function/class signatures from Python files, inspired by Sphinx. This is perfect for providing high-level context to LLMs without the noise of implementation details.
-  - Extract from all Python files: `gitex . --extract-docstrings`
-  - Extract from a specific class or function: `gitex . --extract-docstrings gitex.renderer.Renderer`
-- **Clipboard (Linux)**: Copy the rendered output directly to your clipboard using `--copy`.  
-  Tries `wl-copy` (Wayland) → `xclip` (X11) → `xsel` (X11).
-
-
-## 📥 Installation
-```bash
-$ pip install gitex
-```
-
-## 📋 Clipboard support (Linux)
-#### Ubuntu/Debian
-```bash
-# Wayland (recommended):
-sudo apt install -y wl-clipboard
-# X11 alternatives:
-sudo apt install -y xclip
-# or
-sudo apt install -y xsel
-```
-
-
-## ▶️ Usage
-```
-$ gitex --help
-$ gitex .             # current repository
-$ gitex path/to/repo  # any repo path
-$ gitex url           # repo url
-$ gitex -i /path/to/repo > path/to/output.txt  # redirect to text file
-$ gitex -c            # also copy output to clipboard (Linux)
-$ gitex -ic           # also copy output to clipboard (Linux) in interactive mode
-```
-
-
-## 📸 Demo
-![Preview](docs/gitex_demo.png)
-
-
-
-## 🙏 Acknowledgments
-This project draws inspiration from [repo2txt](https://github.com/abinthomasonline/repo2txt) by [@abinthomasonline](https://github.com/abinthomasonline).  
-Big thanks for laying the groundwork for converting repositories into prompt-ready text!