reposnap 0.2.3__py3-none-any.whl → 0.3.0__py3-none-any.whl

reposnap/core/collector.py

@@ -1,30 +1,64 @@
 # src/reposnap/core/collector.py
 
-from .file_system import FileSystem
-from .git_repo import GitRepo
-from .markdown_generator import MarkdownGenerator
-import pathspec
 import logging
 from pathlib import Path
+import pathspec
+from .git_repo import GitRepo
+from .file_system import FileSystem
+from .markdown_generator import MarkdownGenerator
 
 
 class ProjectContentCollector:
     def __init__(self, root_dir: str, output_file: str, structure_only: bool, gitignore_patterns: list):
+        self.logger = logging.getLogger(__name__)
         self.root_dir = Path(root_dir).resolve()
         self.output_file = Path(output_file).resolve()
         self.structure_only = structure_only
+        self.gitignore_patterns = gitignore_patterns
         self.spec = pathspec.PathSpec.from_lines(pathspec.patterns.GitWildMatchPattern, gitignore_patterns)
-        self.file_system = FileSystem(self.root_dir)
+
+        # Initialize components
         self.git_repo = GitRepo(self.root_dir)
+        self.file_system = FileSystem(self.root_dir)
         self.markdown_generator = MarkdownGenerator(
             root_dir=self.root_dir,
             output_file=self.output_file,
             structure_only=self.structure_only
         )
-        self.logger = logging.getLogger(__name__)
 
-    def collect_and_generate(self):
-        self.logger.info("Starting project content collection.")
+        # Collect files and build tree during initialization
+        self.files = self.collect_files()
+        self.tree_structure = self.build_tree_structure()
+
+    def collect_files(self):
+        """
+        Collects and filters files to be included in the documentation.
+        """
+        self.logger.info("Collecting git files.")
         git_files = self.git_repo.get_git_files()
-        tree_structure = self.file_system.build_tree_structure(git_files)
-        self.markdown_generator.generate_markdown(tree_structure, git_files, self.spec)
+        self.logger.debug(f"Git files before filtering: {git_files}")
+
+        # Filter files based on .gitignore patterns
+        filtered_files = [
+            f for f in git_files if not self.spec.match_file(str(f))
+        ]
+        self.logger.debug(f"Git files after filtering: {filtered_files}")
+
+        return filtered_files  # Paths relative to root_dir
+
+    def build_tree_structure(self):
+        """
+        Builds the tree structure from the collected files.
+        """
+        self.logger.info("Building tree structure.")
+        tree = self.file_system.build_tree_structure(self.files)
+        self.logger.debug(f"Tree structure: {tree}")
+        return tree
+
+    def collect_and_generate(self):
+        """
+        Initiates the markdown generation process.
+        """
+        self.logger.info("Starting markdown generation.")
+        self.markdown_generator.generate_markdown(self.tree_structure, self.files)
+        self.logger.info("Markdown generation completed.")

reposnap/core/file_system.py

@@ -4,20 +4,27 @@ import logging
 from pathlib import Path
 
 class FileSystem:
-    def __init__(self, root_dir: str):
-        self.root_dir = Path(root_dir).resolve()
+    def __init__(self, root_dir: Path):
+        self.root_dir = root_dir.resolve()
+        self.logger = logging.getLogger(__name__)
 
     def build_tree_structure(self, files):
+        """
+        Builds a hierarchical tree structure from the list of files.
+
+        Args:
+            files (list of Path): List of file paths relative to root_dir.
+
+        Returns:
+            dict: Nested dictionary representing the directory structure.
+        """
         tree = {}
-        logging.debug("\n>>> Processing Files for Tree Structure <<<")
-        for file in files:
-            file_path = (self.root_dir / file).resolve()
-            logging.debug(f"Processing file:\n  File Path: {file_path}\n  Root Dir:  {self.root_dir}")
-            relative_path = file_path.relative_to(self.root_dir).as_posix()
-            parts = relative_path.split('/')
+        self.logger.debug("Building tree structure.")
+        for relative_path in files:
+            parts = relative_path.parts
             current_level = tree
             for part in parts[:-1]:
                 current_level = current_level.setdefault(part, {})
-            current_level[parts[-1]] = relative_path
-        logging.debug(">>> End of Processing <<<\n")
+            current_level[parts[-1]] = relative_path.as_posix()
+        self.logger.debug(f"Tree structure built: {tree}")
         return tree

reposnap/core/git_repo.py

