Generate full source dump summary for any project
Project description
๐ 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!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file projectdump-0.1.0.tar.gz.
File metadata
- Download URL: projectdump-0.1.0.tar.gz
- Upload date:
- Size: 12.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
31843421fca67daa00b798930ccb9e17cb29fd120e65f34770d961bfb43fbba1
|
|
| MD5 |
43f5172624848b5a2bdb81dbd2d99857
|
|
| BLAKE2b-256 |
d84d6052d774bbc879ac264d931ddc792d927ed705148e8913f8ad7db1f5a54d
|
File details
Details for the file projectdump-0.1.0-py3-none-any.whl.
File metadata
- Download URL: projectdump-0.1.0-py3-none-any.whl
- Upload date:
- Size: 15.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
20142cc2386d8508bc03660cd0aebe0705491b2ead9a7bc5bd449b6405deb9b0
|
|
| MD5 |
7462881a8ed64a9a1dc766ea1f07becb
|
|
| BLAKE2b-256 |
fa23ffb8b3c1cf0918f666e11d20b1247612aba8be653432a82dd5dea5f142ca
|