{ "info": { "author": "Faheel Ahmad", "author_email": "faheel@live.in", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6" ], "description": "# CleanUp\n\n[![Travis][travis-shield]][travis-link]\n[![PyPI][pypi-shield]][pypi-link]\n[![Python][python-shield]][pypi-link]\n[![License][license-shield]][license-link]\n\nA simple command line utility that organises files in a directory into subdirectories based on the files' extensions.\n\n## Usage\n\n![Usage](https://i.imgur.com/iATfu3Y.png)\n\nWhen run without any option, it organises the files in the specified directory into subdirectories based on the files' extensions.\n\n### Options\n\n* #### `-d`, `--dry-run`\n\n Just displays the changes that would be made, without actually doing anything.\n\n ```bash\n cleanup -d path/to/dir # dry run the cleanup\n cleanup -dr path/to/dir # dry run the reverting a cleanup\n ```\n\n* #### `-s`, `--silent`\n\n Prevents displaying any information while performing operations. Errors, however, are displayed irrespective of whether this option is enabled or not.\n\n ```bash\n cleanup -s path/to/dir # silently cleanup\n cleanup -sr path/to/dir # silently revert a cleanup\n ```\n\n* #### `-r`, `--revert`\n\n Reverts the cleanup of a directory. Note that for this to work, the specified directory should have been cleaned up before.\n\n ```bash\n cleanup -r path/to/dir # revert the cleanup of a directory\n ```\n\n* #### `-h`, `--help`\n\n Displays the help text.\n\n ```bash\n cleanup -h\n ```\n\n## Development\n\n### Setup\n\n1. Clone the repo and `cd` into it.\n\n2. Set up a Python 3 virtual environment using [pipenv](https://docs.pipenv.org):\n ```bash\n pipenv --three # create Python 3 virtual environment\n pipenv install --dev # install all dependencies\n pipenv shell # activate virtual environment shell\n ```\n\n3. The cleanup script can now be run from the root directory of the project:\n ```bash\n python3 -m cleanup.cleanup -h\n ```\n\n### Test\n\nMake sure you're in the root directory of the project. You can then run the test using:\n```bash\npython3 -m tests.test\n```\n\n## License\n\nThis project is licensed under the terms of the [MIT license][license-link].\n\n\n[travis-shield]: https://img.shields.io/travis/faheel/cleanup.svg?style=for-the-badge\n[travis-link]: https://travis-ci.org/faheel/cleanup\n[pypi-shield]: https://img.shields.io/pypi/v/cleanup.svg?style=for-the-badge\n[pypi-link]: https://pypi.org/project/cleanup\n[python-shield]: https://img.shields.io/pypi/pyversions/cleanup.svg?style=for-the-badge\n[license-shield]: https://img.shields.io/github/license/faheel/cleanup.svg?style=for-the-badge\n[license-link]: https://github.com/faheel/cleanup/blob/master/LICENSE\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/faheel/cleanup", "keywords": "cleanup file-organiser file-organisation file-management hue docopt", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "cleanup", "package_url": "https://pypi.org/project/cleanup/", "platform": "", "project_url": "https://pypi.org/project/cleanup/", "project_urls": { "Bug Reports": "https://github.com/faheel/cleanup/issues", "Homepage": "https://github.com/faheel/cleanup", "Source": "https://github.com/faheel/cleanup" }, "release_url": "https://pypi.org/project/cleanup/1.0.3/", "requires_dist": [ "docopt", "huepy", "pylint; extra == 'dev'" ], "requires_python": "", "summary": "A simple command line utility that organises files in a directory into subdirectories.", "version": "1.0.3" }, "last_serial": 3741877, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "135d4e5454942f0ef8ea351d19f1fa62", "sha256": "0f1836841c0c9f452a496fbddac6f08c91d50f38269acf09b85ad70aa0f7bc6f" }, "downloads": -1, "filename": "cleanup-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "135d4e5454942f0ef8ea351d19f1fa62", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 38609, "upload_time": "2018-04-04T17:13:42", "url": "https://files.pythonhosted.org/packages/ce/bb/37ab86b2ef9b27cc1cad7f5fd265057bba5c997bf6324088e14ca7c7db89/cleanup-1.0.0-py3-none-any.whl" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "e10f0948a68f596196abedc66f62d643", "sha256": "2619aaeef43b9f0deb44a58d9b8dc2d5f0e6421fb88e1fce19b0b57de5863957" }, "downloads": -1, "filename": "cleanup-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "e10f0948a68f596196abedc66f62d643", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 38668, "upload_time": "2018-04-04T18:56:38", "url": "https://files.pythonhosted.org/packages/3d/36/4f0431d6dfe551ab94f7669b7846f46e933e9e0e9c3ec4abcb94373eb876/cleanup-1.0.1-py3-none-any.whl" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "9f8e8fce48933fb2a1fbfbc751077285", "sha256": "bbcc8bddc8e9b89af4e36d2742540d593a4d16fa65afd7ea94b3c960052257e8" }, "downloads": -1, "filename": "cleanup-1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "9f8e8fce48933fb2a1fbfbc751077285", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 38859, "upload_time": "2018-04-06T16:46:46", "url": "https://files.pythonhosted.org/packages/81/12/3584c9bd815fb15060d46e8f138dec56cac2ba7cfe70d63672252a333fed/cleanup-1.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9299276f08169ceb1763b3a7ef8fbb6f", "sha256": "c6ce1c955a1c78d81976b9cfc2e1389958231f7e9114d13d8a1958552968fb7e" }, "downloads": -1, "filename": "cleanup-1.0.2.tar.gz", "has_sig": false, "md5_digest": "9299276f08169ceb1763b3a7ef8fbb6f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 39142, "upload_time": "2018-04-06T16:45:38", "url": "https://files.pythonhosted.org/packages/d8/4f/3384a68083fbcb9a0ae7c63af5f4d7ff5770878b3f3a3a525788181875ac/cleanup-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "c08fb732ec5fe94a4b6a622a3baacfbf", "sha256": "e3a11ff65ec33853f0a5036b90040493c6e46611f33d1c6c0732fbbb8f74d9fe" }, "downloads": -1, "filename": "cleanup-1.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "c08fb732ec5fe94a4b6a622a3baacfbf", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 38849, "upload_time": "2018-04-06T18:01:40", "url": "https://files.pythonhosted.org/packages/6e/d0/a32028e6d71ee5cdd05023b7a112128fc01290db5e7f720fd2a17205e88b/cleanup-1.0.3-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c08fb732ec5fe94a4b6a622a3baacfbf", "sha256": "e3a11ff65ec33853f0a5036b90040493c6e46611f33d1c6c0732fbbb8f74d9fe" }, "downloads": -1, "filename": "cleanup-1.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "c08fb732ec5fe94a4b6a622a3baacfbf", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 38849, "upload_time": "2018-04-06T18:01:40", "url": "https://files.pythonhosted.org/packages/6e/d0/a32028e6d71ee5cdd05023b7a112128fc01290db5e7f720fd2a17205e88b/cleanup-1.0.3-py3-none-any.whl" } ] }