source-to-text-converter 0.1.2

A tool to convert source code to text or docx

source-to-text-converter

A utility tool to convert the content of software codebases (local or GitHub) into a single structured text or .docx file for easy analysis, documentation, or processing.

Features

• Supports local directories and GitHub repositories as input.
• Preserves folder structure in the output.
• Outputs consolidated content as plain text or .docx.
• Option to exclude hidden files and directories.
• Verbose mode for detailed processing logs.
• File type filtering by extension.
• Robust error handling and cleanup.

Limitations

• Does not support private GitHub repositories requiring authentication.
• Large repositories with thousands of files may experience slower processing times.
• Binary and non-text files are skipped silently.
• .docx output may not preserve complex code formatting perfectly.
• No support for incremental updates; entire codebase is processed each time.

Installation

pip install source-to-text-converter

Usage

CLI

source-to-text-converter --input <input_path_or_url> --output <output_file> [options]

Options:

• --input (required): Local directory path or GitHub repo URL.
• --output (required): Output file path.
• --output-type (optional): txt (default) or docx.
• --exclude-hidden (optional): Exclude hidden files and directories.
• --include-ext (optional): Comma-separated list of file extensions to include (e.g., .py,.js).
• --verbose (optional): Show detailed logs.

Python API

from source_to_text_converter.source_to_text_converter import UnifiedSourceToTextConverter

# Example usage with a local directory
converter = UnifiedSourceToTextConverter(
    input_path="/path/to/repo",
    output_path="output.txt",
    output_type="txt",
    exclude_hidden=True,
    include_exts=[".py", ".js"],
    verbose=True
)
converter.get_file()

# Example usage with a GitHub repository URL and optional branch
github_converter = UnifiedSourceToTextConverter(
    input_path="https://github.com/username/repository.git",
    output_path="output.docx",
    output_type="docx",
    exclude_hidden=True,
    include_exts=[".py", ".js"],
    verbose=True,
    branch="main"  # Optional: specify branch to clone
)
github_converter.get_file()

License

Apache License 2.0