A project that splits files and copies them to paste buffer with context for an LLM.
Reason this release was yanked:
1.0.0 released
Project description
chunkwrap
A Python utility for splitting large files into manageable chunks and wrapping them with custom prompts for Large Language Model (LLM) processing.
Overview
chunkwrap helps you process large files with LLMs by automatically splitting them into smaller chunks and wrapping each chunk with your specified prompt. It maintains state between runs, so you can process one chunk at a time without losing track of your progress.
Features
- Automatic chunking: Split files into configurable chunk sizes (default 10,000 characters)
- State management: Remembers which chunk you're on between runs
- Clipboard integration: Automatically copies wrapped chunks to your clipboard
- Custom prompts: Use different prompts for regular chunks vs. the final chunk
- Progress tracking: Shows current chunk number and total chunks
Installation
- Clone or download the script
- Install the required dependency:
pip install pyperclip
Usage
Basic Usage
python chunkwrap.py --prompt "Analyze this code:" --file myfile.txt
Advanced Usage
# Custom chunk size
python chunkwrap.py --prompt "Review this code:" --file large_file.py --size 5000
# Different prompt for the last chunk
python chunkwrap.py --prompt "Analyze this code chunk:" --file code.py --lastprompt "Analyze this final code chunk and provide a summary:"
# Reset state to start over
python chunkwrap.py --reset
Command Line Arguments
--prompt(required): The prompt text to wrap around each chunk--file(required): Path to the file you want to process--lastprompt(optional): Different prompt for the final chunk--size(optional): Chunk size in characters (default: 10,000)--reset(optional): Reset the chunk counter and start from the beginning
How It Works
- First run: Reads your file, splits it into chunks, wraps the first chunk with your prompt, and copies it to clipboard
- Subsequent runs: Continues from where you left off, processing the next chunk
- State tracking: Uses a
.chunkwrap_statefile to remember your progress - Completion: Notifies you when all chunks are processed
Example Workflow
# Start processing a large Python file
python chunkwrap.py --prompt "Please review this Python code for bugs:" --file large_script.py
# Output: "Chunk 1 of 5 is now in the paste buffer. Run this script again for the next chunk."
# Paste into your LLM, get response, then run again...
python chunkwrap.py --prompt "Please review this Python code for bugs:" --file large_script.py
# Output: "Chunk 2 of 5 is now in the paste buffer. Run this script again for the next chunk."
# Continue until all chunks are processed...
# When done with this file, reset for a new file
python chunkwrap.py --reset
Output Format
Each chunk is wrapped in triple quotes with your prompt:
Your prompt here (chunk 1 of 3)
"""
[chunk content here]
"""
The final chunk omits the chunk counter and uses --lastprompt if provided.
State File
chunkwrap creates a .chunkwrap_state file in the current directory to track progress. Delete this file or use --reset to start over with a new file or prompt.
Use Cases
- Processing large codebases with LLMs
- Analyzing lengthy documents in sections
- Breaking down large text files for review
- Sequential processing of any large text content
Requirements
- Python 3.6+
- pyperclip library
License
This project is licensed under the GNU General Public License v3.0. See the LICENSE file for more details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file chunkwrap-0.5.0.tar.gz.
File metadata
- Download URL: chunkwrap-0.5.0.tar.gz
- Upload date:
- Size: 43.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ddd456466309ed1b82cb9c5e8a983d9b217bc829c8ca553d8a0c1c00173be56a
|
|
| MD5 |
b559d36e8594b977dc34bf04f04ff722
|
|
| BLAKE2b-256 |
071fc0b99b21802a86cd592e71a3daf0d25b27089101acc17eaae207e724e398
|
File details
Details for the file chunkwrap-0.5.0-py3-none-any.whl.
File metadata
- Download URL: chunkwrap-0.5.0-py3-none-any.whl
- Upload date:
- Size: 29.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9795f00bb1b58f13e919441cdfa0dc64be0ccd7d20de0303f122eee77a9702de
|
|
| MD5 |
5af18dd8f14959fb78f2fd9b9a676456
|
|
| BLAKE2b-256 |
429d15ce9ba9b53ec110285197e3195bb5f415b65f65f66c1fe98863d57e8b4e
|