@@ -1,21 +1,30 @@
 # src/reposnap/core/git_repo.py
 
 import logging
+from pathlib import Path
 from git import Repo, InvalidGitRepositoryError
 
 class GitRepo:
-    def __init__(self, repo_path: str):
-        self.repo_path = repo_path
+    def __init__(self, repo_path: Path):
+        self.repo_path = repo_path.resolve()
+        self.logger = logging.getLogger(__name__)
 
     def get_git_files(self):
         try:
-            repo = Repo(self.repo_path)
-            files = repo.git.ls_files().splitlines()
-            logging.debug(f"\n--- Retrieved Git Files from {repo.working_tree_dir} ---")
-            for file in files:
-                logging.debug(f"  - {file}")
-            logging.debug("--- End of Git Files ---\n")
-            return files
+            repo = Repo(self.repo_path, search_parent_directories=True)
+            repo_root = Path(repo.working_tree_dir).resolve()
+            git_files = repo.git.ls_files().splitlines()
+            self.logger.debug(f"Git files from {repo_root}: {git_files}")
+            git_files_relative = []
+            for f in git_files:
+                absolute_path = (repo_root / f).resolve()
+                try:
+                    relative_path = absolute_path.relative_to(self.repo_path)
+                    git_files_relative.append(relative_path)
+                except ValueError:
+                    # Skip files not under root_dir
+                    continue
+            return git_files_relative
         except InvalidGitRepositoryError:
-            logging.debug(f"Invalid Git repository at: {self.repo_path}")
+            self.logger.error(f"Invalid Git repository at: {self.repo_path}")
             return []

reposnap/core/markdown_generator.py

@@ -1,50 +1,31 @@
 # src/reposnap/core/markdown_generator.py
 
+import logging
 from pathlib import Path
 from ..utils.path_utils import format_tree
-import logging
-
 
 class MarkdownGenerator:
     def __init__(self, root_dir: Path, output_file: Path, structure_only: bool = False):
-        """
-        Initializes the MarkdownGenerator.
-
-        Args:
-            root_dir (Path): The root directory of the project.
-            output_file (Path): The path to the output Markdown file.
-            structure_only (bool): If True, only the directory structure is included without file contents.
-        """
         self.root_dir = root_dir.resolve()
         self.output_file = output_file.resolve()
         self.structure_only = structure_only
         self.logger = logging.getLogger(__name__)
-        self.logger.debug(f"Initialized MarkdownGenerator with root_dir={self.root_dir}, "
-                          f"output_file={self.output_file}, structure_only={self.structure_only}")
 
-    def generate_markdown(self, tree_structure: dict, git_files: list, spec=None):
+    def generate_markdown(self, tree_structure: dict, files: list):
         """
-        Generates the Markdown file based on the provided tree structure and git files.
+        Generates the Markdown file based on the provided tree structure and files.
 
         Args:
             tree_structure (dict): The hierarchical structure of the project files.
-            git_files (list): List of files tracked by Git.
-            spec (pathspec.PathSpec, optional): PathSpec object for file exclusion based on patterns.
+            files (list of Path): List of file paths to include in the markdown.
         """
-        self.logger.info("Starting Markdown generation.")
         self._write_header(tree_structure)
-
         if not self.structure_only:
-            self._write_file_contents(git_files, spec)
-
-        self.logger.info(f"Markdown file generated successfully at: {self.output_file}")
+            self._write_file_contents(files)
 
     def _write_header(self, tree_structure: dict):
         """
         Writes the header and project structure to the Markdown file.
-
-        Args:
-            tree_structure (dict): The hierarchical structure of the project files.
         """
         self.logger.debug("Writing Markdown header and project structure.")
         try:
@@ -59,64 +40,33 @@ class MarkdownGenerator:
             self.logger.error(f"Failed to write header to {self.output_file}: {e}")
             raise
 
-    def _write_file_contents(self, git_files: list, spec):
+    def _write_file_contents(self, files: list):
         """
-        Writes the contents of each file to the Markdown file, excluding those matching the spec.
+        Writes the contents of each file to the Markdown file.
 
         Args:
-            git_files (list): List of files tracked by Git.
-            spec (pathspec.PathSpec, optional): PathSpec object for file exclusion based on patterns.
+            files (list of Path): List of file paths relative to root_dir.
         """
         self.logger.debug("Writing file contents to Markdown.")
