{ "info": { "author": "Danny Canter", "author_email": "dannycanter123@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# DirectoryCleaner\n\n#### For when you're tired of all that garbage\n\n![demo](https://s3.amazonaws.com/gfyshare/directorycleanergif.gif)\n\n\n---\n## Why?\n\nThe main focus of this application is to make it as easy as possible to clean up directories that just have a bunch of loose files laying around that may not be that important. I DO NOT recommend using this on a software project directory for obvious reasons. It is fully customizable and any of the default names can be changed if for some reason you don't like the default folder names or perhaps even the extremely inventive name DirectoryCleaner.\n\n---\n\n## Setup\n\nFirst install with pip.\n```\npip install DirectoryCleaner\n```\nThen this should make DirectoryCleaner available from your path. To test this type\n```\nDirectoryCleaner -h\n```\nIf you get the help commands you're all set.\n\n### Windows Specific Extra Step\n\nIf you don't already, set your default encoding for cmd to UTF-8 using this command.\n```\nchcp 65001\n```\n\n## Example Usage\n\nThe most basic form of usage is to clean a messy directory with all the default names. The default names take the form of (file_extension)Full_name_of_file_extension. For example a png files default name is (png)Portable Network Graphics. The default directory name everything will be placed in is named DirectoryCleaner(Current_date).\n```\nDirectoryCleaner /users/username/desktop\n```\n#### Grouping files\n\nThe -gf or --group_files flag will group common file types together into the default group directory names. For example all image files of the format jpg, jpeg, png, tif, tiff, gif, bmp, eps, raw, cr2, nef, orf, and sr2 will be placed in an 'Images' folder with this flag set.\n```\nDirectoryCleaner /users/username/desktop -gf\n```\n\n#### Changing defaults\n\nWith these three flags you can change all the default directory names that your files will be placed in. The prompts they will give you will tell you exactly how to change them. After any of the names are changed those names will be the new defaults everytime you run the program.\n```\nDirectoryCleaner /users/username/desktop -mfn -cfn -cgn\n```\n\n#### Reverting to the default settings\n\nWith this flag you can revert to the default settings if you decided that you in fact love and miss the sensible defaults \ud83d\ude0f.\n```\nDirectoryCleaner /users/username/Desktop -rs\n```\n\n#### Ignoring dotfiles\n\nIf you don't want your precious dotfiles to be cleaned up you can pass in the --ignore_dotfiles or -idf flag. By default, unless you had a dotfile named after a common file extension, which is rarely the case, dotfiles would be placed in a folder called 'Unknown'.\n```\nDirectoryCleaner /users/username/desktop -idf\n```\n\n---\n\n## Commands\n\n```\npositional arguments:\n path The path to the directory that you want to cleanup not\n actually the word path. Ex. DirectoryCleaner\n /Users/Username/desktop\n\noptional arguments:\n -h, --help show this help message and exit\n --folder_cleanup, -fc\n Set this flag if you want folders to also be included\n in the clean up.\n --main_folder_name, -mfn\n Set this flag and specify the name you would like the\n main folder to be called. The date will always be\n apart of the name, only DirectoryCleaner will be\n changed.\n --revert_settings, -rs\n Revert the settings file to its default state when the\n program was downloaded. Will use the default settings\n to run the program as well.\n --group_files, -gf Set this flag if you would like to group commonly used\n files like Word Docs, Excel files, PDFs, music files\n etc. in folders named after the type of media they\n are.\n --change_folder_names, -cfn\n Set this flag if you want to rename one of the default\n folder names Directory Cleaner uses for that type of\n file.\n --change_group_names, -cgn\n Set this flag if you'd like to rename one of the\n default group names.\n --ignore_dotfiles, -idf\n Set this flag if instead of placing dotfiles in an\n 'Unknowns' folder, you simply want them ignored. \n``` \n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Cantasaurus/DirectoryCleaner", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "DirectoryCleaner", "package_url": "https://pypi.org/project/DirectoryCleaner/", "platform": "", "project_url": "https://pypi.org/project/DirectoryCleaner/", "project_urls": { "Homepage": "https://github.com/Cantasaurus/DirectoryCleaner" }, "release_url": "https://pypi.org/project/DirectoryCleaner/0.3/", "requires_dist": [ "tqdm (>=4.25.0)", "pyfiglet (>=0.7.5)", "beautifulsoup4 (>=4.6.3); extra == 'Scraper'", "requests (>=2.19.1); extra == 'Scraper'" ], "requires_python": "", "summary": "An easy to use program that will clean a specified directory by placing all loose files in one folder with specified sub folders.", "version": "0.3" }, "last_serial": 4311461, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "6b1298a12e85fd50266cc80b4216184e", "sha256": "20bf1aeb6db8e71b686db1f79ed3fbc04d2d2c785db91e3727f2057bd1d3cb54" }, "downloads": -1, "filename": "DirectoryCleaner-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "6b1298a12e85fd50266cc80b4216184e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 28310, "upload_time": "2018-09-22T21:11:16", "url": "https://files.pythonhosted.org/packages/ee/33/47411e980b4356da5d9c3c1f12f350f9feb3eb58c243b8021e8d19fe8cf7/DirectoryCleaner-0.1-py3-none-any.whl" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "2e7caef0d39f8639369c2052f14e6cba", "sha256": "de2322a681b6ef7d7ea87f40c09183a83d5fdeda215cefe85ff3a95bd325c0b1" }, "downloads": -1, "filename": "DirectoryCleaner-0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "2e7caef0d39f8639369c2052f14e6cba", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 28497, "upload_time": "2018-09-23T02:04:58", "url": "https://files.pythonhosted.org/packages/ad/73/75999dd7d0f7054ff444bc98d71bf96875d84bb5b07ab63b0fb1b743d0a6/DirectoryCleaner-0.2-py3-none-any.whl" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "adb5682844a2b4ba81b43ce99789478b", "sha256": "2aa10454b00b06dad20fe07549e221daa50868101f226abed1d5ae6d7175efea" }, "downloads": -1, "filename": "DirectoryCleaner-0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "adb5682844a2b4ba81b43ce99789478b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 28941, "upload_time": "2018-09-26T07:20:17", "url": "https://files.pythonhosted.org/packages/ae/51/ffd97171cbd157d137d72da5d6fe75c20ebe0ab87b721771b1c4aa9fecab/DirectoryCleaner-0.3-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "adb5682844a2b4ba81b43ce99789478b", "sha256": "2aa10454b00b06dad20fe07549e221daa50868101f226abed1d5ae6d7175efea" }, "downloads": -1, "filename": "DirectoryCleaner-0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "adb5682844a2b4ba81b43ce99789478b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 28941, "upload_time": "2018-09-26T07:20:17", "url": "https://files.pythonhosted.org/packages/ae/51/ffd97171cbd157d137d72da5d6fe75c20ebe0ab87b721771b1c4aa9fecab/DirectoryCleaner-0.3-py3-none-any.whl" } ] }