snap2txt 0.2.2__tar.gz

snap2txt-0.2.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Sérgio Vorniches
+
+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.

snap2txt-0.2.2/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: snap2txt
+Version: 0.2.2
+Summary: A tool to save project structure and contents to a text file
+Home-page: https://github.com/vorniches/snap2txt
+Author: Sergei Vorniches
+Author-email: vorniches@gmail.com
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary
+
+# Snap2Txt
+
+Snap2Txt is a Python utility that captures the structure and contents of a project directory and saves them into a text file. It's designed for quick documentation of your project's file system.
+
+## Features
+
+- **Complete Capture**: Records the entire file structure and contents of the project.
+- **Customizable Filters**: Offers ignore and whitelist options for targeted scanning.
+- **Command-Line Interface**: Simple and easy-to-use command-line tool.
+
+## Installation
+
+Install Snap2Txt with pip:
+
+```bash
+pip install snap2txt
+```
+
+> **Note**: The installation now automatically provides `.il` and `.wl` files along with the package.
+
+## Usage
+
+Navigate to your project directory and run:
+
+```bash
+snap2txt
+```
+
+By default, Snap2Txt will scan all files and directories in the current folder and produce an output file called `project_contents.txt`.
+
+### Locate the .il and .wl Files
+
+If you need to see where Snap2Txt’s `.il` and `.wl` files were installed on your system (e.g., to customize them), run:
+
+```bash
+snap2txt --show-locations
+```
+
+This will print the full path to each file, so you can open or edit them as needed.
+
+### Optional Flags
+
+- `--il`: Use ignore list defined in `.il`.
+- `--wl`: Use whitelist defined in `.wl`.
+
+Example:
+
+```bash
+snap2txt --il
+```
+
+```bash
+snap2txt --wl
+```
+
+## Configuration
+
+Snap2Txt respects two files for filtering:
+
+1. **Ignore List (`.il`)**: Exclude certain files/directories.
+2. **Whitelist (`.wl`)**: Include only certain files/directories.
+
+By default, Snap2Txt installs a basic `.il` and `.wl` in the package directory. To tailor the behavior for your project, you can edit those files or replace them with your own custom rules.
+
+> **Tip**: To quickly locate where these files were installed, use `snap2txt --show-locations`.
+
+### Example `.il` File
+
+```text
+node_modules/
+*.log
+```
+
+### Example `.wl` File
+
+```text
+*.py
+*.md
+```
+
+## Contributing
+
+Contributions to Snap2Txt are welcome! Feel free to fork the repository, make your changes, and submit a pull request.
+
+## License
+
+Snap2Txt is open-sourced software licensed under the [MIT license](LICENSE).
+
+## Support
+
+For support, questions, or feedback, please [open an issue](https://github.com/vorniches/snap2txt/issues) in the GitHub repository.

snap2txt-0.2.2/README.md

@@ -0,0 +1,91 @@
+# Snap2Txt
+
+Snap2Txt is a Python utility that captures the structure and contents of a project directory and saves them into a text file. It's designed for quick documentation of your project's file system.
+
+## Features
+
+- **Complete Capture**: Records the entire file structure and contents of the project.
+- **Customizable Filters**: Offers ignore and whitelist options for targeted scanning.
+- **Command-Line Interface**: Simple and easy-to-use command-line tool.
+
+## Installation
+
+Install Snap2Txt with pip:
+
+```bash
+pip install snap2txt
+```
+
+> **Note**: The installation now automatically provides `.il` and `.wl` files along with the package.
+
+## Usage
+
+Navigate to your project directory and run:
+
+```bash
+snap2txt
+```
+
+By default, Snap2Txt will scan all files and directories in the current folder and produce an output file called `project_contents.txt`.
+
+### Locate the .il and .wl Files
+
+If you need to see where Snap2Txt’s `.il` and `.wl` files were installed on your system (e.g., to customize them), run:
+
+```bash
+snap2txt --show-locations
+```
+
+This will print the full path to each file, so you can open or edit them as needed.
+
+### Optional Flags
+
+- `--il`: Use ignore list defined in `.il`.
+- `--wl`: Use whitelist defined in `.wl`.
+
+Example:
+
+```bash
+snap2txt --il
+```
+
+```bash
+snap2txt --wl
+```
+
+## Configuration
+
+Snap2Txt respects two files for filtering:
+
+1. **Ignore List (`.il`)**: Exclude certain files/directories.
+2. **Whitelist (`.wl`)**: Include only certain files/directories.
+
+By default, Snap2Txt installs a basic `.il` and `.wl` in the package directory. To tailor the behavior for your project, you can edit those files or replace them with your own custom rules.
+
+> **Tip**: To quickly locate where these files were installed, use `snap2txt --show-locations`.
+
+### Example `.il` File
+
+```text
+node_modules/
+*.log
+```
+
+### Example `.wl` File
+
+```text
+*.py
+*.md
+```
+
+## Contributing
+
+Contributions to Snap2Txt are welcome! Feel free to fork the repository, make your changes, and submit a pull request.
+
+## License
+
+Snap2Txt is open-sourced software licensed under the [MIT license](LICENSE).
+
+## Support
+
+For support, questions, or feedback, please [open an issue](https://github.com/vorniches/snap2txt/issues) in the GitHub repository.

snap2txt-0.2.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

snap2txt-0.2.2/setup.py

@@ -0,0 +1,31 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='snap2txt',
+    version='0.2.2',
+    packages=find_packages(),
+    entry_points={
+        'console_scripts': [
+            'snap2txt = snap2txt.__main__:main'
+        ]
+    },
+    include_package_data=True,
+    package_data={
+        'snap2txt': ['.il', '.wl'],
+    },
+    author='Sergei Vorniches',
+    author_email='vorniches@gmail.com',
+    description='A tool to save project structure and contents to a text file',
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
+    url='https://github.com/vorniches/snap2txt',
+    license='MIT',
+    install_requires=[
+    ],
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+    ],
+    python_requires='>=3.6',
+)

