# README for PCSorter
## Introduction
PCSorter is a Python-based utility designed to intelligently organize files in a directory using the OpenAI ChatGPT API. This tool scans a specified directory (including subdirectories if desired), classifies files based on content and type, and reorganizes them into a more structured format. It leverages the advanced capabilities of OpenAI's GPT models to understand and categorize file contents, making file management more efficient and intuitive.
Key Features:
- File sorting using AI-driven insights.
- Customizable directory and file type handling.
- Backup and restore functionality for sorted files.
- Cross-platform compatibility with detailed setup instructions.
## Requirements
- Python 3.6 or higher
- `openai` Python package
- Additional Python libraries: `os`, `re`, `shutil`, `time`, `argparse`, `datetime`, `json`, `sys`
- An active OpenAI API key
## Installation Instructions
1. Ensure Python 3.6+ is installed on your system.
2. Install AiSort via pip
```
pip install aisort
```
5. Set up an environment variable for your OpenAI API key (instructions in the next section).
### Setting Up Environment Variables
#### Windows
1. **Command Prompt:**
- Use `setx OPENAI_API_KEY "Your-API-Key"` to set the API key.
2. **PowerShell:**
- Apply `$env:OPENAI_API_KEY = "Your-API-Key"` to set the key.
3. **Editing System Properties:**
- Open System Properties -> Advanced -> Environment Variables.
- Add a new System variable named `OPENAI_API_KEY` with your API key as its value.
#### macOS
1. **Using Terminal:**
- Add `export OPENAI_API_KEY="Your-API-Key"` to your `.bash_profile` or `.zshrc`.
2. **Editing `.bash_profile` or `.zshrc`:**
- Open these files in a text editor and add the export line as above.
#### Linux
1. **Using Terminal:**
- Similar to macOS, use `export OPENAI_API_KEY="Your-API-Key"` in `.bashrc` or equivalent.
2. **Editing `.bashrc` or equivalent:**
- Open the file in an editor and add the export command.
## Configuration
Before running PCSorter, ensure the `OPENAI_API_KEY` environment variable is set.
## Usage Instructions
1. **Running the script:**
- Execute `AiSort` in your terminal.
- Use command-line arguments to specify options like `--model`, `--dir`, `--include`, `--backup`.
2. **Common use cases:**
- Sorting files in the current directory: `AiSort sort --dir ./my_directory`
- Using a specific GPT model: `AiSort sort --model gpt-3.5-turbo`
## Troubleshooting
- **API Key Not Recognized:** Ensure the environment variable `OPENAI_API_KEY` is correctly set.
- **Permission Errors:** Run the script with appropriate permissions or from a non-restricted directory.
- **Invalid Model Specified:** Check that the model name is correct and supported.
## FAQs
- **Can PCSorter handle large directories?**
Yes, but performance may vary based on the number and size of files.
## Contributing
Contributions to PCSorter are welcome. Please submit issues and pull requests through GitHub, adhering to the project's coding standards and guidelines.
## License
PCSorter is released under the MIT License. See the LICENSE file for more details.
## Acknowledgments
Thanks to the contributors and to OpenAI for the API that powers this project. Special thanks to [list any special contributors or resources].
Raw data
{
"_id": null,
"home_page": "https://github.com/chroakPRO/Desktop-Cleaner/tree/ai-integration",
"name": "aisort",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "ai sorter",
"author": "Christopher Ek",
"author_email": "chr.oak@icloud.com",
"download_url": "https://files.pythonhosted.org/packages/ee/68/199cab06e53f13ece1e939d4b939e670c3e4c61b78d8be3244e2b446098a/aisort-0.1.4.tar.gz",
"platform": null,
"description": "# README for PCSorter\r\n\r\n## Introduction\r\n\r\nPCSorter is a Python-based utility designed to intelligently organize files in a directory using the OpenAI ChatGPT API. This tool scans a specified directory (including subdirectories if desired), classifies files based on content and type, and reorganizes them into a more structured format. It leverages the advanced capabilities of OpenAI's GPT models to understand and categorize file contents, making file management more efficient and intuitive.\r\n\r\nKey Features:\r\n- File sorting using AI-driven insights.\r\n- Customizable directory and file type handling.\r\n- Backup and restore functionality for sorted files.\r\n- Cross-platform compatibility with detailed setup instructions.\r\n\r\n## Requirements\r\n\r\n- Python 3.6 or higher\r\n- `openai` Python package\r\n- Additional Python libraries: `os`, `re`, `shutil`, `time`, `argparse`, `datetime`, `json`, `sys`\r\n- An active OpenAI API key\r\n\r\n## Installation Instructions\r\n\r\n1. Ensure Python 3.6+ is installed on your system.\r\n2. Install AiSort via pip\r\n ```\r\n pip install aisort \r\n ```\r\n5. Set up an environment variable for your OpenAI API key (instructions in the next section).\r\n\r\n### Setting Up Environment Variables\r\n\r\n#### Windows\r\n\r\n1. **Command Prompt:**\r\n - Use `setx OPENAI_API_KEY \"Your-API-Key\"` to set the API key.\r\n2. **PowerShell:**\r\n - Apply `$env:OPENAI_API_KEY = \"Your-API-Key\"` to set the key.\r\n3. **Editing System Properties:**\r\n - Open System Properties -> Advanced -> Environment Variables.\r\n - Add a new System variable named `OPENAI_API_KEY` with your API key as its value.\r\n\r\n#### macOS\r\n\r\n1. **Using Terminal:**\r\n - Add `export OPENAI_API_KEY=\"Your-API-Key\"` to your `.bash_profile` or `.zshrc`.\r\n2. **Editing `.bash_profile` or `.zshrc`:**\r\n - Open these files in a text editor and add the export line as above.\r\n\r\n#### Linux\r\n\r\n1. **Using Terminal:**\r\n - Similar to macOS, use `export OPENAI_API_KEY=\"Your-API-Key\"` in `.bashrc` or equivalent.\r\n2. **Editing `.bashrc` or equivalent:**\r\n - Open the file in an editor and add the export command.\r\n\r\n## Configuration\r\n\r\nBefore running PCSorter, ensure the `OPENAI_API_KEY` environment variable is set.\r\n\r\n## Usage Instructions\r\n\r\n1. **Running the script:**\r\n - Execute `AiSort` in your terminal.\r\n - Use command-line arguments to specify options like `--model`, `--dir`, `--include`, `--backup`.\r\n2. **Common use cases:**\r\n - Sorting files in the current directory: `AiSort sort --dir ./my_directory`\r\n - Using a specific GPT model: `AiSort sort --model gpt-3.5-turbo`\r\n\r\n## Troubleshooting\r\n\r\n- **API Key Not Recognized:** Ensure the environment variable `OPENAI_API_KEY` is correctly set.\r\n- **Permission Errors:** Run the script with appropriate permissions or from a non-restricted directory.\r\n- **Invalid Model Specified:** Check that the model name is correct and supported.\r\n\r\n## FAQs\r\n\r\n- **Can PCSorter handle large directories?**\r\n Yes, but performance may vary based on the number and size of files.\r\n\r\n## Contributing\r\n\r\nContributions to PCSorter are welcome. Please submit issues and pull requests through GitHub, adhering to the project's coding standards and guidelines.\r\n\r\n## License\r\n\r\nPCSorter is released under the MIT License. See the LICENSE file for more details.\r\n\r\n## Acknowledgments\r\n\r\nThanks to the contributors and to OpenAI for the API that powers this project. Special thanks to [list any special contributors or resources].\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "AiSort is a Python-based utility designed to intelligently organize files using the OpenAI ChatGPT API.",
"version": "0.1.4",
"project_urls": {
"Download": "https://github.com/chroakPRO/Desktop-Cleaner/archive/refs/heads/ai-integration.zip",
"Homepage": "https://github.com/chroakPRO/Desktop-Cleaner/tree/ai-integration"
},
"split_keywords": [
"ai",
"sorter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c1ba0e51cf9054faa4107a0b02268bb1c592992343440743cec79da15b04744f",
"md5": "9ceffb4bca9394eec70e88430237569e",
"sha256": "65b75f70ea21620960d193adab3a517a49f1da6ee4b36d3b45a6c9a2964b949c"
},
"downloads": -1,
"filename": "aisort-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ceffb4bca9394eec70e88430237569e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 8433,
"upload_time": "2024-01-22T19:51:14",
"upload_time_iso_8601": "2024-01-22T19:51:14.949183Z",
"url": "https://files.pythonhosted.org/packages/c1/ba/0e51cf9054faa4107a0b02268bb1c592992343440743cec79da15b04744f/aisort-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ee68199cab06e53f13ece1e939d4b939e670c3e4c61b78d8be3244e2b446098a",
"md5": "b7d6deb98157aad1ec29f0879a3615ed",
"sha256": "86b47373958b62803db9a018bfaaef1cf0bf9c70264dec6046ce63aa92773e3b"
},
"downloads": -1,
"filename": "aisort-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "b7d6deb98157aad1ec29f0879a3615ed",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8421,
"upload_time": "2024-01-22T19:51:16",
"upload_time_iso_8601": "2024-01-22T19:51:16.059467Z",
"url": "https://files.pythonhosted.org/packages/ee/68/199cab06e53f13ece1e939d4b939e670c3e4c61b78d8be3244e2b446098a/aisort-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-22 19:51:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chroakPRO",
"github_project": "Desktop-Cleaner",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "aisort"
}
JSON
