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.2.tar.gz (3.6 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.2-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: project_to_markdown-0.1.2.tar.gz
  • Upload date:
  • Size: 3.6 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.2.tar.gz
Algorithm Hash digest
SHA256 4637423e0a3395e0d58a12f8bef8b370f5eb5d7dc5bfa66a4602a7400e1d7ab9
MD5 293229b8fb7c8f39997a23fd52ffac8e
BLAKE2b-256 40284f7ef19db32e35ea154df8a717fbb0804bbf31954fad7fb71789f258132f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for project_to_markdown-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 731972da9ad0a95682baa060b2a31d87b5491129933f69e496ea5815f76c36d4
MD5 ef6101b7d865ede6e6043c5b74c32ddb
BLAKE2b-256 d93561b4adfce3e6bb33e38745e9b700bc164579314e28dc66d3e18045b09257

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