The "Text-Assembler_for_AI-Usage" script by PizzaFuel is designed to streamline the analysis of codebases and text-based project assets. It recursively traverses a directory, lists all files, and compiles the contents of text and code files into a single output file. This tool is ideal for preparing project data for analysis with tools like ChatGPT and other Large Language Models or for archival purposes.
This script does not require installation. However, it runs on Python and requires Python 3.6 or newer.
To use this script, clone the repository or download the .py file directly to your local machine:
git clone https://github.com/PizzaFuel/Text-Assembler_for_AI-Usage.gitEnsure you have Python installed on your system. You can download Python from python.org.
Navigate to the directory containing Text-Assembler_for_AI-Usage.py and run the script from your terminal or command prompt:
python Text-Assembler_for_AI-Usage.pyFollow the prompts to specify the root directory of your project and whether you wish to include a project info section in the output file. The script will generate a detailed list and content summary of all text files in the specified directory, saving the output to your Desktop or another specified location. You can also decide to ignore files with ".git" in their path since these tend to not help AI's much in understanding the project.
Contributions to "Text-Assembler_for_AI-Usage" are welcome! Whether it's feature requests, bug reports, or code contributions, please feel free to reach out, submit a pull request or create a fork of this repository.
Before contributing code, please ensure your changes adhere to the project's coding style and that all your code is well-documented.
While the "Text-Assembler_for_AI-Usage" script is completely free for anyone to use, if you find it helpful and wish to support me, consider checking out and purchasing one of my video games. Your support is greatly appreciated and helps fuel further development and creativity. Check out my games here: PizzaFuel on itch.io.
The genesis of "Text-Assembler_for_AI-Usage" occurred during the development of a custom GPT tailored for the Playdate game development in Lua. This endeavor and the challenges and insights it brought forth are elaborated upon in the PizzaTime Article featured in Unkrank'd Magazine Issue 3. The article provides a deep dive into the process and thinking behind the creation of the AI and this script. For those interested in a more detailed backdrop and the broader implications of this project, the magazine can be found here: Unkrank'd Magazine Issue 3.
This project is made available under the MIT License. For more details, see the LICENSE file in the repository.
This script is provided "as is", without warranty of any kind. The author, PizzaFuel, takes no responsibility for the outcomes of using this script, including but not limited to data loss or legal issues arising from its application. Users are advised to run this tool at their own risk.