Skip to main content

List relevant files with content in markdown format

Project description

listdump

GitHub PyPI Version License Buy Me A Coffee

listdump is a lightweight CLI tool that recursively (or non-recursively) lists relevant files in a directory and outputs their contents wrapped in Markdown-style code blocks (```), ready for documentation, debugging, or review.

📂💻→📝

by Tim Abdiukov


📦 Installation

pip install listdump

Run it from anywhere using:

listdump [arguments]

🚀 Usage

listdump [includes] [-x excludes] [-no-sub] [-out=filename] [-dir=path] [-no-gitignore] [-include-hidden]

🔧 Arguments

Argument Description
includes Extensions or glob patterns to include (py, txt, log_*_202*.log, etc.)
-x, --exclude, -ex, --ex Extensions or glob patterns to exclude
-no-sub Exclude subfolders
-out=FILE Output file name (default: listdump.md)
-dir=DIR Starting directory (default: current)
-no-gitignore Do not respect .gitignore rules
-include-hidden Include normally excluded files: .git, .gitignore, and listdump.md, and license files (LICENCE, LICENSE)
-h, --help Show help message

ℹ️ Examples

listdump txt py -x log tmp

Includes .txt and .py files, excludes .log and .tmp

listdump py -no-sub

Includes .py files only in the current directory

listdump py -no-gitignore -include-hidden

Includes .py files, even those ignored by .gitignore and including .git, .gitignore, listdump.md, and license files


Tim Abdiukov

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

listdump-0.1.9.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

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

listdump-0.1.9-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file listdump-0.1.9.tar.gz.

File metadata

  • Download URL: listdump-0.1.9.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for listdump-0.1.9.tar.gz
Algorithm Hash digest
SHA256 ca909fe891fcbb6a71e8191fa79138e68cea260a0739a542164443247beeff44
MD5 e8cfc4c63997fee50abdd363aa37fe4f
BLAKE2b-256 a186f4e4249d9fdfb54c81377001bf4f6a4650368e5b2c5ab3534f301b8ef956

See more details on using hashes here.

File details

Details for the file listdump-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: listdump-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for listdump-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 042c488e1789a7097448f0b9c793dbc6ba46699f76f7f14117b1f41791897407
MD5 77e10a1fff74b6dd59feeb6177fc7c15
BLAKE2b-256 23708f5af60406e77c2633492bc2b315a57ca17d941d5a4a2d8c6c69f177ccf3

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