reposnap 0.6.5__py3-none-any.whl → 0.7.0__py3-none-any.whl

reposnap/controllers/project_controller.py

@@ -15,7 +15,7 @@ class ProjectController:
             self.args = args
             # Treat positional arguments as literal file/directory names.
             input_paths = [
-                Path(p) for p in (args.paths if hasattr(args, "paths") else [args.path])
+                Path(p) for p in (args.paths if hasattr(args, "paths") else [])
             ]
             self.input_paths = []
             for p in input_paths:
@@ -47,6 +47,7 @@ class ProjectController:
             self.exclude_patterns: List[str] = (
                 args.exclude if hasattr(args, "exclude") else []
             )
+            self.changes_only: bool = getattr(args, "changes", False)
         else:
             self.args = None
             self.input_paths = []
@@ -54,6 +55,7 @@ class ProjectController:
             self.structure_only = False
             self.include_patterns = []
             self.exclude_patterns = []
+            self.changes_only = False
         self.file_tree: Optional[FileTree] = None
         self.gitignore_patterns: List[str] = []
         if self.root_dir:
@@ -109,13 +111,23 @@ class ProjectController:
         return files
 
     def collect_file_tree(self) -> None:
-        self.logger.info("Collecting files from Git tracked files if available.")
+        if self.changes_only:
+            self.logger.info("Collecting uncommitted files from Git repository.")
+        else:
+            self.logger.info("Collecting files from Git tracked files if available.")
         try:
             from reposnap.core.git_repo import GitRepo
 
             git_repo = GitRepo(self.root_dir)
-            all_files = git_repo.get_git_files()
-            self.logger.debug(f"Git tracked files: {all_files}")
+            if self.changes_only:
+                all_files = git_repo.get_uncommitted_files()
+                self.logger.info(
+                    "Using only uncommitted files (staged, unstaged, untracked, stashed)."
+                )
+            else:
+                all_files = git_repo.get_git_files()
+                self.logger.info("Using all Git tracked files.")
+            self.logger.debug(f"Git files: {all_files}")
         except Exception as e:
             self.logger.warning(f"Error obtaining Git tracked files: {e}.")
             all_files = []

reposnap/core/git_repo.py

@@ -30,3 +30,71 @@ class GitRepo:
         except InvalidGitRepositoryError:
             self.logger.error(f"Invalid Git repository at: {self.repo_path}")
             return []
+
+    def get_uncommitted_files(self) -> List[Path]:
+        """
+        Return every *working-copy* file that differs from HEAD - staged,
+        unstaged, untracked, plus everything referenced in `git stash list`.
+        Paths are *relative to* self.repo_path.
+        """
+        try:
+            repo: Repo = Repo(self.repo_path, search_parent_directories=True)
+            repo_root: Path = Path(repo.working_tree_dir).resolve()
+            paths: set = set()
+
+            # Staged changes (diff between index and HEAD)
+            for diff in repo.index.diff("HEAD"):
+                paths.add(diff.a_path or diff.b_path)
+
+            # Unstaged changes (diff between working tree and index)
+            for diff in repo.index.diff(None):
+                paths.add(diff.a_path or diff.b_path)
+
+            # Untracked files
+            paths.update(repo.untracked_files)
+
+            # Stash entries - with performance guard
+            try:
+                stash_refs = repo.git.stash("list", "--format=%gd").splitlines()
+                # Limit stash processing to prevent performance issues
+                max_stashes = 10
+                if len(stash_refs) > max_stashes:
+                    self.logger.warning(
+                        f"Large stash stack detected ({len(stash_refs)} entries). "
+                        f"Processing only the first {max_stashes} stashes."
+                    )
+                    stash_refs = stash_refs[:max_stashes]
+
+                for ref in stash_refs:
+                    if ref.strip():  # Skip empty lines
+                        stash_files = repo.git.diff(
+                            "--name-only", f"{ref}^1", ref
+                        ).splitlines()
+                        paths.update(stash_files)
+            except Exception as e:
+                self.logger.debug(f"Error processing stash entries: {e}")
+
+            # Convert to relative paths and filter existing files
+            relative_paths = []
+            for path_str in paths:
+                if path_str:  # Skip empty strings
+                    absolute_path = (repo_root / path_str).resolve()
+                    try:
+                        relative_path = absolute_path.relative_to(self.repo_path)
+                        if absolute_path.is_file():
+                            relative_paths.append(relative_path)
+                    except ValueError:
+                        # Log warning for paths outside repo root
+                        self.logger.warning(
+                            f"Path {path_str} is outside repository root {self.repo_path}. Skipping."
+                        )
+                        continue
+
+            # Return sorted, deduplicated list for deterministic output
+            result = sorted(set(relative_paths))
+            self.logger.debug(f"Uncommitted files from {repo_root}: {result}")
+            return result
+
+        except InvalidGitRepositoryError:
+            self.logger.error(f"Invalid Git repository at: {self.repo_path}")
+            return []

