PHOTON • openai chat parser¶
OpenAI Chat Parser is a command-line tool that downloads, extracts, and parses OpenAI chat conversation archives. The tool organizes conversations into separate folders with appropriate file formats based on the conversation content.
Installation¶
You can install the OpenAI Chat Parser package from PyPI using pip:
pip install openai-chat-parser
Usage¶
After installing the package, you can use the openai-chat-parser command-line tool to process chat archives.
To run the OpenAI Chat Parser, execute the following command:
openai-chat-parser
The script will prompt you to enter the ZIP URL of the chat archive:
Enter the zip URL:
Enter the URL and press Enter. The tool will download, extract, and parse the chat conversations, organizing them into separate folders.
Configuration¶
Before using the OpenAI Chat Parser, you can configure the package by modifying the config.json file. This file contains settings like the destination path, archive folder, export folder, and download retries.
Here’s an example of the config.json file:
{
"chats_home": "~/Chats",
"downloads_folder": "downloads",
"archive_folder": "archive",
"conversations_folder": "conversations",
"zip_download_retries": 3,
"retry_wait_time_seconds": 5
}
You can customize the settings in the config.json file to suit your needs.
License¶
This project is licensed under the MIT License.
recent logs:¶
23.107 - Publishing the OpenAI Chat Parser Tool to PyPI
In this log entry, we will outline the process for publishing the OpenAI Chat Parser tool to the Python Package Index (PyPI), allowing users to easily install and use the package.
23.107 - Status
We have made significant progress on the development of the OpenAI Chat Parser tool. In this log entry, we will review the current state of the code and outline the remaining tasks using Sphinx todo directives.
23.107 - launch of the OPENAI Chat Parser tool
We are excited to introduce our latest tool: OpenAI Chat Parser. This Python script is designed to download, extract, and parse OpenAI chat conversation archives, allowing users to easily organize and manage their chat transcripts.
22.356 - Welcome
first log entry for the system
todos:¶
Todo
Add error handling and input validation to improve the robustness of the script.
Implement unit tests for the various functions to ensure correctness and reliability.
Improve documentation, including comments and function docstrings, for better maintainability and understanding of the code.
(The original entry is located in /home/phi/Projects/PHOTON/openai_chat_parser/log/23.107-160717/index.rst, line 24.)
Todo
Add error handling and input validation to the script.
This task will involve adding try-except blocks and input validation checks to ensure the script can handle unexpected situations and user errors.
(The original entry is located in /home/phi/Projects/PHOTON/openai_chat_parser/log/23.107-160717/index.rst, line 33.)
Todo
Implement unit tests for the various functions.
Writing unit tests will help verify the functionality of the individual components of the script and identify potential issues early in the development process.
(The original entry is located in /home/phi/Projects/PHOTON/openai_chat_parser/log/23.107-160717/index.rst, line 37.)
Todo
Improve documentation, including comments and function docstrings.
Enhancing the documentation will make the codebase more maintainable and easier to understand for future developers and users.
(The original entry is located in /home/phi/Projects/PHOTON/openai_chat_parser/log/23.107-160717/index.rst, line 41.)
