{"id":31327952,"url":"https://github.com/europanite/project_to_markdown","last_synced_at":"2026-05-16T11:33:06.409Z","repository":{"id":314023794,"uuid":"1052020494","full_name":"europanite/project_to_markdown","owner":"europanite","description":"produces from your project to one markdown file.","archived":false,"fork":false,"pushed_at":"2026-03-22T04:28:03.000Z","size":93,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-22T19:35:51.798Z","etag":null,"topics":["document","documentation","generative-ai","llm","markdown","markdown-language","python","report"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/europanite.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-07T08:23:28.000Z","updated_at":"2026-01-22T10:29:13.000Z","dependencies_parsed_at":"2025-10-06T17:15:29.733Z","dependency_job_id":"fda24e90-4862-4f34-b0ce-511bd7b074d4","html_url":"https://github.com/europanite/project_to_markdown","commit_stats":null,"previous_names":["europanite/project_to_markdown"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/europanite/project_to_markdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/europanite%2Fproject_to_markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/europanite%2Fproject_to_markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/europanite%2Fproject_to_markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/europanite%2Fproject_to_markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/europanite","download_url":"https://codeload.github.com/europanite/project_to_markdown/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/europanite%2Fproject_to_markdown/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33100861,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-16T04:41:52.686Z","status":"ssl_error","status_checked_at":"2026-05-16T04:41:52.009Z","response_time":115,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["document","documentation","generative-ai","llm","markdown","markdown-language","python","report"],"created_at":"2025-09-25T23:39:15.316Z","updated_at":"2026-05-16T11:33:06.403Z","avatar_url":"https://github.com/europanite.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [Project to Markdown](https://github.com/europanite/project_to_markdown \"Project to Markdown\")\n\n[![Python](https://img.shields.io/badge/python-3.9|%203.10%20|%203.11|%203.12|%203.13-blue)](https://www.python.org/)\n![OS](https://img.shields.io/badge/OS-Linux%20%7C%20macOS%20%7C%20Windows-blue)\n\n[![CI](https://github.com/europanite/project_to_markdown/actions/workflows/ci.yml/badge.svg)](https://github.com/europanite/project_to_markdown/actions/workflows/ci.yml)\n[![Python Lint](https://github.com/europanite/project_to_markdown/actions/workflows/lint.yml/badge.svg)](https://github.com/europanite/project_to_markdown/actions/workflows/lint.yml)\n[![pages-build-deployment](https://github.com/europanite/project_to_markdown/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/europanite/project_to_markdown/actions/workflows/pages/pages-build-deployment)\n[![CodeQL Advanced](https://github.com/europanite/project_to_markdown/actions/workflows/codeql.yml/badge.svg)](https://github.com/europanite/project_to_markdown/actions/workflows/codeql.yml)\n\nProject Documentation.\n\nExport an entire multi-file project into **one Markdown file** that’s easy for long-context LLMs (e.g., ChatGPT) to read and reason about.\n\n- Makes code review, refactoring, and architecture discussions frictionless\n- Preserves **file boundaries** with fenced blocks (even for `.md` files)\n- Adds **overview metrics**, a **project tree**, and a **TOC** for quick navigation\n\n---\n\n## Features\n\n- **Safe Markdown for LLMs**  \n  Every file is wrapped in code fences (or rendered/demoted, if you prefer) so your report’s headings don’t collide with project docs.\n- **Overview \u0026 metrics**  \n  - Totals (files, bytes, LOC/SLOC, TODOs)  \n  - Language mix, largest/longest files  \n  - Best-effort dependency sniffing (`requirements.txt`, `pyproject.toml`, `package.json`)\n- **Per-file details**  \n  - Size, LOC/SLOC, TODO count, mtime, SHA1 digest  \n  - Python: function/class counts \u0026 a simple complexity estimate\n- **Table of Contents \u0026 Project Tree**  \n  Anchors per file, plus a compact tree of included paths.\n- **Optional Mermaid** Python import graph (`--mermaid-import-graph`)\n- **Large-file truncation with markers**  \n  Clear `[TRUNCATED]` markers when a file exceeds `--max-bytes-per-file`.\n\n---\n\n## Requirements\n\n- **Python 3.8+**\n- No third-party dependencies (standard library only)\n\n---\n\n## Installation\n\nJust copy the script somewhere on your `PATH`:\n\n```bash\n# Download the script into your project.\ncurl -O https://raw.githubusercontent.com/europanite/project_to_markdown/main/make_md.py\n# Analize the project.\npython make_md.py -r .\n```\n---\n\n## Usage\n\nBasic:\n\n```bash\npython make_md.py -r /path/to/project\n# =\u003e ./\u003cproject\u003e_YYYYMMDD_HHMMSS.md\n```\n\nExclude hidden files:\n\n```bash\npython make_md.py -r . --exclude-hidden\n```\n\nOnly specific extensions:\n\n```bash\npython make_md.py -r .   --only-ext .py --only-ext .md --only-ext .yml --only-ext .toml --only-ext .json\n```\n\nRender project Markdown instead of fencing:\n\n```bash\npython make_md.py -r . --md-policy render\n```\n\nAdd a Python import graph (Mermaid):\n\n```bash\npython make_md.py -r . --mermaid-import-graph\n```\n\nCustom title \u0026 output:\n\n```bash\npython make_md.py -r . --title \"MyApp Export\" -o myapp_dump.md\n```\n\n---\n\n### Test\n\n```bash\npython3 -m venv env\nsource env/bin/activate\npip install -r requirements.test.txt\npytest\n```\n\n### Deactivate environment\n\n```bash\ndeactivate\n```\n\n---\n\n\n## Options\n\n```text\n-r, --root \u003cdir\u003e             Project root directory (required)\n-o, --output \u003cfile\u003e          Output Markdown file (default: \u003cproject\u003e_\u003ctimestamp\u003e.md)\n--ignore \u003cpattern\u003e           Ignore patterns (fnmatch; supports **). Repeatable.\n--exclude-hidden             Exclude hidden files/dirs (dot-prefixed). Default is include.\n--max-bytes-per-file \u003cn\u003e     Max bytes per file to include (default: 300000)\n--only-ext \u003c.ext\u003e            Whitelist extensions; repeat to add more (e.g., .py .md ...)\n--title \u003cstr\u003e                Top-level title in the generated Markdown\n--md-policy {fence,render,skip}\n                             How to include project .md files:\n                               - fence  : wrap in ```markdown (default)\n                               - render : demote headings and render inline\n                               - skip   : omit them\n--top-n-largest \u003cN\u003e          Show N largest/longest files (default: 12)\n--mermaid-import-graph       Include a naive Mermaid graph of Python imports\n--no-metrics                 Disable project/file metrics\n--no-summaries               Disable auto summaries\n```\n\n---\n\n\n## Tips for ChatGPT / LLM workflows\n\n- Paste the generated Markdown into a long-context model.  \n- Use the **TOC** and file anchors to reference exact files.  \n- If a file shows `[TRUNCATED]`, consider attaching that file separately for deep dives.  \n- Prefer `--md-policy fence` (default) so the report’s headings aren’t confused with project docs.\n\n---\n\n## Limitations\n\n- Binary files are skipped (heuristic: NUL bytes / decoding failures).  \n- Dependency detection is best-effort (no lockfile resolution).  \n- The Python import graph is naive (text-level, not AST-based module resolution).\n\n---\n\n## License\n\n- Apache License 2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feuropanite%2Fproject_to_markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feuropanite%2Fproject_to_markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feuropanite%2Fproject_to_markdown/lists"}