Export a Python project into a single Markdown file.
Project description
project-to-markdown
Export a Python project into a single Markdown file.
Features
- Recursively scans a project directory
- Includes code and markdown files (configurable)
- Outputs a single, well-structured Markdown file
- Supports file/directory exclusion and size limits
Installation
pip install project-to-markdown
Or, for local development:
pip install .
Usage
From the command line:
project-to-markdown --root path/to/project --output export.md --include-exts .py,.md --exclude-dirs .venv,.git --title "My Project"
Options
--rootRoot directory of the project (default: current directory)--outputOutput Markdown file (default: project_export.md)--titleTitle for the Markdown document--include-extsComma-separated list of file extensions to include (default: .py,.md)--exclude-dirsComma-separated list of directory names to exclude--exclude-filesComma-separated list of file names to exclude--use-gitignoreRespect .gitignore files in the export--all-filesInclude all files, not just tracked files--max-bytesMaximum size of files to include (default: 10,000,000)
Example
project-to-markdown --root my_project --output my_project.md --title "My Project"
License
MIT License
Created by Your Name. Contributions welcome!
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 project_to_markdown-0.1.3.tar.gz.
File metadata
- Download URL: project_to_markdown-0.1.3.tar.gz
- Upload date:
- Size: 6.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5a2e9e4492027017c833b80fdb6a3ed45cad4e73dcd95e032f9d65b935a946c3
|
|
| MD5 |
1b393248fe7441de9da01228b2902369
|
|
| BLAKE2b-256 |
bdc5905b39ad747af182ee7c83e2ac24538f02490867b492ea9b4e79a41bc84e
|
File details
Details for the file project_to_markdown-0.1.3-py3-none-any.whl.
File metadata
- Download URL: project_to_markdown-0.1.3-py3-none-any.whl
- Upload date:
- Size: 6.9 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 |
71cead72b616aed228f1c879de290371d407369ae4e3f9e623616f229c9ed3aa
|
|
| MD5 |
fb134b63c9433060263788f91ef9c77b
|
|
| BLAKE2b-256 |
565a1934f3e57292681cae3a7e4ce7e80c9c5babf931ad338792884bc76ac55f
|