Skip to main content

CLI for dumping a code project to Markdown.

Project description

Codebase Dump

A Python utility for compiling a codebase into a single Markdown file for documentation, analysis, or sharing.

Features

  • Consolidates multiple source files into one Markdown document
  • Includes folder structure visualisation
  • Respects .gitignore patterns
  • Built-in project type presets for common stacks (Python, JavaScript, ML, etc.)
  • Handles binary files appropriately
  • Multi-threaded processing for performance

Requirements

  • Python 3.12+
  • Dependencies:
    • pathspec (for .gitignore processing)
    • rich (for CLI output)
    • click (for CLI interface)

Overview

This tool is useful for creating comprehensive snapshots of your codebase for:

  • Documentation
  • Code review
  • Analysis with AI assistants
  • Preservation of project states

The output is a Markdown file with the complete folder structure and syntax-highlighted code snippets for all included files.

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

projdmp-1.0.1.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

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

projdmp-1.0.1-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file projdmp-1.0.1.tar.gz.

File metadata

  • Download URL: projdmp-1.0.1.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.1 {"installer":{"name":"uv","version":"0.11.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for projdmp-1.0.1.tar.gz
Algorithm Hash digest
SHA256 f7b54c7eac420441ca9abbaa23d691245d8051a479267b88284a29462425efe7
MD5 e4d5021f302d103a0fe91c5ae79674db
BLAKE2b-256 d3cc47b431b78c10bd32a90cbc184a73f304743e3a4ccd1ea802359035a5ce30

See more details on using hashes here.

File details

Details for the file projdmp-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: projdmp-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 11.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.1 {"installer":{"name":"uv","version":"0.11.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for projdmp-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b400fab9757dd15b7081327e201e5cfb8164cd3bd645c6ec78a452896c9887e7
MD5 efdc30b15fd912bf715721397f3af1fa
BLAKE2b-256 b1f1c756c67e5aa5068638bc051c5cfa381f169e368b129e37e725dfe2962510

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