# Sage
sage-directory is a python package that offers a detailed overview of folder contents and streamlines the process of copying and managing directories. It is designed to enhance productivity and simplify file management. It provides details of folder contents, including the file types, size, and subfolder structures, enabling quick insights into the organization of your directory.
Beyond analysis, the tool offers robust functionality for copying entire folders, ensuring seamless management and replication of data environments. Whether you're organizing complex project files, backing up critical datasets, or duplicating environments, this tool is built to optimize your workflow.
## Installation
```
pip install sage-directory
```
## Usage
### Main Features
Comprehensive Folder Overview
##
Generate detailed summaries of folder contents, including file types, sizes, and subfolder structures,
```python
import sage
sage.get_folder_overview('.')
```
<table>
<tr>
<td>Path</td>
<td>Folder Name</td>
<td>Is Folder?</td>
<td>File Name</td>
<td>File Size (Bytes)</td>
<td>File Extensions</td>
<td>Number of Files in Folder</td>
<td>Depth</td>
</tr>
<tr>
<td>./bathoom.py</td>
<td>.</td>
<td>False</td>
<td>bathoom_cal.py</td>
<td>2151</td>
<td>.py</td>
<td>0</td>
<td>0</td>
</tr>
<tr>
<td>./kitchen.png</td>
<td>.</td>
<td>False</td>
<td>kitchen.png</td>
<td>2151</td>
<td>.png</td>
<td>0</td>
<td>0</td>
</tr>
<tr>
<td>./shops</td>
<td>shops</td>
<td>True</td>
<td>N/A</td>
<td>0</td>
<td>N/A</td>
<td>2</td>
<td>1</td>
</tr>
</table>
Selective Copying
##
Choose a specific file to overwrite another in multiple directories
```python
import sage
# overwrites the entered filename (basement.png) in the renovated_kitchen folder with the file in kitchen_catelog folder
sage.batch_file_overwrite(./kitchen_catelog, ./renovated_kitchen, "basement.png")
```
Batch Operations
##
Perform operations on multiple directories
```python
import sage
# only copies 10 folders that are in the kitchen_catelog that share the same folder names as those in the old_kitchen folder in the renovated_kitchen folder
sage.copy_num_folders(./old_kitchen, ./kitchen_catelog, ./renovated_kitchen, 10)
# only copies folders that are in the kitchen_catelog that share the same folder names as those in the old_kitchen folder in the renovated_kitchen folder
sage.copy_folders(./old_kitchen, ./kitchen_catelog, ./renovated_kitchen)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/maxineattobrah/sage-directory",
"name": "sage-directory",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, folder overview, folder management, folder analysis, batch operations, data science utility, data engineering utility, IT operations",
"author": "Maxine Attobrah",
"author_email": "maxineattobrah@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a4/73/48b8707d65f7e918fea87f326b915622c90bca4448e474f28b0beb0b3332/sage-directory-0.0.8.tar.gz",
"platform": "any",
"description": "# Sage\n\nsage-directory is a python package that offers a detailed overview of folder contents and streamlines the process of copying and managing directories. It is designed to enhance productivity and simplify file management. It provides details of folder contents, including the file types, size, and subfolder structures, enabling quick insights into the organization of your directory. \n\nBeyond analysis, the tool offers robust functionality for copying entire folders, ensuring seamless management and replication of data environments. Whether you're organizing complex project files, backing up critical datasets, or duplicating environments, this tool is built to optimize your workflow.\n\n## Installation\n```\npip install sage-directory\n```\n\n## Usage\n### Main Features\nComprehensive Folder Overview\n##\nGenerate detailed summaries of folder contents, including file types, sizes, and subfolder structures, \n\n```python\nimport sage\n\nsage.get_folder_overview('.')\n```\n\n<table>\n <tr>\n <td>Path</td>\n <td>Folder Name</td>\n <td>Is Folder?</td>\n <td>File Name</td>\n <td>File Size (Bytes)</td>\n <td>File Extensions</td>\n <td>Number of Files in Folder</td>\n <td>Depth</td>\n </tr>\n <tr>\n <td>./bathoom.py</td>\n <td>.</td>\n <td>False</td>\n <td>bathoom_cal.py</td>\n <td>2151</td>\n <td>.py</td>\n <td>0</td>\n <td>0</td>\n </tr>\n <tr>\n <td>./kitchen.png</td>\n <td>.</td>\n <td>False</td>\n <td>kitchen.png</td>\n <td>2151</td>\n <td>.png</td>\n <td>0</td>\n <td>0</td>\n </tr>\n <tr>\n <td>./shops</td>\n <td>shops</td>\n <td>True</td>\n <td>N/A</td>\n <td>0</td>\n <td>N/A</td>\n <td>2</td>\n <td>1</td>\n </tr>\n</table>\n\n\nSelective Copying\n##\nChoose a specific file to overwrite another in multiple directories\n\n```python\nimport sage\n\n# overwrites the entered filename (basement.png) in the renovated_kitchen folder with the file in kitchen_catelog folder\n\nsage.batch_file_overwrite(./kitchen_catelog, ./renovated_kitchen, \"basement.png\")\n\n```\n\n\nBatch Operations\n##\nPerform operations on multiple directories\n\n```python\nimport sage\n\n# only copies 10 folders that are in the kitchen_catelog that share the same folder names as those in the old_kitchen folder in the renovated_kitchen folder\n\nsage.copy_num_folders(./old_kitchen, ./kitchen_catelog, ./renovated_kitchen, 10)\n\n# only copies folders that are in the kitchen_catelog that share the same folder names as those in the old_kitchen folder in the renovated_kitchen folder\n\nsage.copy_folders(./old_kitchen, ./kitchen_catelog, ./renovated_kitchen)\n\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "sage-directory is a python package that offers a detailed overview of folder contents and streamlines the process of copying and managing directories.",
"version": "0.0.8",
"project_urls": {
"Homepage": "https://github.com/maxineattobrah/sage-directory"
},
"split_keywords": [
"python",
" folder overview",
" folder management",
" folder analysis",
" batch operations",
" data science utility",
" data engineering utility",
" it operations"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fd585c7c790d572fc42fb9d76495afe9e2ff88360f131d3ea094ad785ad0eb06",
"md5": "894360eaec0a823aec7505843f2a107b",
"sha256": "c926ffa20800e8ee3693ad213131ea7716787f155b99aa02ba9e5e6700c54303"
},
"downloads": -1,
"filename": "sage_directory-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "894360eaec0a823aec7505843f2a107b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5845,
"upload_time": "2024-08-31T23:38:01",
"upload_time_iso_8601": "2024-08-31T23:38:01.595111Z",
"url": "https://files.pythonhosted.org/packages/fd/58/5c7c790d572fc42fb9d76495afe9e2ff88360f131d3ea094ad785ad0eb06/sage_directory-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a47348b8707d65f7e918fea87f326b915622c90bca4448e474f28b0beb0b3332",
"md5": "3e617669d5c8616ef81f10b8e831bc21",
"sha256": "a6e84cd3cbd45750d543e79adc47d495397108e5ad7ad851ce40fce9ae03a16a"
},
"downloads": -1,
"filename": "sage-directory-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "3e617669d5c8616ef81f10b8e831bc21",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3948,
"upload_time": "2024-08-31T23:38:03",
"upload_time_iso_8601": "2024-08-31T23:38:03.156703Z",
"url": "https://files.pythonhosted.org/packages/a4/73/48b8707d65f7e918fea87f326b915622c90bca4448e474f28b0beb0b3332/sage-directory-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-31 23:38:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maxineattobrah",
"github_project": "sage-directory",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pandas",
"specs": [
[
"==",
"2.2.2"
]
]
}
],
"lcname": "sage-directory"
}
JSON
