| Name | globalutil JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | https://github.com/UYousafzai/globalutil |
| Summary | A global utility package for all the data sorting and inspection needs. |
| upload_time | 2024-09-02 13:53:56 |
| maintainer | None |
| docs_url | None |
| author | Umar Khan |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) [2024] [UmarKhan] 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 |
utility
filesystem
sorting
inspection
global
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
setuptools
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 🌟 globalutil: Your Global Utility Toolkit 🛠️
`globalutil` currently open source part includes file and folder management scripts. future release will include alot of features for building auto training pipeline scripts (ML Pipelines) for python.
## 🌈 Features
- 📁 **Directory Inspection**: Generate beautiful tree structures of your directories
- 🔍 **Smart File Sorting**: Copy files with ease using powerful wildcard patterns
- 🔎 **File Search**: Find files matching specific criteria across directories
- 📊 **File Organization**: Categorize files based on their types
- 🔄 **Duplicate Detection**: Identify and manage duplicate files
- 📏 **Large File Finder**: Locate files exceeding specified size thresholds
- 📝 **Metadata Extraction**: Extract and display file metadata
- 📊 **Directory Size Calculator**: Calculate total size of directories
- 🧹 **Empty Directory Cleaner**: Identify and remove empty directories
- 💾 **File Backup**: Create timestamped backups of files and directories
- 🗜️ **File Archiving**: Create and extract zip archives
- 🔐 **File Integrity**: Calculate and verify file checksums
- 🕒 **Recent File Finder**: Locate recently modified or created files
- 🏷️ **Batch File Renaming**: Rename multiple files based on patterns
- 🔧 **Extensible Design**: Built with future expansion in mind
## 🎯 Vision
`globalutil` could become the Swiss Army knife of ML related utility tools. currently supporting wide range of file and directory operations!
## 🚀 Quick Start
### Installation
```bash
pip install globalutil
```
## Usage
### globalutil
globalutil is a Python library that provides utilities for file system operations, including file analysis, searching, organizing, and more.
### Example Use Case: Preparing Files for LLM Upload
When working with Large Language Models (LLMs), it's often useful to have all relevant files in a single location and to have a clear understanding of the project structure. Here's how you can use globalutil to prepare your files for LLM upload:
from local package
```python
from globalutil.filesystem import Inspect, Sort
# Collect all Python files into a single folder
structure = Inspect.generate_copy_structure("./", "./temp")
Sort.copy_structure(structure, patterns=["*.py"])
# Generate a tree structure of your project
tree = Inspect.get_directory_tree(".")
with open("tree.txt", "w") as f:
f.write(tree)
```
This code will:
1. Copy all .py files from the current directory and its subdirectories into a "./temp" folder.
2. Generate a tree structure of the current directory and save it to "tree.txt".
Now you have:
- All your Python files collected in the "./temp" folder, ready for easy upload to the LLM.
- A "tree.txt" file that provides a clear overview of your project structure, which you can also share with the LLM to give it context about your project organization.
This approach makes it easy to provide the LLM with both your code files and a structural overview of your project, enabling more informed and context-aware interactions.
## 📚 Documentation
For detailed documentation, visit our [GitHub Pages](https://uyousafzai.github.io/globalutil/).
## 📜 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🌟 Show Your Support
If you find this project useful, give it a star on GitHub! ⭐
---
Raw data
{
"_id": null,
"home_page": "https://github.com/UYousafzai/globalutil",
"name": "globalutil",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "utility, filesystem, sorting, inspection, global",
"author": "Umar Khan",
"author_email": "Umar Khan <umaryousafzai9@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/7f/1d/0f73f4e91852b38fba1932d3ed6f5923803128fbf7ce533047447e7b0c31/globalutil-0.4.0.tar.gz",
"platform": null,
"description": "# \ud83c\udf1f globalutil: Your Global Utility Toolkit \ud83d\udee0\ufe0f\n\n\n\n\n`globalutil` currently open source part includes file and folder management scripts. future release will include alot of features for building auto training pipeline scripts (ML Pipelines) for python.\n\n\n## \ud83c\udf08 Features\n\n- \ud83d\udcc1 **Directory Inspection**: Generate beautiful tree structures of your directories\n- \ud83d\udd0d **Smart File Sorting**: Copy files with ease using powerful wildcard patterns\n- \ud83d\udd0e **File Search**: Find files matching specific criteria across directories\n- \ud83d\udcca **File Organization**: Categorize files based on their types\n- \ud83d\udd04 **Duplicate Detection**: Identify and manage duplicate files\n- \ud83d\udccf **Large File Finder**: Locate files exceeding specified size thresholds\n- \ud83d\udcdd **Metadata Extraction**: Extract and display file metadata\n- \ud83d\udcca **Directory Size Calculator**: Calculate total size of directories\n- \ud83e\uddf9 **Empty Directory Cleaner**: Identify and remove empty directories\n- \ud83d\udcbe **File Backup**: Create timestamped backups of files and directories\n- \ud83d\udddc\ufe0f **File Archiving**: Create and extract zip archives\n- \ud83d\udd10 **File Integrity**: Calculate and verify file checksums\n- \ud83d\udd52 **Recent File Finder**: Locate recently modified or created files\n- \ud83c\udff7\ufe0f **Batch File Renaming**: Rename multiple files based on patterns\n- \ud83d\udd27 **Extensible Design**: Built with future expansion in mind\n\n## \ud83c\udfaf Vision\n\n`globalutil` could become the Swiss Army knife of ML related utility tools. currently supporting wide range of file and directory operations!\n\n## \ud83d\ude80 Quick Start\n\n### Installation\n\n```bash\npip install globalutil\n```\n\n\n## Usage\n\n### globalutil\n\nglobalutil is a Python library that provides utilities for file system operations, including file analysis, searching, organizing, and more.\n\n### Example Use Case: Preparing Files for LLM Upload\n\nWhen working with Large Language Models (LLMs), it's often useful to have all relevant files in a single location and to have a clear understanding of the project structure. Here's how you can use globalutil to prepare your files for LLM upload:\n\nfrom local package\n```python\nfrom globalutil.filesystem import Inspect, Sort\n\n# Collect all Python files into a single folder\nstructure = Inspect.generate_copy_structure(\"./\", \"./temp\")\nSort.copy_structure(structure, patterns=[\"*.py\"])\n\n# Generate a tree structure of your project\ntree = Inspect.get_directory_tree(\".\")\nwith open(\"tree.txt\", \"w\") as f:\n f.write(tree)\n```\n\n\nThis code will:\n1. Copy all .py files from the current directory and its subdirectories into a \"./temp\" folder.\n2. Generate a tree structure of the current directory and save it to \"tree.txt\".\n\nNow you have:\n- All your Python files collected in the \"./temp\" folder, ready for easy upload to the LLM.\n- A \"tree.txt\" file that provides a clear overview of your project structure, which you can also share with the LLM to give it context about your project organization.\n\nThis approach makes it easy to provide the LLM with both your code files and a structural overview of your project, enabling more informed and context-aware interactions.\n\n\n## \ud83d\udcda Documentation\n\nFor detailed documentation, visit our [GitHub Pages](https://uyousafzai.github.io/globalutil/).\n\n## \ud83d\udcdc License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## \ud83c\udf1f Show Your Support\n\nIf you find this project useful, give it a star on GitHub! \u2b50\n---\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) [2024] [UmarKhan] 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": "A global utility package for all the data sorting and inspection needs.",
"version": "0.4.0",
"project_urls": {
"Bug Tracker": "https://github.com/UYousafzai/globalutil/issues",
"Homepage": "https://github.com/UYousafzai/globalutil"
},
"split_keywords": [
"utility",
" filesystem",
" sorting",
" inspection",
" global"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5c8a18d9c6fb9cd55140b12fc5cb0570b86077635e90089938653f47428d698",
"md5": "adb0fb295bf4036caf88c956ed722735",
"sha256": "eeb0076fd2442c601282c6bd539f17af76725d1152fde47b0395fa57f6674428"
},
"downloads": -1,
"filename": "globalutil-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "adb0fb295bf4036caf88c956ed722735",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 18138,
"upload_time": "2024-09-02T13:53:55",
"upload_time_iso_8601": "2024-09-02T13:53:55.521900Z",
"url": "https://files.pythonhosted.org/packages/e5/c8/a18d9c6fb9cd55140b12fc5cb0570b86077635e90089938653f47428d698/globalutil-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7f1d0f73f4e91852b38fba1932d3ed6f5923803128fbf7ce533047447e7b0c31",
"md5": "f4cae973ad160339fb3a6116049a17aa",
"sha256": "6e0643591af9879b7780823d37b8c8ef982e1bfd4085825ac75a02a9263c9e32"
},
"downloads": -1,
"filename": "globalutil-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "f4cae973ad160339fb3a6116049a17aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 15747,
"upload_time": "2024-09-02T13:53:56",
"upload_time_iso_8601": "2024-09-02T13:53:56.929305Z",
"url": "https://files.pythonhosted.org/packages/7f/1d/0f73f4e91852b38fba1932d3ed6f5923803128fbf7ce533047447e7b0c31/globalutil-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-02 13:53:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "UYousafzai",
"github_project": "globalutil",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "setuptools",
"specs": [
[
"==",
"69.5.1"
]
]
}
],
"lcname": "globalutil"
}
