Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

projectdump-0.1.0.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

projectdump-0.1.0-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

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

Hashes for projectdump-0.1.0.tar.gz
Algorithm Hash digest
SHA256 31843421fca67daa00b798930ccb9e17cb29fd120e65f34770d961bfb43fbba1
MD5 43f5172624848b5a2bdb81dbd2d99857
BLAKE2b-256 d84d6052d774bbc879ac264d931ddc792d927ed705148e8913f8ad7db1f5a54d

See more details on using hashes here.

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

Hashes for projectdump-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 20142cc2386d8508bc03660cd0aebe0705491b2ead9a7bc5bd449b6405deb9b0
MD5 7462881a8ed64a9a1dc766ea1f07becb
BLAKE2b-256 fa23ffb8b3c1cf0918f666e11d20b1247612aba8be653432a82dd5dea5f142ca

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page