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.1.tar.gz (3.5 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.1-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: project_to_markdown-0.1.1.tar.gz
  • Upload date:
  • Size: 3.5 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.1.tar.gz
Algorithm Hash digest
SHA256 f782f6201168d42570ae840c41fb3a04069a8643336ec5f58faa0a37bf46c829
MD5 ae456caf4fbfd89ac3d8bd14554da235
BLAKE2b-256 7611374edf3da87388e51b49f0bbc9e53795020f4bae1fca6f01058d7f8d6cc1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for project_to_markdown-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 70954fed75aca3ac0bec924be8d1c47d1ef54df541ac99f13b61c0744161e921
MD5 042b5bbeca442f062276b582085e1858
BLAKE2b-256 345635f325ff09c3f354a001292ab2de295da47a596dfa083a464e406d5e1b84

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