| Name | command-line-file-manager JSON |
| Version |
1.1.7
JSON |
| download |
| home_page | None |
| Summary | CLI tool for managing local file system storage |
| upload_time | 2024-11-13 08:04:51 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2022 Kaloyan Ivanov Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
file manager
cli tool
command line interface
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img src="https://github.com/kaliv0/command-line-file-manager/blob/main/assets/fm-snake.jpg?raw=true" alt="Manager">
</p>
---
# command-line-file-manager
[](https://pypi.org/project/command-line-file-manager/)
[](https://pepy.tech/projects/command-line-file-manager)
[](https://github.com/kaliv0/command-line-file-manager/blob/main/LICENSE)
Python CLI tool for scanning and organizing local directories and files.
#### Requires Python 3.10+
## Installation
Via pip:
```console
$ pip install command-line-file-manager
```
From main branch:
```console
$ git clone https://github.com/kaliv0/command-line-file-manager.git
$ cd command-line-file-manager
$ pip install .
```
## Example
To run the application type <i>fm</i> followed by a sub-command, target directory and options
```console
$ fm scan-files ../test --sort=type --save --output=./
```
Add --help after the <i>fm</i> command or any of the subcommands to get more information
```console
$ fm scan-files --help
Usage: fm scan-files [OPTIONS] DIR_PATH
DIR_PATH: Path to directory to be scanned
Options:
--sort [name|size|date|modified|type] Sorting criteria. [default: name]
--desc Display result in descending order.
-s, --save Save log message to file.
-o, --output TEXT Path to output directory for the saved log file.
--help Show this message and exit.
```
## Main Features
- <b>scan_files</b> - list all files inside PATH
- <b>scan_subdirs</b> - list all nested directories
- <b>build_catalog</b> - list all contents (files, subdirs)
<br>(can be done recursively via <b>build_catalog_recursively</b>)
- <b>build_tree</b> - visualize directory structure
- <b>build_pretty_tree</b> - a fancy alternative with emojis etc.
-------------------------------
- <b>search_by_name</b>
- <b>search_by_name_recursively</b>
-------------------------------
- <b>organize_files</b> - group files by extension into corresponding 'type' directories (e.g. music, books)
<br>(provides recursive version)
- <b>handle_duplicate_files</b> - merge identical files (in terms of content) - prompts user for file name or uses first entry in duplicates list
<br>(has a recursive alternative)
Raw data
{
"_id": null,
"home_page": null,
"name": "command-line-file-manager",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "file manager, cli tool, command line interface",
"author": null,
"author_email": "Kaloyan Ivanov <kaloyan.ivanov88@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/b0/2e/32c3ac08974b816fa6ebdd73db588df3778fc2c2a187db4476da1423d49f/command_line_file_manager-1.1.7.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://github.com/kaliv0/command-line-file-manager/blob/main/assets/fm-snake.jpg?raw=true\" alt=\"Manager\">\n</p>\n\n---\n\n# command-line-file-manager\n\n[](https://pypi.org/project/command-line-file-manager/)\n[](https://pepy.tech/projects/command-line-file-manager)\n[](https://github.com/kaliv0/command-line-file-manager/blob/main/LICENSE)\n\nPython CLI tool for scanning and organizing local directories and files.\n\n#### Requires Python 3.10+\n\n## Installation\n\nVia pip:\n```console\n$ pip install command-line-file-manager\n```\n\nFrom main branch:\n```console\n$ git clone https://github.com/kaliv0/command-line-file-manager.git\n$ cd command-line-file-manager \n$ pip install .\n```\n\n## Example\n\nTo run the application type <i>fm</i> followed by a sub-command, target directory and options\n```console\n$ fm scan-files ../test --sort=type --save --output=./\n```\n\nAdd --help after the <i>fm</i> command or any of the subcommands to get more information\n```console\n$ fm scan-files --help\n\nUsage: fm scan-files [OPTIONS] DIR_PATH\n\n DIR_PATH: Path to directory to be scanned\n\nOptions:\n --sort [name|size|date|modified|type] Sorting criteria. [default: name]\n --desc Display result in descending order.\n -s, --save Save log message to file.\n -o, --output TEXT Path to output directory for the saved log file.\n --help Show this message and exit.\n```\n\n## Main Features\n- <b>scan_files</b> - list all files inside PATH\n- <b>scan_subdirs</b> - list all nested directories\n- <b>build_catalog</b> - list all contents (files, subdirs) \n<br>(can be done recursively via <b>build_catalog_recursively</b>)\n- <b>build_tree</b> - visualize directory structure\n- <b>build_pretty_tree</b> - a fancy alternative with emojis etc.\n-------------------------------\n- <b>search_by_name</b>\n- <b>search_by_name_recursively</b>\n-------------------------------\n- <b>organize_files</b> - group files by extension into corresponding 'type' directories (e.g. music, books)\n<br>(provides recursive version)\n\n- <b>handle_duplicate_files</b> - merge identical files (in terms of content) - prompts user for file name or uses first entry in duplicates list\n<br>(has a recursive alternative)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Kaloyan Ivanov Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "CLI tool for managing local file system storage",
"version": "1.1.7",
"project_urls": {
"repository": "https://github.com/kaliv0/command-line-file-manager.git"
},
"split_keywords": [
"file manager",
" cli tool",
" command line interface"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "293557a0562f852ac153928613d08fade1b9086bfb404dd25ec20bd9faf57a74",
"md5": "ee85069f24be0771d479a37597c0d6f7",
"sha256": "5c7c3b985d8850e786f8b1180bbb79501dd3ca3b2bd79000a27d3219017d7adf"
},
"downloads": -1,
"filename": "command_line_file_manager-1.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ee85069f24be0771d479a37597c0d6f7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 13669,
"upload_time": "2024-11-13T08:04:50",
"upload_time_iso_8601": "2024-11-13T08:04:50.156239Z",
"url": "https://files.pythonhosted.org/packages/29/35/57a0562f852ac153928613d08fade1b9086bfb404dd25ec20bd9faf57a74/command_line_file_manager-1.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b02e32c3ac08974b816fa6ebdd73db588df3778fc2c2a187db4476da1423d49f",
"md5": "3f163024c370fbd7cfe3e5465b25ec7f",
"sha256": "e9c18401cdf3a10f9c475079e801d7b8c35d74724d768196d2d89f537f1c4d00"
},
"downloads": -1,
"filename": "command_line_file_manager-1.1.7.tar.gz",
"has_sig": false,
"md5_digest": "3f163024c370fbd7cfe3e5465b25ec7f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 11446,
"upload_time": "2024-11-13T08:04:51",
"upload_time_iso_8601": "2024-11-13T08:04:51.488738Z",
"url": "https://files.pythonhosted.org/packages/b0/2e/32c3ac08974b816fa6ebdd73db588df3778fc2c2a187db4476da1423d49f/command_line_file_manager-1.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 08:04:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kaliv0",
"github_project": "command-line-file-manager",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "command-line-file-manager"
}
