snapfold 0.1.0

Snapshot your project folder into a single structured text file.

🚀 Snapfold

Snapfold is a lightweight CLI tool that snapshots your entire project folder into a single structured .txt file — including folder tree and source code — making it easy to share, review, or debug projects.

---

✨ Features

• 📁 Automatically captures project folder structure
• 📄 Includes source code from common development file types
• 🚫 Ignores unnecessary folders like venv, .git, node_modules
• 🧠 Smart filtering for development-related files
• ⚡ One-command execution
• 🖥️ Works on Windows, macOS, and Linux

---

📦 Installation

pip install snapfold

(If installing locally)

pip install .

🚀 Usage

• Navigate to your project folder:

cd path/to/your/project

• Run:

snapfold

• snapfold will generate:

your_project_name.txt

inside the same folder.

📁 Example

• If your folder is:

my_portfolio/

Running:

snapfold

Will create:

my_portfolio.txt

Containing:

• Folder tree

• All relevant source files

• Clean separators

• Structured output

📂 Supported File Types

• Snapfold automatically includes:

• .py

• .html

• .css

• .js

• .jsx

• .tsx

• .json

• .md

• .java

• .cpp

• .c

• .xml

• .yaml

• .yml

• .dart

• .txt

🚫 Ignored Folders

• venv

• pycache

• .git

• node_modules

🛠️ Built With

• Python 3.8+

• Modern pyproject.toml packaging

• CLI entry points

🎯 Why Snapfold?

Snapfold is useful for:

• Sharing projects with mentors or recruiters

• Submitting internship assignments

• Asking debugging questions

• Creating project documentation

• Archiving development snapshots

📜 License

MIT License

👨‍💻 Author

Developed by Nandakrishnan O Computer Science Engineer

⭐ Future Improvements

• PDF export support

• Custom ignore configuration

• CLI options (--pdf, --include, --exclude)

• Syntax highlighting support

• Markdown export

If you find this tool helpful, consider giving it a ⭐ on GitHub!