AIAutoRename is a Python script that automatically renames PDF files based on their content. It leverages the power of the OpenAI GPT Chat API to extract relevant information, such as the document date, company name, and document type, from the PDF's text. This tool is designed to simplify the organization and management of your PDF files by automating the renaming process.

To use AIAutoRename, you'll need Python 3.6 or later. You can download it from the official Python website or the Microsoft Store.

1. Clone or download this repository and navigate to the root directory of the project in your terminal.

   git clone https://github.com/ptmrio/AIAutoRename.git
   cd AIAutoRename
   

2. Install the required python packages using the requirements.txt file:

   pip install -r requirements.txt
   

3. Install Tesseract OCR for Windows by following the installation instructions on their GitHub page. After installation, add the folder of the installed Tesseract directory (typicalls C:\Program Files\Tesseract-OCR) to your PATH environment variable.

4. Download and extract poppler for Windows. After installation, add the bin folder (e.g. C:\poppler\Library\bin) of the installed poppler directory to your PATH environment variable.

Here's a guide on how to add directories to the PATH variable on Windows 10.

AIAutoRename uses environment variables to configure the OpenAI API key and the name of your company. Before running the script, you'll need to create a file named .env in the root directory of the project and add the following lines:

OPENAI_API_KEY=<your-api-key>
OPENAI_MODEL=gpt-3.5-turbo
MY_COMPANY_NAME=<your-company-name>

Replace <your-api-key> with your OpenAI API key, which can be obtained from the OpenAI website. Set <your-company-name> to your company's name. This information will help the OpenAI API to better understand the context and decide whether to use the sender or recipient of the PDF document.

To rename a single PDF file, run the following command in your terminal (cmd on Windows, terminal on Mac):

python autorename.py "C:\Users\username\Downloads\invoice123.pdf"

Replace C:\Users\username\Downloads\invoice123.pdf with the path to your PDF file.

Example:

Suppose your PDF file is named invoice123.pdf and is located in the invoices folder on your desktop. After running AIAutoRename, the file might be renamed to something like 20220101 ACME ER.pdf, where 20220101 is the document date, ACME is the company name, and ER is the document type (incoming invoice).

To rename all PDF files in a folder and its subfolders, run the following command in your terminal:

python autorename.py "C:\Users\username\Downloads"

Replace C:\Users\username\Downloads with the path to your folder (no trailing slash).

Example:

Suppose you downloaded a batch of documents into your Downloads folder. After running AIAutoRename on the folder, all PDF files within the folder will be renamed according to their content, such as document date, company name, and document type. For example, a file originally named invoice123.pdf might be renamed to 20220215 MegaCorp PO.pdf, where 20220215 is the document date, MegaCorp is the company name, and PO is the document type (purchase order).

We welcome contributions from everyone! If you find a bug or have a feature request, please open an issue on our GitHub repository. If you'd like to contribute code, please open a pull request with your changes. We appreciate your support in making AIAutoRename even better!

If you encounter any issues or need assistance using AIAutoRename, please don't hesitate to reach out by opening an issue on our GitHub repository. We'll do our best to help you as soon as possible.