reposnap 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

reposnap/core/collector.py

@@ -4,18 +4,27 @@ from .file_system import FileSystem
 from .git_repo import GitRepo
 from .markdown_generator import MarkdownGenerator
 import pathspec
+import logging
+from pathlib import Path
+
 
 class ProjectContentCollector:
     def __init__(self, root_dir: str, output_file: str, structure_only: bool, gitignore_patterns: list):
-        self.root_dir = root_dir
-        self.output_file = output_file
+        self.root_dir = Path(root_dir).resolve()
+        self.output_file = Path(output_file).resolve()
         self.structure_only = structure_only
         self.spec = pathspec.PathSpec.from_lines(pathspec.patterns.GitWildMatchPattern, gitignore_patterns)
-        self.file_system = FileSystem(root_dir)
-        self.git_repo = GitRepo(root_dir)
-        self.markdown_generator = MarkdownGenerator()
+        self.file_system = FileSystem(self.root_dir)
+        self.git_repo = GitRepo(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.")
         git_files = self.git_repo.get_git_files()
         tree_structure = self.file_system.build_tree_structure(git_files)
-        self.markdown_generator.generate_markdown(self.output_file, tree_structure, git_files, self.spec, self.structure_only)
+        self.markdown_generator.generate_markdown(tree_structure, git_files, self.spec)

reposnap/core/file_system.py

@@ -1,5 +1,6 @@
 # src/reposnap/core/file_system.py
 
+import logging
 from pathlib import Path
 
 class FileSystem:
@@ -8,12 +9,15 @@ class FileSystem:
 
     def build_tree_structure(self, files):
         tree = {}
+        logging.debug("\n>>> Processing Files for Tree Structure <<<")
         for file in files:
-            file_path = Path(file).resolve()
+            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('/')
             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")
         return tree

reposnap/core/git_repo.py

@@ -1,5 +1,6 @@
 # src/reposnap/core/git_repo.py
 
+import logging
 from git import Repo, InvalidGitRepositoryError
 
 class GitRepo:
@@ -9,6 +10,12 @@ class GitRepo:
     def get_git_files(self):
         try:
             repo = Repo(self.repo_path)
-            return repo.git.ls_files().splitlines()
+            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
         except InvalidGitRepositoryError:
+            logging.debug(f"Invalid Git repository at: {self.repo_path}")
             return []

reposnap/core/markdown_generator.py

@@ -2,23 +2,121 @@
 
 from pathlib import Path
 from ..utils.path_utils import format_tree
+import logging
+
 
 class MarkdownGenerator:
-    def generate_markdown(self, output_file, tree_structure, git_files, spec, structure_only=False):
-        with open(output_file, 'w') as f:
-            f.write("# Project Structure\n\n")
-            f.write("```\n")
-            for line in format_tree(tree_structure):
-                f.write(line)
-            f.write("```\n\n")
-
-            if not structure_only:
-                for file in git_files:
-                    relative_path = Path(file).relative_to(Path(output_file).parent).as_posix()
-                    if spec and not spec.match_file(relative_path):
-                        # Only read the file if spec is not None and does not match
-                        with open(Path(output_file).parent / file, 'r') as file_content:
-                            f.write(f"## {relative_path}\n\n")
-                            f.write(f"```\n{file_content.read()}\n```\n\n")
-
-        print(f"Markdown file generated: {output_file}")
+    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):
+        """
+        Generates the Markdown file based on the provided tree structure and git 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.
+        """
+        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}")
+
+    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:
+            with self.output_file.open('w', encoding='utf-8') as f:
+                f.write("# Project Structure\n\n")
+                f.write("```\n")
+                for line in format_tree(tree_structure):
+                    f.write(line)
+                f.write("```\n\n")
+            self.logger.debug("Header and project structure written successfully.")
+        except IOError as e:
+            self.logger.error(f"Failed to write header to {self.output_file}: {e}")
+            raise
+
+    def _write_file_contents(self, git_files: list, spec):
+        """
+        Writes the contents of each file to the Markdown file, excluding those matching the spec.
+
+        Args:
+            git_files (list): List of files tracked by Git.
+            spec (pathspec.PathSpec, optional): PathSpec object for file exclusion based on patterns.
+        """
+        self.logger.debug("Writing file contents to Markdown.")
+        for file in git_files:
+            file_path = self._resolve_file_path(file)
+
+            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
+
+    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

@@ -1,21 +1,30 @@
 # src/reposnap/interfaces/cli.py
 
 import argparse
+import logging
 from reposnap.core.collector import ProjectContentCollector
 
+
 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('-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.')
+    parser.add_argument('--debug', action='store_true', help='Enable debug-level logging.')
+
     args = parser.parse_args()
 
+    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)
     collector.collect_and_generate()
 
+
 if __name__ == "__main__":
     main()

