# PiFolderOrganizer
PiFolderOrganizer is a Python package that helps organize files into different categories based on their file extensions.
## Installation
You can install PiFolderOrganizer using pip:
```bash
pip install pi-folder-organizer
```
## Usage
To use PiFolderOrganizer in your Python code, import the PiFolderOrganizer class:
```python
from pi_folder_organizer import PiFolderOrganizer
```
Make object of class
```python
pi_organizer=PiFolderOrganizer()
```
To continue with default cleaning:
```python
pi_organizer.pi_folder_organizer("/path/to/source_folder", "/path/to/destination_folder")
```
If you want to see which folders and extentions I use:
```python
pi_organizer.get_counter()
```
This will return you a dictionary of folders and the files list as folder's files.
Same for getting extensions
```python
pi_organizer.get_extensions()
```
This will return you a dictionary of folders and the files tuple of file's extensions.
### Customization Options
You can customize the counter dictionary and extensions dictionary according to your preferences. Here's how:
```python
from pi_folder_organizer import PiFolderOrganizer
# Initialize PiFolderOrganizer
pi_organizer = PiFolderOrganizer()
# Customize the counter dictionary
new_counter = {
"Images": [],
"Documents": []
}
# Set the new counter
pi_organizer.set_counter(new_counter)
print("Updated Counter:", pi_organizer.get_counter())
# Customize the extensions dictionary
new_extensions = {
"Images": (".png", ".jpg"),
"Documents": (".txt", ".docs")
}
# Set the new extensions
pi_organizer.set_extensions(new_extensions)
print("Updated Extensions:", pi_organizer.get_extensions())
# Run the PiFolderOrganizer method after your setup
pi_organizer.pi_folder_organizer("source_folder", "destination_folder")
```
**Note**
The length of ```new_counter``` and ```new_extensions``` must be same. The remaining files automatically moved to folder ```Others```.
### Contact Information
Feel free to reach out to me on social media:
[](https://github.com/mrqadeer)
[](https://www.linkedin.com/in/qadeer-ahmad-3499a4205/)
[](https://twitter.com/mr_sin_of_me)
[](https://web.facebook.com/mrqadeerofficial/)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "pi-folder-organizer",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, file organization, file cleanup, cluttered files, folder management, data organization, file management, data cleanup, Python package, developer tools, data processing, file sorting, data structuring, automated file organization, Python library, data management, data handling, file optimization, data optimization",
"author": "Qadeer Ahmad",
"author_email": "mrqdeer1231122@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a2/03/facece7e1549acd37456dc96107e4466cafd9f714b1d226519a16add7499/pi_folder_organizer-2.2.1.tar.gz",
"platform": null,
"description": "\n# PiFolderOrganizer\n\nPiFolderOrganizer is a Python package that helps organize files into different categories based on their file extensions.\n\n## Installation\n\nYou can install PiFolderOrganizer using pip:\n\n```bash\npip install pi-folder-organizer\n```\n## Usage\nTo use PiFolderOrganizer in your Python code, import the PiFolderOrganizer class:\n```python\nfrom pi_folder_organizer import PiFolderOrganizer\n```\nMake object of class\n```python\npi_organizer=PiFolderOrganizer()\n```\nTo continue with default cleaning:\n```python\npi_organizer.pi_folder_organizer(\"/path/to/source_folder\", \"/path/to/destination_folder\")\n```\nIf you want to see which folders and extentions I use:\n```python\npi_organizer.get_counter()\n```\nThis will return you a dictionary of folders and the files list as folder's files.\nSame for getting extensions\n```python\npi_organizer.get_extensions()\n```\nThis will return you a dictionary of folders and the files tuple of file's extensions.\n\n### Customization Options\n\nYou can customize the counter dictionary and extensions dictionary according to your preferences. Here's how:\n\n```python\nfrom pi_folder_organizer import PiFolderOrganizer\n\n# Initialize PiFolderOrganizer\npi_organizer = PiFolderOrganizer()\n\n# Customize the counter dictionary\nnew_counter = {\n \"Images\": [],\n \"Documents\": []\n}\n\n# Set the new counter\npi_organizer.set_counter(new_counter)\nprint(\"Updated Counter:\", pi_organizer.get_counter())\n\n# Customize the extensions dictionary\nnew_extensions = {\n \"Images\": (\".png\", \".jpg\"),\n \"Documents\": (\".txt\", \".docs\")\n}\n\n# Set the new extensions\npi_organizer.set_extensions(new_extensions)\nprint(\"Updated Extensions:\", pi_organizer.get_extensions())\n\n# Run the PiFolderOrganizer method after your setup\npi_organizer.pi_folder_organizer(\"source_folder\", \"destination_folder\")\n```\n**Note**\nThe length of ```new_counter``` and ```new_extensions``` must be same. The remaining files automatically moved to folder ```Others```.\n\n### Contact Information\n\nFeel free to reach out to me on social media:\n\n[](https://github.com/mrqadeer)\n[](https://www.linkedin.com/in/qadeer-ahmad-3499a4205/)\n[](https://twitter.com/mr_sin_of_me)\n[](https://web.facebook.com/mrqadeerofficial/)\n\n\n\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python package for cleaning up cluttered files and organizing them into respective folders.",
"version": "2.2.1",
"project_urls": null,
"split_keywords": [
"python",
" file organization",
" file cleanup",
" cluttered files",
" folder management",
" data organization",
" file management",
" data cleanup",
" python package",
" developer tools",
" data processing",
" file sorting",
" data structuring",
" automated file organization",
" python library",
" data management",
" data handling",
" file optimization",
" data optimization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bfacc60c77df1ce0468a90758ff5692d072f2bfe84df3f490e4bec16296b40e6",
"md5": "200ea2b343af1543e6a2f32e9f008898",
"sha256": "34eed53dcaab01fbf224af5b764748b60824791faaf76ecb5e298154ef9de986"
},
"downloads": -1,
"filename": "pi_folder_organizer-2.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "200ea2b343af1543e6a2f32e9f008898",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8436,
"upload_time": "2024-05-02T16:20:19",
"upload_time_iso_8601": "2024-05-02T16:20:19.370367Z",
"url": "https://files.pythonhosted.org/packages/bf/ac/c60c77df1ce0468a90758ff5692d072f2bfe84df3f490e4bec16296b40e6/pi_folder_organizer-2.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a203facece7e1549acd37456dc96107e4466cafd9f714b1d226519a16add7499",
"md5": "3c869aaaa609a5f60155b6f238387241",
"sha256": "6f5fdc3e68db28010a8f1b6feb9418fc2ed93ac4d9e69ea305ee4452f25103f7"
},
"downloads": -1,
"filename": "pi_folder_organizer-2.2.1.tar.gz",
"has_sig": false,
"md5_digest": "3c869aaaa609a5f60155b6f238387241",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7643,
"upload_time": "2024-05-02T16:20:20",
"upload_time_iso_8601": "2024-05-02T16:20:20.930132Z",
"url": "https://files.pythonhosted.org/packages/a2/03/facece7e1549acd37456dc96107e4466cafd9f714b1d226519a16add7499/pi_folder_organizer-2.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-02 16:20:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pi-folder-organizer"
}
JSON