Analyze Folder for LLM
Analyze Folder for LLM is a Python library designed to collect text and code from a folder for use as context with large context Language Models (LLMs). This tool efficiently fetches README files, folder structures, and non-binary file contents, providing structured outputs complete with pre-formatted prompts to guide further analysis of the folder's content.
Installation
You can install Analyze Folder for LLM using pip:
pip install analyze-folder-for-llm
Usage
After installation, you can use the folder_to_llm command-line tool:
folder_to_llm --path "~/your_project_folder"
This will analyze the specified folder and generate output files in an output directory within the analyzed folder.
For more options:
folder_to_llm --help
You can also use it in your Python scripts:
from analyze_folder_for_llm import folder_to_llm
result = folder_to_llm("~/your_project_folder")
print(result)
Features
- Analyze folder structures
- Extract README contents
- Collect non-binary file contents
- Generate structured output for LLM consumption
- Customizable preset configurations
- Rich console output for easy readability
Output
The tool generates two main output files in the output directory of the analyzed folder:
folder_contents_for_llm.txt: Contains the contents of all non-binary files in the analyzed folder.folder_analysis_for_llm.json: Contains a structured analysis of the folder, including file structure, README summary, and analysis prompts.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Metadata
Release files for analyze-folder-for-llm 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| analyze_folder_for_llm-0.1.1.tar.gz | 7.5 kB | Without provenance | Details for analyze_folder_for_llm-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| analyze_folder_for_llm-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for analyze_folder_for_llm-0.1.1-py3-none-any.whl |
Total release size: 14.3 kB
Release files / analyze_folder_for_llm-0.1.1.tar.gz
| Download URL | analyze_folder_for_llm-0.1.1.tar.gz |
|---|---|
| Size | 7.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d82ff9f436cbfa1f2886bfbc8f981ef52b181dc84f5ec760185813da26c4e032
|
|
BLAKE2b-256 checksum How to use checksums |
efc13ccefbc78a771f0e03f16b7c50485d502cf5cbfb1de0490770f579e7c687
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.6
|
Release files / analyze_folder_for_llm-0.1.1-py3-none-any.whl
| Download URL | analyze_folder_for_llm-0.1.1-py3-none-any.whl |
|---|---|
| Size | 6.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
01f9d0f52e24369cd9faf8f1d8891e6bcc07cbc8b4531f6cb448b8232528d0b7
|
|
BLAKE2b-256 checksum How to use checksums |
93335e311d7c67dbabea5b3ce22e6a255c771c5f5124e0a53f834b481c91d3f5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.6
|
Security for analyze-folder-for-llm 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.