{reposnap-0.2.0.dist-info → reposnap-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: reposnap
-Version: 0.2.0
+Version: 0.2.2
 Summary: Generate a Markdown file with all contents of your project
 Author: agoloborodko
 License-File: LICENSE
@@ -18,8 +18,6 @@ Description-Content-Type: text/markdown
 
 ## Features
 
-- **Recursive Directory Traversal**: Automatically traverses through all subdirectories of the specified project root.
-- **File Exclusion**: Supports excluding specific files and directories using patterns similar to `.gitignore`.
 - **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.
 
@@ -30,62 +28,43 @@ Description-Content-Type: text/markdown
 To use the `collect.py` script, run it with the following options:
 
 ```bash
-python -m collect <project_root> [-o OUTPUT] [-e EXCLUDE ...] [-x EXCLUDE_FILE] [--structure-only]
+reposnap [-h] [-o OUTPUT] [--structure-only] [--debug] path
 ```
 
-- `<project_root>`: The root directory of the project to document.
-- `-o, --output`: The name of the output Markdown file. Defaults to `repo-content-<timestamp>.md`.
-- `-e, --exclude`: Patterns of files or directories to exclude (supports multiple patterns).
-- `-x, --exclude-file`: A file (e.g., `.gitignore`) containing patterns of files or directories to exclude.
+- `path`: Path to the Git repository root folder
+- `-h, --help`: show help message and exit
+- `-o, --output`: The name of the output Markdown file. Defaults to `output.md`.
 - `--structure-only`: Generate a Markdown file that includes only the project structure, without file contents.
+- `--debug`: Enable debug-level logging.
 
 ### Examples
 
 1. **Generate a full project structure with file contents**:
 
     ```bash
-    python -m collect my_project/
+    reposnap my_project/
     ```
 
 2. **Generate a project structure only**:
 
     ```bash
-    python -m collect my_project/ --structure-only
+    reposnap my_project/ --structure-only
     ```
 
 3. **Generate a Markdown file excluding certain files and directories**:
 
     ```bash
-    python -m collect my_project/ -e '*.log' -e 'build/' -o output.md
-    ```
-
-4. **Use exclusion patterns from a `.gitignore` file**:
-
-    ```bash
-    python -m collect my_project/ -x .gitignore
+    reposnap my_project/ -o output.md
     ```
 
 ## Testing
 
-This project includes unit tests to ensure the correctness of the code:
-
-- **`test_collect.py`**: Tests the `file_extension_to_language` function, verifying that file extensions are correctly mapped to programming languages for syntax highlighting in the Markdown file.
-- **`test_cli.py`**: Tests the command-line interface of the `collect.py` script, including the `--structure-only` flag.
-
-### Running the Tests
-
 To run the tests, use `rye`:
 
 ```bash
 rye test
 ```
 
-This will execute all test cases and provide a summary of the results.
-
-## Dependencies
-
-This project uses standard Python libraries and does not require any external dependencies. 
-
 ## License
 
 This project is licensed under the MIT License.

reposnap-0.2.2.dist-info/RECORD

@@ -0,0 +1,15 @@
+reposnap/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+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.2.dist-info/METADATA,sha256=2ESL-1HA7WntV5eeyvT7yBjHAQ9kRvYN2gFZjsV7iak,1906
+reposnap-0.2.2.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+reposnap-0.2.2.dist-info/entry_points.txt,sha256=EBQ8Fn4zZuWJPPddf_m1LnObGFfcb5OgWeZqzw0O_EE,42
+reposnap-0.2.2.dist-info/licenses/LICENSE,sha256=Aj7WCYBXi98pvi723HPn4GDRyjxToNWb3PC6j1_lnPk,1069
+reposnap-0.2.2.dist-info/RECORD,,

reposnap-0.2.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+reposnap = collect:main

reposnap-0.2.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-reposnap/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reposnap/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reposnap/core/collector.py,sha256=R9G7kEjnDNqJ4FztBZq1pl7bKni9T17z27qcaYFLty0,960
-reposnap/core/file_system.py,sha256=ICz0B4MswDlCCuLJzE7LRuLeiH-kFmsxqSnDrqRTULY,632
-reposnap/core/git_repo.py,sha256=JYuYnjAg_LBTd5cEXUZnbSiMXisH6JFcr8Ix4od6qCo,371
-reposnap/core/markdown_generator.py,sha256=xgShE2o5d77_U5MNczrYrWiM5K8YHqmvHy7LcYDx0Ro,1079
-reposnap/interfaces/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reposnap/interfaces/cli.py,sha256=qF25C579BM2wF1fj2D7EEt7siVhztMZFGJknMSCdgXo,842
-reposnap/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reposnap/utils/path_utils.py,sha256=lMuZMMIX2lEE1o6V3QqifmyO5dO5fuA5OUXMxSvYcHI,290
-reposnap-0.2.0.dist-info/METADATA,sha256=sUNQzLumZjTvvP1-N2buQKj4_a6OfXBwpvQUPBfsgk4,3103
-reposnap-0.2.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-reposnap-0.2.0.dist-info/licenses/LICENSE,sha256=Aj7WCYBXi98pvi723HPn4GDRyjxToNWb3PC6j1_lnPk,1069
-reposnap-0.2.0.dist-info/RECORD,,