From 41201001ee8c23cef844742fe452345c83741eb9 Mon Sep 17 00:00:00 2001 From: Simon Willison Date: Fri, 22 Mar 2024 08:43:07 -0700 Subject: [PATCH] Initial prototype --- .github/workflows/publish.yml | 51 +++++++++ .github/workflows/test.yml | 28 +++++ .gitignore | 9 ++ LICENSE | 201 ++++++++++++++++++++++++++++++++++ README.md | 92 ++++++++++++++++ files_to_prompt/__init__.py | 0 files_to_prompt/__main__.py | 4 + files_to_prompt/cli.py | 85 ++++++++++++++ pyproject.toml | 26 +++++ tests/test_files_to_prompt.py | 60 ++++++++++ 10 files changed, 556 insertions(+) create mode 100644 .github/workflows/publish.yml create mode 100644 .github/workflows/test.yml create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 files_to_prompt/__init__.py create mode 100644 files_to_prompt/__main__.py create mode 100644 files_to_prompt/cli.py create mode 100644 pyproject.toml create mode 100644 tests/test_files_to_prompt.py diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..ccf23dc --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,51 @@ +name: Publish Python Package + +on: + release: + types: [created] + +permissions: + contents: read + +jobs: + test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + cache: pip + cache-dependency-path: pyproject.toml + - name: Install dependencies + run: | + pip install '.[test]' + - name: Run tests + run: | + pytest + deploy: + runs-on: ubuntu-latest + needs: [test] + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: "3.12" + cache: pip + cache-dependency-path: pyproject.toml + - name: Install dependencies + run: | + pip install setuptools wheel twine build + - name: Publish + env: + TWINE_USERNAME: __token__ + TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }} + run: | + python -m build + twine upload dist/* + diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..31d0b57 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,28 @@ +name: Test + +on: [push, pull_request] + +permissions: + contents: read + +jobs: + test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + cache: pip + cache-dependency-path: pyproject.toml + - name: Install dependencies + run: | + pip install '.[test]' + - name: Run tests + run: | + pytest + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..53605b7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +.venv +__pycache__/ +*.py[cod] +*$py.class +venv +.eggs +.pytest_cache +*.egg-info +.DS_Store diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..738ec18 --- /dev/null +++ b/README.md @@ -0,0 +1,92 @@ +# files-to-prompt + +[![PyPI](https://img.shields.io/pypi/v/files-to-prompt.svg)](https://pypi.org/project/files-to-prompt/) +[![Changelog](https://img.shields.io/github/v/release/simonw/files-to-prompt?include_prereleases&label=changelog)](https://github.com/simonw/files-to-prompt/releases) +[![Tests](https://github.com/simonw/files-to-prompt/actions/workflows/test.yml/badge.svg)](https://github.com/simonw/files-to-prompt/actions/workflows/test.yml) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/files-to-prompt/blob/master/LICENSE) + +Concatenate a directory full of files into a single prompt for use with LLMs + +## Installation + +Install this tool using `pip`: +```bash +pip install files-to-prompt +``` +## Usage + +To use `files-to-prompt`, simply provide the path to the directory you want to process: + +```bash +files-to-prompt path/to/directory +``` + +This will output the contents of every file in the directory and its subdirectories, with each file preceded by its relative path and separated by `---`. + +### Options + +- `--include-hidden`: Include files and folders starting with `.` (hidden files and directories). + ```bash + files-to-prompt path/to/directory --include-hidden + ``` + +- `--ignore-gitignore`: Ignore `.gitignore` files and include all files. + ```bash + files-to-prompt path/to/directory --ignore-gitignore + ``` + +### Example + +Suppose you have a directory structure like this: + +``` +my_directory/ +├── file1.txt +├── file2.txt +├── .hidden_file.txt +└── subdirectory/ + └── file3.txt +``` + +Running `files-to-prompt my_directory` will output: + +``` +my_directory/file1.txt +--- +Contents of file1.txt +--- +my_directory/file2.txt +--- +Contents of file2.txt +--- +my_directory/subdirectory/file3.txt +--- +Contents of file3.txt +--- +``` + +If you run `files-to-prompt my_directory --include-hidden`, the output will also include `.hidden_file.txt`: + +``` +my_directory/.hidden_file.txt +--- +Contents of .hidden_file.txt +--- +... +``` +## Development + +To contribute to this tool, first checkout the code. Then create a new virtual environment: +```bash +cd files-to-prompt +python -m venv venv +source venv/bin/activate +``` +Now install the dependencies and test dependencies: +```bash +pip install -e '.[test]' +``` +To run the tests: +```bash +pytest +``` diff --git a/files_to_prompt/__init__.py b/files_to_prompt/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/files_to_prompt/__main__.py b/files_to_prompt/__main__.py new file mode 100644 index 0000000..98dcca0 --- /dev/null +++ b/files_to_prompt/__main__.py @@ -0,0 +1,4 @@ +from .cli import cli + +if __name__ == "__main__": + cli() diff --git a/files_to_prompt/cli.py b/files_to_prompt/cli.py new file mode 100644 index 0000000..ce94024 --- /dev/null +++ b/files_to_prompt/cli.py @@ -0,0 +1,85 @@ +import os +import click +from pathlib import Path +from fnmatch import fnmatch + + +def should_ignore(path, gitignore_rules): + for rule in gitignore_rules: + if fnmatch(os.path.basename(path), rule): + return True + if os.path.isdir(path) and fnmatch(os.path.basename(path) + "/", rule): + return True + return False + + +def read_gitignore(path): + gitignore_path = os.path.join(path, ".gitignore") + if os.path.isfile(gitignore_path): + with open(gitignore_path, "r") as f: + return [ + line.strip() for line in f if line.strip() and not line.startswith("#") + ] + return [] + + +@click.command() +@click.argument( + "path", + type=click.Path(exists=True, file_okay=False, dir_okay=True, readable=True), +) +@click.option( + "--include-hidden", + is_flag=True, + help="Include files and folders starting with .", +) +@click.option( + "--ignore-gitignore", + is_flag=True, + help="Ignore .gitignore files and include all files", +) +@click.version_option() +def cli(path, include_hidden, ignore_gitignore): + """ + Takes a path to a folder and outputs every file in that folder, + recursively, each one preceded with its filename like this: + + path/to/file.py + ---- + Contents of file.py goes here + + --- + path/to/file2.py + --- + ... + """ + gitignore_rules = [] if ignore_gitignore else read_gitignore(path) + + for root, dirs, files in os.walk(path): + if not include_hidden: + dirs[:] = [d for d in dirs if not d.startswith(".")] + files = [f for f in files if not f.startswith(".")] + + if not ignore_gitignore: + gitignore_rules.extend(read_gitignore(root)) + dirs[:] = [ + d + for d in dirs + if not should_ignore(os.path.join(root, d), gitignore_rules) + ] + files = [ + f + for f in files + if not should_ignore(os.path.join(root, f), gitignore_rules) + ] + + for file in files: + file_path = os.path.join(root, file) + with open(file_path, "r") as f: + file_contents = f.read() + + click.echo(file_path) + click.echo("---") + click.echo(file_contents) + click.echo() + click.echo("---") diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..1603ff3 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,26 @@ +[project] +name = "files-to-prompt" +version = "0.1" +description = "Concatenate a directory full of files into a single prompt for use with LLMs" +readme = "README.md" +authors = [{name = "Simon Willison"}] +license = {text = "Apache-2.0"} +requires-python = ">=3.8" +classifiers = [ + "License :: OSI Approved :: Apache Software License" +] +dependencies = [ + "click" +] + +[project.urls] +Homepage = "https://github.com/simonw/files-to-prompt" +Changelog = "https://github.com/simonw/files-to-prompt/releases" +Issues = "https://github.com/simonw/files-to-prompt/issues" +CI = "https://github.com/simonw/files-to-prompt/actions" + +[project.entry-points.console_scripts] +files-to-prompt = "files_to_prompt.cli:cli" + +[project.optional-dependencies] +test = ["pytest"] diff --git a/tests/test_files_to_prompt.py b/tests/test_files_to_prompt.py new file mode 100644 index 0000000..6fc3016 --- /dev/null +++ b/tests/test_files_to_prompt.py @@ -0,0 +1,60 @@ +import os +from click.testing import CliRunner +from files_to_prompt.cli import cli + + +def test_basic_functionality(tmpdir): + runner = CliRunner() + with tmpdir.as_cwd(): + os.makedirs("test_dir") + with open("test_dir/file1.txt", "w") as f: + f.write("Contents of file1") + with open("test_dir/file2.txt", "w") as f: + f.write("Contents of file2") + + result = runner.invoke(cli, ["test_dir"]) + assert result.exit_code == 0 + assert "test_dir/file1.txt" in result.output + assert "Contents of file1" in result.output + assert "test_dir/file2.txt" in result.output + assert "Contents of file2" in result.output + + +def test_include_hidden(tmpdir): + runner = CliRunner() + with tmpdir.as_cwd(): + os.makedirs("test_dir") + with open("test_dir/.hidden.txt", "w") as f: + f.write("Contents of hidden file") + + result = runner.invoke(cli, ["test_dir"]) + assert result.exit_code == 0 + assert "test_dir/.hidden.txt" not in result.output + + result = runner.invoke(cli, ["test_dir", "--include-hidden"]) + assert result.exit_code == 0 + assert "test_dir/.hidden.txt" in result.output + assert "Contents of hidden file" in result.output + + +def test_ignore_gitignore(tmpdir): + runner = CliRunner() + with tmpdir.as_cwd(): + os.makedirs("test_dir") + with open("test_dir/.gitignore", "w") as f: + f.write("ignored.txt") + with open("test_dir/ignored.txt", "w") as f: + f.write("This file should be ignored") + with open("test_dir/included.txt", "w") as f: + f.write("This file should be included") + + result = runner.invoke(cli, ["test_dir"]) + assert result.exit_code == 0 + assert "test_dir/ignored.txt" not in result.output + assert "test_dir/included.txt" in result.output + + result = runner.invoke(cli, ["test_dir", "--ignore-gitignore"]) + assert result.exit_code == 0 + assert "test_dir/ignored.txt" in result.output + assert "This file should be ignored" in result.output + assert "test_dir/included.txt" in result.output