reposnap/interfaces/cli.py

@@ -40,6 +40,12 @@ def main():
         default=[],
         help="File/folder patterns to exclude.",
     )
+    parser.add_argument(
+        "-c",
+        "--changes",
+        action="store_true",
+        help="Use only files that are added/modified/untracked/stashed but not yet committed.",
+    )
 
     args = parser.parse_args()
 

{reposnap-0.6.5.dist-info → reposnap-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reposnap
-Version: 0.6.5
+Version: 0.7.0
 Summary: Generate a Markdown file with all contents of your project
 Author: agoloborodko
 License-File: LICENSE
@@ -25,6 +25,7 @@ Description-Content-Type: text/markdown
 - **Structure Only Option**: The `--structure-only` flag can be used to generate the Markdown file with just the directory structure, omitting the contents of the files.
 - **Gitignore Support**: Automatically respects `.gitignore` patterns to exclude files and directories.
 - **Include and Exclude Patterns**: Use `--include` and `--exclude` to specify patterns for files and directories to include or exclude.
+- **Changes Only Mode**: Use `-c` or `--changes` to snapshot only uncommitted files (staged, unstaged, untracked, and stashed changes).
 
 ## Installation
 
@@ -49,7 +50,7 @@ pip install -r requirements.lock
 To use `reposnap` from the command line, run it with the following options:
 
 ```bash
-reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] [-i INCLUDE [INCLUDE ...]] [-e EXCLUDE [EXCLUDE ...]] paths [paths ...]
+reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] [-i INCLUDE [INCLUDE ...]] [-e EXCLUDE [EXCLUDE ...]] [-c] paths [paths ...]
 ```
 
 - `paths`: One or more paths (files or directories) within the repository whose content and structure should be rendered.
@@ -59,6 +60,7 @@ reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] [-i INCLUDE [INCLUDE ...]
 - `--debug`: Enable debug-level logging.
 - `-i, --include`: File/folder patterns to include. For example, `-i "*.py"` includes only Python files.
 - `-e, --exclude`: File/folder patterns to exclude. For example, `-e "*.md"` excludes all Markdown files.
+- `-c, --changes`: Use only files that are added/modified/untracked/stashed but not yet committed.
 
 #### Pattern Matching
 
@@ -71,6 +73,42 @@ reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] [-i INCLUDE [INCLUDE ...]
   - `-i "*.py"`: Includes only files ending with `.py`.
   - `-e "*.test.*"`: Excludes files with `.test.` in their names.
 
+#### Only Snapshot Your Current Work
+
+The `-c` or `--changes` flag allows you to generate documentation for only the files that have been modified but not yet committed. This includes:
+
+- **Staged changes**: Files that have been added to the index with `git add`
+- **Unstaged changes**: Files that have been modified but not yet staged
+- **Untracked files**: New files that haven't been added to Git yet
+- **Stashed changes**: Files that are stored in Git stash entries
+
+This is particularly useful when you want to:
+- Document only your current work-in-progress
+- Create a snapshot of changes before committing
+- Review what files you've been working on
+
+**Examples**:
+
+1. **Generate documentation for only your uncommitted changes**:
+    ```bash
+    reposnap . -c
+    ```
+
+2. **Combine with structure-only for a quick overview**:
+    ```bash
+    reposnap . -c --structure-only
+    ```
+
+3. **Filter uncommitted changes by file type**:
+    ```bash
+    reposnap . -c -i "*.py"
+    ```
+
+4. **Exclude test files from uncommitted changes**:
+    ```bash
+    reposnap . -c -e "*test*"
+    ```
+
 #### Examples
 
 1. **Generate a full project structure with file contents**:
@@ -103,6 +141,12 @@ reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] [-i INCLUDE [INCLUDE ...]
     reposnap my_project/ -e "gui"
     ```
 
+6. **Document only your current uncommitted work**:
+
+    ```bash
+    reposnap . -c
+    ```
+
 ### Graphical User Interface
 
 `reposnap` also provides a GUI for users who prefer an interactive interface.

{reposnap-0.6.5.dist-info → reposnap-0.7.0.dist-info}/RECORD

@@ -1,19 +1,19 @@
 reposnap/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reposnap/controllers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reposnap/controllers/project_controller.py,sha256=XranKRoWd1cRZ4cEXmN_YddO-GHREz9t2J0TUJ4mtgs,10053
+reposnap/controllers/project_controller.py,sha256=RROOcb_FiEhFc9oshptPL8moH-5lkUrio7Lp0MqBqp0,10599
 reposnap/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reposnap/core/file_system.py,sha256=82gwvmgrsWf63paMrIz-Z0eqIjbqt9_-vujdXlJJoFE,1074
-reposnap/core/git_repo.py,sha256=I0AhB6XbABJ-oVGOSkVhSjFjSFfcm6f1VFHGTeuM4gE,1255
+reposnap/core/git_repo.py,sha256=YVIbx-Y_MUbnn5Z4E2XBTJbG7Kawx5aUX2tg6vnocd0,4284
 reposnap/core/markdown_generator.py,sha256=V6uEbxVSbCbxKN9ysTDKsIDvEGBxFutpOpyaZRXZUGw,3747
 reposnap/interfaces/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reposnap/interfaces/cli.py,sha256=qkbYAlgZzlxgW8ePIUwd8JSbvnBVSvde-VlVqzMDh7g,1470
+reposnap/interfaces/cli.py,sha256=gL0gauEt_AkuRRr-p5YAeHeUPgvZ59lpZMqsopLjHas,1661
 reposnap/interfaces/gui.py,sha256=sTuQxjD1nPa9FpgfzOwi6VDO5QMMtDX-5CiEhbJJcs4,5429
 reposnap/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reposnap/models/file_tree.py,sha256=jGo_SizdFcOiDC1OOMz-tiijRN3iSD7ENh6Xw8S6OL0,3362
 reposnap/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reposnap/utils/path_utils.py,sha256=UrMe5cjspTf-4gjg2lzv6BgLwZ7S_1lLECQvDMDZO9Y,507
-reposnap-0.6.5.dist-info/METADATA,sha256=V85e8nN5tNH_U-W_tludr_nG8CNvhGEDAX34Tz1r8JM,5348
-reposnap-0.6.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reposnap-0.6.5.dist-info/entry_points.txt,sha256=o3GyO7bpR0dujPCjsvvZMPv4pXNJlFwD49_pA1r5FOA,102
-reposnap-0.6.5.dist-info/licenses/LICENSE,sha256=Aj7WCYBXi98pvi723HPn4GDRyjxToNWb3PC6j1_lnPk,1069
-reposnap-0.6.5.dist-info/RECORD,,
+reposnap-0.7.0.dist-info/METADATA,sha256=oJF5qQGPWc6aG2mnupOpiDrbJ1hWbApjDCP0tM-lB2Y,6768
+reposnap-0.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reposnap-0.7.0.dist-info/entry_points.txt,sha256=o3GyO7bpR0dujPCjsvvZMPv4pXNJlFwD49_pA1r5FOA,102
+reposnap-0.7.0.dist-info/licenses/LICENSE,sha256=Aj7WCYBXi98pvi723HPn4GDRyjxToNWb3PC6j1_lnPk,1069
+reposnap-0.7.0.dist-info/RECORD,,