GitHub2File is a tool to download and process files from a GitHub repository, extracting and combining source code or other relevant files into a single output file.

• Download and process files from a GitHub repository.
• Process local zip files and directories.
• Filter files by programming language.
• Include or exclude specific directories and files.
• Convert IPython notebooks to Python scripts.
• Remove comments and docstrings from Python files.
• Optionally copy the output to the clipboard (MacOS only).

To install the package, run:

pip install .

GitHub2File supports the following languages and file types:

• Python (.py)
• PDF (.pdf)
• IPython Notebooks (.ipynb)
• Markdown (.md, .markdown, .mdx)
• JavaScript (.js)
• Go (.go)
• HTML (.html)
• Mojo (.mojo)
• Java (.java)
• Lua (.lua)
• C (.c, .h)
• C++ (.cpp, .h, .hpp)
• C# (.cs)
• Ruby (.rb)
• MATLAB (.m)
• Shell (.sh)
• TOML (.toml)

You can use GitHub2File either by downloading a repository directly from GitHub, processing a local zip file, or processing a local directory. Here are the different ways to call the script:

python -m github2file --repo_url <repository_url> [options]

python -m github2file --zip_file <path_to_zip_file> [options]

python -m github2file --folder <path_to_folder> [options]

• --repo_url: The URL of the GitHub repository to download.
• --zip_file: Path to the local zip file.
• --folder: Path to the local folder.
• --lang: The programming language(s) and format(s) of the repository (comma-separated). Default is python. Supported formats include python, pdf, and ipynb.
• --keep-comments: Keep comments and docstrings in the source code (only applicable for Python).
• --branch_or_tag: The branch or tag of the repository to download. Default is master.
• --ipynb_nbconvert: Convert IPython Notebook files to Python script files using nbconvert. Default is True.
• --pbcopy: Copy the output to the clipboard. Default is False.
• --debug: Enable debug logging.
• --include: Comma-separated list of subfolders/patterns to focus on.
• --exclude: Comma-separated list of file patterns to exclude.
• --excluded_dirs: Comma-separated list of directories to exclude. Default is docs,examples,tests,test,scripts,utils,benchmarks.
• --name_append: Append this string to the output file name.
• --ipynb_nbconvert: Convert IPython Notebook files to Python script files using nbconvert. Default is True.
• --pbcopy: Copy the output to the clipboard. Default is False.

python -m github2file --repo_url https://github.com/user/repo --lang python,markdown,pdf --pbcopy --excluded_dirs env

or

python -m github2file --lang python,markdown --pbcopy --excluded_dirs env https://github.com/user/repo 

python -m github2file --zip_file /path/to/repo.zip --lang python,pdf --include src,lib --exclude test --keep-comments

python -m github2file --folder /path/to/repo --lang python,pdf --excluded_dirs env,docs

You can combine multiple options to fine-tune the processing:

python -m github2file --folder /path/to/repo --lang python,pdf --keep-comments --include src,lib --name_append processed --debug --pbcopy

If you want to contribute to this project, please fork the repository and create a pull request.