snap2txt-0.2.2/snap2txt/.il

@@ -0,0 +1,10 @@
+.DS_Store
+Dockerfile
+db.sqlite3
+docker-compose.yml
+project_contents.txt
+requirements.txt
+__init__.py
+.devcontainer
+__pycache__
+vendors

snap2txt-0.2.2/snap2txt/__main__.py

@@ -0,0 +1,5 @@
+# snap2txt/__main__.py
+from snap2txt.saver import main
+
+if __name__ == '__main__':
+    main()

snap2txt-0.2.2/snap2txt/saver.py

@@ -0,0 +1,188 @@
+import os
+import sys
+import argparse
+import fnmatch
+
+def read_list_file(file_path):
+    """
+    Read a list file (.il or .wl) and return the list of patterns.
+    """
+    try:
+        with open(file_path, 'r') as file:
+            return [line.strip() for line in file if line.strip()]
+    except FileNotFoundError:
+        print(f"List file not found: {file_path}")
+        return []
+
+def match_pattern(path, patterns, is_dir=False):
+    """
+    Check if a given path matches any of the patterns in the list.
+    Supports:
+    - Folder patterns ending with / (e.g., "node_modules/")
+    - File extension patterns (e.g., "*.css", ".jpg")
+    - Wildcards (e.g., "test*.js")
+    - Full path patterns (e.g., "lib/realtime-client.ts")
+    - Exact names (e.g., "package.json")
+    - Substring patterns (e.g., "__pycache__")
+    """
+    if not patterns:
+        return False
+    
+    # Normalize path separators
+    path = path.replace("\\", "/")
+    path_parts = path.split("/")
+    basename = os.path.basename(path)
+    
+    for pattern in patterns:
+        # Normalize pattern
+        pattern = pattern.replace("\\", "/")
+        
+        # Pattern for directories (ends with /)
+        if pattern.endswith("/"):
+            dir_pattern = pattern.rstrip("/")
+            if is_dir:
+                # Check if any part of the path matches the directory name
+                if dir_pattern in path_parts or basename == dir_pattern:
+                    return True
+            else:
+                # For files, check if any parent directory matches
+                if dir_pattern in path_parts:
+                    return True
+        
+        # Pattern for file extensions (e.g., ".css", "*.css")
+        elif pattern.startswith("*."):
+            ext = pattern[1:]  # Remove the *
+            if basename.endswith(ext):
+                return True
+        
+        elif pattern.startswith(".") and not pattern.startswith("./"):
+            # Extension pattern like ".css"
+            if basename.endswith(pattern):
+                return True
+        
+        # Wildcard pattern (e.g., "test*.js")
+        elif "*" in pattern:
+            if fnmatch.fnmatch(basename, pattern):
+                return True
+        
+        # Full path match (e.g., "lib/realtime-client.ts")
+        elif "/" in pattern:
+            if pattern == path or path.endswith("/" + pattern):
+                return True
+        
+        # Exact basename match
+        elif pattern == basename:
+            return True
+        
+        # Substring match in path parts (for patterns like "__pycache__")
+        elif pattern in path_parts:
+            return True
+    
+    return False
+
+def should_include_path(path, is_dir, ignore_list, whitelist, whitelist_mode):
+    """
+    Determine if a path should be included based on ignore list and whitelist.
+    
+    Args:
+        path: The file or directory path
+        is_dir: Whether the path is a directory
+        ignore_list: List of patterns to ignore
+        whitelist: List of patterns to include
+        whitelist_mode: If True, ONLY include whitelisted items (ignore ignore_list)
+    
+    Returns:
+        True if the path should be included, False otherwise
+    """
+    if whitelist_mode:
+        # In whitelist mode, ONLY include items that match the whitelist
+        return match_pattern(path, whitelist, is_dir)
+    else:
+        # In normal mode, include everything except ignored items
+        # If whitelist exists in non-whitelist mode, it acts as an additional filter
+        if ignore_list and match_pattern(path, ignore_list, is_dir):
+            return False
+        if whitelist and not match_pattern(path, whitelist, is_dir):
+            return False
+        return True
+
+def save_project_structure_and_files(root_path, output_file, ignore_list=None, whitelist=None, whitelist_mode=False):
+    """
+    Save the project structure and contents of all files in the project to a text file,
+    considering ignore and whitelist.
+    
+    Args:
+        root_path: The root directory to scan
+        output_file: The output file path
+        ignore_list: List of patterns to ignore
+        whitelist: List of patterns to include
+        whitelist_mode: If True, ONLY include whitelisted items (ignore ignore_list)
+    """
+    project_structure = []
+    file_contents = []
+
+    for root, dirs, files in os.walk(root_path):
+        rel_dir = os.path.relpath(root, root_path)
+        
+        # Filter directories
+        # In whitelist mode, traverse all directories but only filter files
+        # In normal mode, filter directories to avoid traversing ignored ones
+        if not whitelist_mode:
+            filtered_dirs = []
+            for d in dirs:
+                dir_path = os.path.join(rel_dir, d) if rel_dir != "." else d
+                if should_include_path(dir_path, True, ignore_list, whitelist, whitelist_mode):
+                    filtered_dirs.append(d)
+            dirs[:] = filtered_dirs
+        
+        # Filter and process files
+        for file in files:
+            file_path = os.path.join(rel_dir, file) if rel_dir != "." else file
+            
+            if should_include_path(file_path, False, ignore_list, whitelist, whitelist_mode):
+                rel_file = file_path.replace("\\", "/")
+                project_structure.append(rel_file)
+
+                try:
+                    with open(os.path.join(root, file), 'r', encoding='utf-8') as f:
+                        content = f.read()
+                    file_contents.append(f"{file}:\n```\n{content}\n```\n")
+                except Exception as e:
+                    file_contents.append(f"{file}:\n```\nError reading file: {e}\n```\n")
+
+    with open(output_file, 'w', encoding='utf-8') as f:
+        f.write("Project Structure:\n")
+        f.write("\n".join(project_structure) + "\n\n")
+        f.write("File Contents:\n")
+        f.write("\n".join(file_contents))
+    
+    print(f"Project contents saved to {output_file}")
+    print(f"Total files collected: {len(project_structure)}")
+
+def main():
+    script_dir = os.path.dirname(__file__)
+    il_file = os.path.join(script_dir, '.il')
+    wl_file = os.path.join(script_dir, '.wl')
+
+    parser = argparse.ArgumentParser(description="Save project structure and file contents.")
+    parser.add_argument("--il", help="Use ignore list (.il file)", action="store_true")
+    parser.add_argument("--wl", help="Use whitelist (.wl file) - ONLY collect whitelisted items", action="store_true")
+    parser.add_argument("--show-locations", help="Show the location of the .il and .wl files", action="store_true")
+
+    args = parser.parse_args()
+
+    if args.show_locations:
+        print("IL file is located at:", il_file)
+        print("WL file is located at:", wl_file)
+        sys.exit(0)
+
+    ignore_list = read_list_file(il_file) if args.il else None
+    whitelist = read_list_file(wl_file) if args.wl else None
+    
+    # Whitelist mode: when --wl is used, ONLY collect whitelisted items
+    whitelist_mode = args.wl
+
+    save_project_structure_and_files('.', 'project_contents.txt', ignore_list, whitelist, whitelist_mode)
+
+if __name__ == '__main__':
+    main()

