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
.gitignorepatterns - 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.
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 projdmp-1.0.0.tar.gz.
File metadata
- Download URL: projdmp-1.0.0.tar.gz
- Upload date:
- Size: 10.5 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f580aff242a4583f850a4603052ffa9c67b105f82af74576230e721b2306813f
|
|
| MD5 |
f94450bfe17201396030ff13d8010e07
|
|
| BLAKE2b-256 |
6d63e2dce2a34f3219cb4d356a29df7f3baf75522da6661673c165c2ecf6338c
|
File details
Details for the file projdmp-1.0.0-py3-none-any.whl.
File metadata
- Download URL: projdmp-1.0.0-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fe5ef3e5a7d58db41e2620adf5a98b0e2fd344234ae8cb58c0db0763a5858035
|
|
| MD5 |
60fd908fc53ec749f983e0ed3e466260
|
|
| BLAKE2b-256 |
87f66dbb1b3188f3ca9bc24ba8f8125129834185163cb56dabb0a83bc093d819
|
