project-to-markdown 0.1.0__tar.gz

project_to_markdown-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md
+

project_to_markdown-0.1.0/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: project-to-markdown
+Version: 0.1.0
+Summary: Export a Python project into a single Markdown file.
+Author-email: Your Name <your@email.com>
+License: MIT
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+
+# 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
+
+```sh
+pip install project-to-markdown
+```
+
+Or, for local development:
+
+```sh
+pip install .
+```
+
+## Usage
+
+From the command line:
+
+```sh
+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-files`Comma-separated list of file names to exclude
+- `--use-gitignore`Respect .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
+
+```sh
+project-to-markdown --root my_project --output my_project.md --title "My Project"
+```
+
+## License
+
+MIT License
+
+---
+
+Created by Your Name. Contributions welcome!
+

project_to_markdown-0.1.0/README.md

@@ -0,0 +1,55 @@
+# 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
+
+```sh
+pip install project-to-markdown
+```
+
+Or, for local development:
+
+```sh
+pip install .
+```
+
+## Usage
+
+From the command line:
+
+```sh
+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-files`Comma-separated list of file names to exclude
+- `--use-gitignore`Respect .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
+
+```sh
+project-to-markdown --root my_project --output my_project.md --title "My Project"
+```
+
+## License
+
+MIT License
+
+---
+
+Created by Your Name. Contributions welcome!
+

project_to_markdown-0.1.0/project_to_markdown/__init__.py

@@ -0,0 +1,5 @@
+# main.py for project_to_markdown package
+
+from .main import main
+# __init__.py for project_to_markdown package
+

project_to_markdown-0.1.0/project_to_markdown/main.py

@@ -0,0 +1,183 @@
+# main.py for project_to_markdown package
+
+# The following code is moved from __main__.py
+
+import argparse
+import fnmatch
+import io
+from pathlib import Path
+from typing import List, Tuple
+
+
+def parse_args() -> argparse.Namespace:
+    parser = argparse.ArgumentParser(
+        description="Export a Python project into a single Markdown file."
+    )
+    parser.add_argument(
+        "-r",
+        "--root",
+        type=Path,
+        default=Path.cwd(),
+        help="Root directory of the Python project to export",
+    )
+    parser.add_argument(
+        "-o",
+        "--output",
+        type=Path,
+        default=Path("project_export.md"),
+        help="Output Markdown file",
+    )
+    parser.add_argument(
+        "-t",
+        "--title",
+        type=str,
+        default="Project Documentation",
+        help="Title for the Markdown document",
+    )
+    parser.add_argument(
+        "--include-exts",
+        type=str,
+        default=".py,.md",
+        help="Comma-separated list of file extensions to include",
+    )
+    parser.add_argument(
+        "--exclude-dirs",
+        type=str,
+        default="",
+        help="Comma-separated list of directory names to exclude",
+    )
+    parser.add_argument(
+        "--exclude-files",
+        type=str,
+        default="",
+        help="Comma-separated list of file names to exclude",
+    )
+    parser.add_argument(
+        "--use-gitignore",
+        action="store_true",
+        help="Respect .gitignore files in the export",
+    )
+    parser.add_argument(
+        "--all-files",
+        action="store_true",
+        help="Include all files in the export, not just tracked files",
+    )
+    parser.add_argument(
+        "--max-bytes",
+        type=int,
+        default=10_000_000,
+        help="Maximum size of files to include (in bytes)",
+    )
+    return parser.parse_args()
+
+
+def build_tree(
+    root: Path, files_only: bool = False, exclude_dirs: set = None
+) -> List[Tuple[Path, bool]]:
+    if exclude_dirs is None:
+        exclude_dirs = set()
+
+    structure = []
+    for path in sorted(root.rglob("*")):
+        if path.is_dir():
+            if any(
+                fnmatch.fnmatch(path.name, pattern)
+                for pattern in exclude_dirs
+            ):
+                continue
+            structure.append((path, True))
+        elif not files_only:
+            structure.append((path, False))
+    return structure
+
+
+def render_tree_markdown(root: Path, structure_paths: List[Path]) -> str:
+    tree_md = []
+    for path in structure_paths:
+        rel_path = path.relative_to(root)
+        tree_md.append(f"- {'📁' if path.is_dir() else '📄'} {rel_path}")
+    return "\n".join(tree_md)
+
+
+def collect_files(
+    root: Path,
+    include_exts: set,
+    exclude_dirs: set,
+    exclude_files: set,
+    use_gitignore: bool,
+    all_files: bool,
+    max_bytes: int,
+) -> List[Path]:
+    files = []
+    for path in sorted(root.rglob("*")):
+        if path.is_dir():
+            continue
+        if any(fnmatch.fnmatch(path.name, pattern) for pattern in exclude_files):
+            continue
+        if not any(fnmatch.fnmatch(path.suffix, pattern) for pattern in include_exts):
+            continue
+        if path.stat().st_size > max_bytes:
+            continue
+        files.append(path)
+    return files
+
+
+def write_markdown(
+    root: Path, files: List[Path], tree_md: str, out_path: Path, title: str
+) -> None:
+    with io.open(out_path, "w", encoding="utf-8") as md_file:
+        # Write the document title
+        md_file.write(f"# {title}\n\n")
+
+        # Write the tree structure
+        md_file.write("## Project Structure\n")
+        md_file.write(tree_md)
+        md_file.write("\n\n")
+
+        # Write each file's content
+        for file_path in files:
+            rel_path = file_path.relative_to(root)
+            md_file.write(f"## {rel_path}\n")
+            with io.open(file_path, "r", encoding="utf-8") as src_file:
+                content = src_file.read()
+                md_file.write("```\n")
+                md_file.write(content)
+                md_file.write("\n```\n\n")
+
+
+def main():
+    args = parse_args()
+
+    root: Path = args.root.resolve()
+    if not root.exists() or not root.is_dir():
+        raise SystemExit(f"[error] Root directory not found: {root}")
+
+    include_exts = {e.strip().lower() for e in args.include_exts.split(",") if e.strip()}
+    exclude_dirs = {d.strip() for d in args.exclude_dirs.split(",") if d.strip()}
+    exclude_files = {f.strip() for f in args.exclude_files.split(",") if f.strip()}
+
+    # Build a structure list for the tree (dirs + files) to display at top
+    structure_entries = build_tree(root, files_only=False, exclude_dirs=exclude_dirs)
+    structure_paths = [p for p, _is_dir in structure_entries]
+    tree_md = render_tree_markdown(root, structure_paths)
+
+    # Now collect *actual* files to export (respects filters)
+    files = collect_files(
+        root=root,
+        include_exts=include_exts,
+        exclude_dirs=exclude_dirs,
+        exclude_files=exclude_files,
+        use_gitignore=args.use_gitignore,
+        all_files=bool(args.all_files),
+        max_bytes=int(args.max_bytes),
+    )
+
+    # Write Markdown
+    out_path: Path = args.output if args.output.is_absolute() else Path.cwd() / args.output
+    write_markdown(root, files, tree_md, out_path, title=args.title)
+
+    print(f"[ok] Wrote {len(files)} files into: {out_path}")
+
+
+if __name__ == "__main__":
+    main()