snap2txt-0.2.2/snap2txt.egg-info/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: snap2txt
+Version: 0.2.2
+Summary: A tool to save project structure and contents to a text file
+Home-page: https://github.com/vorniches/snap2txt
+Author: Sergei Vorniches
+Author-email: vorniches@gmail.com
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary
+
+# Snap2Txt
+
+Snap2Txt is a Python utility that captures the structure and contents of a project directory and saves them into a text file. It's designed for quick documentation of your project's file system.
+
+## Features
+
+- **Complete Capture**: Records the entire file structure and contents of the project.
+- **Customizable Filters**: Offers ignore and whitelist options for targeted scanning.
+- **Command-Line Interface**: Simple and easy-to-use command-line tool.
+
+## Installation
+
+Install Snap2Txt with pip:
+
+```bash
+pip install snap2txt
+```
+
+> **Note**: The installation now automatically provides `.il` and `.wl` files along with the package.
+
+## Usage
+
+Navigate to your project directory and run:
+
+```bash
+snap2txt
+```
+
+By default, Snap2Txt will scan all files and directories in the current folder and produce an output file called `project_contents.txt`.
+
+### Locate the .il and .wl Files
+
+If you need to see where Snap2Txt’s `.il` and `.wl` files were installed on your system (e.g., to customize them), run:
+
+```bash
+snap2txt --show-locations
+```
+
+This will print the full path to each file, so you can open or edit them as needed.
+
+### Optional Flags
+
+- `--il`: Use ignore list defined in `.il`.
+- `--wl`: Use whitelist defined in `.wl`.
+
+Example:
+
+```bash
+snap2txt --il
+```
+
+```bash
+snap2txt --wl
+```
+
+## Configuration
+
+Snap2Txt respects two files for filtering:
+
+1. **Ignore List (`.il`)**: Exclude certain files/directories.
+2. **Whitelist (`.wl`)**: Include only certain files/directories.
+
+By default, Snap2Txt installs a basic `.il` and `.wl` in the package directory. To tailor the behavior for your project, you can edit those files or replace them with your own custom rules.
+
+> **Tip**: To quickly locate where these files were installed, use `snap2txt --show-locations`.
+
+### Example `.il` File
+
+```text
+node_modules/
+*.log
+```
+
+### Example `.wl` File
+
+```text
+*.py
+*.md
+```
+
+## Contributing
+
+Contributions to Snap2Txt are welcome! Feel free to fork the repository, make your changes, and submit a pull request.
+
+## License
+
+Snap2Txt is open-sourced software licensed under the [MIT license](LICENSE).
+
+## Support
+
+For support, questions, or feedback, please [open an issue](https://github.com/vorniches/snap2txt/issues) in the GitHub repository.

snap2txt-0.2.2/snap2txt.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+setup.py
+snap2txt/.il
+snap2txt/.wl
+snap2txt/__init__.py
+snap2txt/__main__.py
+snap2txt/saver.py
+snap2txt.egg-info/PKG-INFO
+snap2txt.egg-info/SOURCES.txt
+snap2txt.egg-info/dependency_links.txt
+snap2txt.egg-info/entry_points.txt
+snap2txt.egg-info/top_level.txt

snap2txt-0.2.2/snap2txt.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

snap2txt-0.2.2/snap2txt.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+snap2txt = snap2txt.__main__:main

snap2txt-0.2.2/snap2txt.egg-info/top_level.txt

@@ -0,0 +1 @@
+snap2txt