🚀 ProjectDump
ProjectDump is a Python CLI tool that detects a project's technologies, filters out non-essential files, and compiles the source code and directory structure into a single readable file.
📦 Features
- 🔍 Auto-detects technologies (Python, JavaScript, Java, etc.)
- 🧹 Skips dependencies, binaries, media, and config clutter
- 🌲 Generates a clean directory tree
- 📄 Dumps readable source code with syntax highlighting
- ⚡ Handles large projects and ignores huge files (>100MB)
🧑💻 Supported Technologies (Partial List)
- Languages: Python, JS/TS, Java, Kotlin, PHP, Ruby, Go, Rust, C#, Dart, R, Scala, Elixir
- Frameworks: React, Vue, Svelte, Angular, Next.js, Nuxt, Flutter, Android, iOS
- Infra: Docker, Kubernetes, Terraform, Ansible
- CI/CD: GitHub Actions, GitLab CI, CircleCI
📂 Output Example
🚀 PROJECTDUMP
========================================
🌐 Select language (en/vi): en
📂 Enter the project folder path: /path/to/your/project
🔍 Analyzing project at: /path/to/your/project
🔍 Scanning directories...
🛠️ Detected technologies: python
📁 Extensions included: .py, .pyi, .pyx
📁 Generating directory tree...
📄 Processing files...
📝 Processing: aggregator.py
📝 Processing: constants.py
📝 Processing: detector.py
📝 Processing: filters.py
📝 Processing: one_file_version.py
📝 Processing: tree_generator.py
📝 Processing: __main__.py
✅ Success! File created: /path/to/your/project/source_dump.txt
📊 Summary:
- Files processed: 7
- Output size: 30275 characters (~28 KB)
- Total lines: 870
🎉 Done! The source_dump.txt file is ready.
Inside source_dump.txtdemo:
# ==================================================
# Path: /path/to/your/project
# Detected tech: python
# ==================================================
## DIRECTORY STRUCTURE
New folder/
├── __pycache__/
├── __main__.py
├── aggregator.py
├── constants.py
├── detector.py
├── filters.py
├── one_file_version.py
├── source_dump.txt
└── tree_generator.py
## FILE CONTENTS
### __main__.py
import os
...
🚀 Usage
Run from the command line:
python main.py /path/to/your/project
📁 What It Ignores
-
Dependency folders: node_modules, venv, etc.
-
Media & binaries: .jpg, .exe, .log, etc.
-
Config/IDE: .git, .vscode, .github, etc.
-
Large files over 100MB
✅ Requirements
Python 3.x
🤝 Contributing
Feel free to fork and contribute to enhance tech detection, support new stacks, or improve output formatting!
Metadata
Release files for projectdump 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| projectdump-0.1.0.tar.gz | 12.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| projectdump-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 27.6 kB
Release files / projectdump-0.1.0.tar.gz
| Download URL | projectdump-0.1.0.tar.gz |
|---|---|
| Size | 12.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
31843421fca67daa00b798930ccb9e17cb29fd120e65f34770d961bfb43fbba1
|
|
BLAKE2b-256 checksum How to use checksums |
d84d6052d774bbc879ac264d931ddc792d927ed705148e8913f8ad7db1f5a54d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.10
|
Release files / projectdump-0.1.0-py3-none-any.whl
| Download URL | projectdump-0.1.0-py3-none-any.whl |
|---|---|
| Size | 15.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
20142cc2386d8508bc03660cd0aebe0705491b2ead9a7bc5bd449b6405deb9b0
|
|
BLAKE2b-256 checksum How to use checksums |
fa23ffb8b3c1cf0918f666e11d20b1247612aba8be653432a82dd5dea5f142ca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.10
|