project_to_markdown-0.1.0/project_to_markdown.egg-info/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: project-to-markdown
+Version: 0.1.0
+Summary: Export a Python project into a single Markdown file.
+Author-email: Your Name <your@email.com>
+License: MIT
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+
+# 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
+
+```sh
+pip install project-to-markdown
+```
+
+Or, for local development:
+
+```sh
+pip install .
+```
+
+## Usage
+
+From the command line:
+
+```sh
+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-files`Comma-separated list of file names to exclude
+- `--use-gitignore`Respect .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
+
+```sh
+project-to-markdown --root my_project --output my_project.md --title "My Project"
+```
+
+## License
+
+MIT License
+
+---
+
+Created by Your Name. Contributions welcome!
+

project_to_markdown-0.1.0/project_to_markdown.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+MANIFEST.in
+README.md
+pyproject.toml
+project_to_markdown/__init__.py
+project_to_markdown/main.py
+project_to_markdown.egg-info/PKG-INFO
+project_to_markdown.egg-info/SOURCES.txt
+project_to_markdown.egg-info/dependency_links.txt
+project_to_markdown.egg-info/entry_points.txt
+project_to_markdown.egg-info/top_level.txt

project_to_markdown-0.1.0/project_to_markdown.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

project_to_markdown-0.1.0/project_to_markdown.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+project-to-markdown = project_to_markdown.main:main

project_to_markdown-0.1.0/project_to_markdown.egg-info/top_level.txt

@@ -0,0 +1 @@
+project_to_markdown

project_to_markdown-0.1.0/pyproject.toml

@@ -0,0 +1,16 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "project-to-markdown"
+version = "0.1.0"
+description = "Export a Python project into a single Markdown file."
+authors = [{name = "Your Name", email = "your@email.com"}]
+readme = "README.md"
+requires-python = ">=3.7"
+license = {text = "MIT"}
+dependencies = []
+
+[project.scripts]
+project-to-markdown = "project_to_markdown.main:main"

project_to_markdown-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+