snap2txt 0.1.0__tar.gz

snap2txt-0.1.0/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.1.0/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.1
+Name: snap2txt
+Version: 0.1.0
+Summary: A tool to save project structure and contents to a text file
+Home-page: https://github.com/vorniches/snap2txt
+Author: Sérgio 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
+
+# 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
+```
+
+## Usage
+
+Navigate to your project directory and run:
+
+```bash
+snap2txt
+```
+
+### Optional Flags
+
+- `--il`: Use an ignore list from a `.il` file.
+- `--wl`: Use a whitelist from a `.wl` file.
+
+## Configuration
+
+Create `.il` and `.wl` files in your project directory to specify patterns to ignore or include, respectively.
+
+### 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/yourusername/snap2txt/issues) in the GitHub repository.

snap2txt-0.1.0/README.md

@@ -0,0 +1,60 @@
+# 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
+```
+
+## Usage
+
+Navigate to your project directory and run:
+
+```bash
+snap2txt
+```
+
+### Optional Flags
+
+- `--il`: Use an ignore list from a `.il` file.
+- `--wl`: Use a whitelist from a `.wl` file.
+
+## Configuration
+
+Create `.il` and `.wl` files in your project directory to specify patterns to ignore or include, respectively.
+
+### 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/yourusername/snap2txt/issues) in the GitHub repository.

snap2txt-0.1.0/setup.cfg

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

snap2txt-0.1.0/setup.py

@@ -0,0 +1,33 @@
+# setup.py
+from setuptools import setup, find_packages
+
+setup(
+    name='snap2txt',
+    version='0.1.0',
+    packages=find_packages(),
+    entry_points={
+        'console_scripts': [
+            'snap2txt = snap2txt.__main__:main'
+        ]
+    },
+    # Add additional information like author, description, requirements, etc.
+    author='Sérgio 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=[
+        # List any Python package dependencies here
+        # e.g., 'requests>=2.25.1'
+    ],
+    classifiers=[
+        # Trove classifiers
+        # Full list at https://pypi.org/classifiers/
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+    ],
+    python_requires='>=3.6',
+)

snap2txt-0.1.0/snap2txt/__main__.py

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

snap2txt-0.1.0/snap2txt/saver.py

@@ -0,0 +1,84 @@
+import os
+import sys
+import argparse
+
+def read_list_file(file_path):
+    """
+    Read a list file (.il or .wl) and return the list of patterns.
+
+    :param file_path: Path to the list file.
+    :return: A 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):
+    """
+    Check if a given path matches any of the patterns in the list.
+
+    :param path: The file or directory path.
+    :param patterns: A list of patterns to match against.
+    :return: True if path matches any pattern, False otherwise.
+    """
+    for pattern in patterns:
+        if pattern in path:
+            return True
+    return False
+
+def save_project_structure_and_files(root_path, output_file, ignore_list=None, whitelist=None):
+    """
+    Save the project structure and contents of all files in the project to a text file,
+    considering ignore and whitelist.
+
+    :param root_path: Root directory of the project.
+    :param output_file: Path to the output text file.
+    :param ignore_list: List of patterns to ignore.
+    :param whitelist: List of patterns to include.
+    """
+    project_structure = []
+    file_contents = []
+
+    for root, dirs, files in os.walk(root_path):
+        # Filter directories and files based on ignore_list and whitelist
+        dirs[:] = [d for d in dirs if not match_pattern(d, ignore_list or []) and (not whitelist or match_pattern(d, whitelist))]
+        files = [f for f in files if not match_pattern(f, ignore_list or []) and (not whitelist or match_pattern(f, whitelist))]
+
+        for file in files:
+            rel_dir = os.path.relpath(root, root_path)
+            rel_file = os.path.join(rel_dir, file)
+            project_structure.append(rel_file.replace("\\", "/"))
+
+            try:
+                with open(os.path.join(root, file), 'r') 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') 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))
+
+def main():
+    script_dir = os.path.dirname(__file__)  # Get the directory where the script is located
+    il_file = os.path.join(script_dir, '.il')  # Path to .il file
+    wl_file = os.path.join(script_dir, '.wl')  # Path to .wl file
+
+    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)", action="store_true")
+    args = parser.parse_args()
+
+    ignore_list = read_list_file(il_file) if args.il else None
+    whitelist = read_list_file(wl_file) if args.wl else None
+
+    save_project_structure_and_files('.', 'project_contents.txt', ignore_list, whitelist)
+
+if __name__ == "__main__":
+    main()

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

@@ -0,0 +1,75 @@
+Metadata-Version: 2.1
+Name: snap2txt
+Version: 0.1.0
+Summary: A tool to save project structure and contents to a text file
+Home-page: https://github.com/vorniches/snap2txt
+Author: Sérgio 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
+
+# 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
+```
+
+## Usage
+
+Navigate to your project directory and run:
+
+```bash
+snap2txt
+```
+
+### Optional Flags
+
+- `--il`: Use an ignore list from a `.il` file.
+- `--wl`: Use a whitelist from a `.wl` file.
+
+## Configuration
+
+Create `.il` and `.wl` files in your project directory to specify patterns to ignore or include, respectively.
+
+### 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/yourusername/snap2txt/issues) in the GitHub repository.

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

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+setup.py
+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.1.0/snap2txt.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

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

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

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

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