-        for file in git_files:
-            file_path = self._resolve_file_path(file)
+        for relative_path in files:
+            file_path = self.root_dir / relative_path
 
             if not file_path.exists():
                 self.logger.debug(f"File not found: {file_path}. Skipping.")
                 continue
 
-            relative_path = file_path.relative_to(self.root_dir).as_posix()
-            if spec and spec.match_file(relative_path):
-                self.logger.debug(f"File excluded by spec: {relative_path}. Skipping.")
-                continue
-
-            self.logger.debug(f"Processing file: {file_path}")
-            self._write_file_content(file_path, relative_path)
-
-    def _resolve_file_path(self, file: str) -> Path:
-        """
-        Resolves the absolute path of a file relative to the root directory.
-
-        Args:
-            file (str): The file path relative to the root directory.
-
-        Returns:
-            Path: The absolute path to the file.
-        """
-        resolved_path = self.root_dir / file
-        self.logger.debug(f"Resolved file path: {file} to {resolved_path}")
-        return resolved_path
+            self._write_file_content(file_path, relative_path.as_posix())
 
     def _write_file_content(self, file_path: Path, relative_path: str):
         """
         Writes the content of a single file to the Markdown file with syntax highlighting.
-
-        Args:
-            file_path (Path): The absolute path to the file.
-            relative_path (str): The file path relative to the root directory.
         """
         try:
-            print(f"Attempting to read file: {file_path}")
             with file_path.open('r', encoding='utf-8') as f:
                 content = f.read()
-                self.logger.debug(f"Read content from {file_path}")
-
             with self.output_file.open('a', encoding='utf-8') as f:
                 f.write(f"## {relative_path}\n\n")
                 f.write("```python\n" if file_path.suffix == '.py' else "```\n")
                 f.write(f"{content}\n```\n\n")
-                self.logger.debug(f"Wrote content of {relative_path} to Markdown.")
         except IOError as e:
             self.logger.error(f"Error reading or writing file {file_path}: {e}")
-        except Exception as e:
-            self.logger.error(f"Unexpected error processing file {file_path}: {e}")

reposnap/interfaces/cli.py

@@ -2,12 +2,14 @@
 
 import argparse
 import logging
+import os
 from reposnap.core.collector import ProjectContentCollector
+from pathlib import Path
 
 
 def main():
     parser = argparse.ArgumentParser(description='Generate a Markdown representation of a Git repository.')
-    parser.add_argument('path', help='Path to the Git repository.')
+    parser.add_argument('path', help='Path to the Git repository or subdirectory.')
     parser.add_argument('-o', '--output', help='Output Markdown file', default='output.md')
     parser.add_argument('--structure-only', action='store_true',
                         help='Only include the file structure without content.')
@@ -18,13 +20,27 @@ def main():
     log_level = logging.DEBUG if args.debug else logging.INFO
     logging.basicConfig(level=log_level, format='%(asctime)s - %(levelname)s - %(message)s')
 
-    with open(f"{args.path}/.gitignore", 'r') as gitignore:
-        patterns = gitignore.readlines()
-        logging.debug(f"Patterns from .gitignore in {args.path}: {patterns}")
-
-    collector = ProjectContentCollector(args.path, args.output, args.structure_only, patterns)
+    path = Path(args.path).resolve()
+    gitignore_path = path / '.gitignore'
+    if not gitignore_path.exists():
+        # Search for .gitignore in parent directories
+        for parent in path.parents:
+            gitignore_path = parent / '.gitignore'
+            if gitignore_path.exists():
+                break
+        else:
+            gitignore_path = None
+
+    if gitignore_path and gitignore_path.exists():
+        with gitignore_path.open('r') as gitignore:
+            patterns = gitignore.readlines()
+        logging.debug(f"Patterns from .gitignore in {gitignore_path.parent}: {patterns}")
+    else:
+        patterns = []
+        logging.debug(f"No .gitignore found starting from {args.path}. Proceeding without patterns.")
+
+    collector = ProjectContentCollector(str(path), args.output, args.structure_only, patterns)
     collector.collect_and_generate()
 
-
 if __name__ == "__main__":
     main()

