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.4.tar.gz (6.2 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.4-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: project_to_markdown-0.1.4.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

Hashes for project_to_markdown-0.1.4.tar.gz
Algorithm Hash digest
SHA256 9bce31b5418ab8d27c4e7fc18917260e49b0ac157d2d48ec62b4f3e028c9e7f8
MD5 72564ce49ca5fda6fd9665f09b0fb87c
BLAKE2b-256 84b28c3f99b50da73d2a6ad4af183231a2f04fa9e937e6b79290ac40fa7cee09

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for project_to_markdown-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 aaa4ba3624638ad4b5123d88a419fce7321507001808e76a1b0b26953dd93315
MD5 74ed0cedde75d3bca0798c6d611e6dac
BLAKE2b-256 691c0edbe5e1dd9c543abb969fb1063bc5b7af7c07fba65cfb3aefe286c428f3

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