reposnap 0.2.0__py3-none-any.whl

reposnap/core/collector.py

@@ -0,0 +1,21 @@
+# src/reposnap/core/collector.py
+
+from .file_system import FileSystem
+from .git_repo import GitRepo
+from .markdown_generator import MarkdownGenerator
+import pathspec
+
+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.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()
+
+    def collect_and_generate(self):
+        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)

reposnap/core/file_system.py

@@ -0,0 +1,19 @@
+# src/reposnap/core/file_system.py
+
+from pathlib import Path
+
+class FileSystem:
+    def __init__(self, root_dir: str):
+        self.root_dir = Path(root_dir).resolve()
+
+    def build_tree_structure(self, files):
+        tree = {}
+        for file in files:
+            file_path = Path(file).resolve()
+            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
+        return tree

reposnap/core/git_repo.py

@@ -0,0 +1,14 @@
+# src/reposnap/core/git_repo.py
+
+from git import Repo, InvalidGitRepositoryError
+
+class GitRepo:
+    def __init__(self, repo_path: str):
+        self.repo_path = repo_path
+
+    def get_git_files(self):
+        try:
+            repo = Repo(self.repo_path)
+            return repo.git.ls_files().splitlines()
+        except InvalidGitRepositoryError:
+            return []

reposnap/core/markdown_generator.py

@@ -0,0 +1,24 @@
+# src/reposnap/core/markdown_generator.py
+
+from pathlib import Path
+from ..utils.path_utils import format_tree
+
+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}")

reposnap/interfaces/cli.py

@@ -0,0 +1,21 @@
+# src/reposnap/interfaces/cli.py
+
+import argparse
+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.')
+    args = parser.parse_args()
+
+    with open(f"{args.path}/.gitignore", 'r') as gitignore:
+        patterns = gitignore.readlines()
+
+    collector = ProjectContentCollector(args.path, args.output, args.structure_only, patterns)
+    collector.collect_and_generate()
+
+if __name__ == "__main__":
+    main()

reposnap/utils/path_utils.py

@@ -0,0 +1,9 @@
+# src/reposnap/utils/path_utils.py
+
+def format_tree(tree, indent=''):
+    for key, value in tree.items():
+        if isinstance(value, dict):
+            yield f"{indent}{key}/\n"
+            yield from format_tree(value, indent + '    ')
+        else:
+            yield f"{indent}{key}\n"

reposnap-0.2.0.dist-info/METADATA

@@ -0,0 +1,91 @@
+Metadata-Version: 2.3
+Name: reposnap
+Version: 0.2.0
+Summary: Generate a Markdown file with all contents of your project
+Author: agoloborodko
+License-File: LICENSE
+Requires-Python: >=3.8
+Requires-Dist: gitpython>=3.1.43
+Requires-Dist: pathlib>=1.0.1
+Requires-Dist: pathspec>=0.12.1
+Description-Content-Type: text/markdown
+
+# RepoSnap
+
+## Overview
+
+`reposnap` is a Python script designed to generate a Markdown file that documents the structure and contents of a git project. This tool is particularly useful for creating a quick overview of a project's file hierarchy, including optional syntax-highlighted code snippets.
+
+## 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.
+
+## Usage
+
+### Command-Line Interface
+
+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]
+```
+
+- `<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.
+- `--structure-only`: Generate a Markdown file that includes only the project structure, without file contents.
+
+### Examples
+
+1. **Generate a full project structure with file contents**:
+
+    ```bash
+    python -m collect my_project/
+    ```
+
+2. **Generate a project structure only**:
+
+    ```bash
+    python -m collect 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
+    ```
+
+## 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.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+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,,

reposnap-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.25.0
+Root-Is-Purelib: true
+Tag: py3-none-any

reposnap-0.2.0.dist-info/licenses/LICENSE

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