{reposnap-0.2.3.dist-info → reposnap-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: reposnap
-Version: 0.2.3
+Version: 0.3.0
 Summary: Generate a Markdown file with all contents of your project
 Author: agoloborodko
 License-File: LICENSE
@@ -21,6 +21,19 @@ Description-Content-Type: text/markdown
 - **Syntax Highlighting**: Includes syntax highlighting for known file types in the generated Markdown file.
 - **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.
 
+## Installation
+```bash
+pip install reposnap
+```
+
+Alternatively, you can clone the repository and install the required dependencies:
+
+```bash
+git clone https://github.com/username/reposnap.git
+cd reposnap
+pip install -r requirements.lock
+```
+
 ## Usage
 
 ### Command-Line Interface
@@ -68,3 +81,8 @@ rye test
 ## License
 
 This project is licensed under the MIT License.
+
+## Acknowledgments
+
+- [GitPython](https://gitpython.readthedocs.io/) - Used for interacting with Git repositories.
+- [pathspec](https://pathspec.readthedocs.io/) - Used for pattern matching file paths.

reposnap-0.3.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+reposnap/__init__.py,sha256=FGadYKcWDEh_AL8PbUuUrcCZDlF510JZfdGhHdT6XQk,80
+reposnap/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+reposnap/core/collector.py,sha256=UQNAaIqgALZmOvtSb7NDYaXmVp4-X4jSWikMMh_B0YY,2401
+reposnap/core/file_system.py,sha256=yFIaHtJYqw5t8Lx9Nu7yb3G7XcCP1v1aKP_hGfS_KfQ,974
+reposnap/core/git_repo.py,sha256=A8mdgmT9JGHllkFMx5Z_1gGp3Yw1dr-NFOw2-lH_DfA,1163
+reposnap/core/markdown_generator.py,sha256=vJl_ac3vDs4CEanjwQazQM9fepGeFtGxo3ozajdkhqA,2889
+reposnap/interfaces/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+reposnap/interfaces/cli.py,sha256=bU7QAg2wDzQwyAsRyq4zHLnO8nNiJGrWD24n7yZFEZk,1795
+reposnap/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+reposnap/utils/path_utils.py,sha256=lMuZMMIX2lEE1o6V3QqifmyO5dO5fuA5OUXMxSvYcHI,290
+reposnap-0.3.0.dist-info/METADATA,sha256=hcDKEinduZiYYDMrl5NsYkv0qz0H3EG-Ls_LfU01WGE,2329
+reposnap-0.3.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+reposnap-0.3.0.dist-info/entry_points.txt,sha256=aaCuB0RZOLW2--ymW8VCEOm0Qz9KvTZCUjwQFZsGaDU,43
+reposnap-0.3.0.dist-info/licenses/LICENSE,sha256=Aj7WCYBXi98pvi723HPn4GDRyjxToNWb3PC6j1_lnPk,1069
+reposnap-0.3.0.dist-info/RECORD,,

reposnap-0.2.3.dist-info/RECORD

@@ -1,15 +0,0 @@
-reposnap/__init__.py,sha256=FGadYKcWDEh_AL8PbUuUrcCZDlF510JZfdGhHdT6XQk,80
-reposnap/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reposnap/core/collector.py,sha256=TY42k2pN8B9vpuop_g6Dj5PACnr6ncpCYs3b08P1Rog,1253
-reposnap/core/file_system.py,sha256=X3JdnClpNUqbz_Taj6G3GIozk63wpQ_nG3Jd0yNpxsY,886
-reposnap/core/git_repo.py,sha256=Zx6DU87KuKAD-0JcKKqcb0OK1glzKMdS_przDlP4ZV0,707
-reposnap/core/markdown_generator.py,sha256=dcQYDMyhZXjz1DY9e1zMsVS_dDGRVPm9f31Ug0QHANc,5126
-reposnap/interfaces/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reposnap/interfaces/cli.py,sha256=3bfyVpVNN5LiuxJ2UxUIpIdNugy75mLpuE-cgjI2J3I,1186
-reposnap/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reposnap/utils/path_utils.py,sha256=lMuZMMIX2lEE1o6V3QqifmyO5dO5fuA5OUXMxSvYcHI,290
-reposnap-0.2.3.dist-info/METADATA,sha256=xVxeCfhyFfeIvkm9n0w36x0jIOLtS6fjzh8XvojwRfA,1883
-reposnap-0.2.3.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-reposnap-0.2.3.dist-info/entry_points.txt,sha256=aaCuB0RZOLW2--ymW8VCEOm0Qz9KvTZCUjwQFZsGaDU,43
-reposnap-0.2.3.dist-info/licenses/LICENSE,sha256=Aj7WCYBXi98pvi723HPn4GDRyjxToNWb3PC6j1_lnPk,1069
-reposnap-0.2.3.dist-info/RECORD,,