Skip to main content

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

  • --root Root directory of the project (default: current directory)
  • --output Output Markdown file (default: project_export.md)
  • --title Title for the Markdown document
  • --include-exts Comma-separated list of file extensions to include (default: .py,.md)
  • --exclude-dirs Comma-separated list of directory names to exclude
  • --exclude-filesComma-separated list of file names to exclude
  • --use-gitignoreRespect .gitignore files in the export
  • --all-files Include all files, not just tracked files
  • --max-bytes Maximum 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


Download files

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

Source Distribution

project_to_markdown-0.1.0.tar.gz (3.4 kB view details)

Uploaded Source

Built Distribution

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

project_to_markdown-0.1.0-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file project_to_markdown-0.1.0.tar.gz.

File metadata

  • Download URL: project_to_markdown-0.1.0.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for project_to_markdown-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0b10a8508e960aac9137b1ddc6801f704a79ce208ed65fb164ac92d3ee76873f
MD5 533859cddfa0f37de3e0980090cc8a89
BLAKE2b-256 ac045a6b6049897bf8d92356e64b9d84a169583b5ecf5793a95edc0d9212ae89

See more details on using hashes here.

File details

Details for the file project_to_markdown-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for project_to_markdown-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e2d9367e358e8574dfe535f0388dc7f69d3433b984378e4ff124be87cca837c1
MD5 fbcd5b00af717ddf83bca04e551c746a
BLAKE2b-256 5c10a78f1ed60cdad2f0e1974088c7382ef5761126fb5df63d8c6b88f8f85ab4

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