filesysman 1.0.0__tar.gz

filesysman-1.0.0/LICENSE

@@ -0,0 +1 @@
+MIT License

filesysman-1.0.0/PKG-INFO

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: filesysman
+Version: 1.0.0
+Summary: Utilities for managing files and folders in Python.
+Author: Saif Bayoumy
+License-Expression: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# filesysman
+
+A simple Python library for creating, managing, searching, copying, moving, and organizing files and folders.
+
+## Features
+
+- Create and delete files and folders
+- Read, write, and append file content
+- Rename files and folders
+- Copy and move files and folders
+- Search for files by keyword
+- Search recursively through subfolders
+- Find files by extension
+- Organize files by extension
+- Get information about files and folders
+- Count files
+- Find and remove empty folders
+- Work with multiple files at once
+
+## Installation
+
+Install the package using pip:
+
+    pip install filesysman
+
+## Quick Start
+
+### Working with Files
+
+    from filesysman import File
+
+    file = File("example.txt")
+
+    file.create()
+    file.write("Hello, World!")
+
+    print(file.read())
+    print(file.name)
+    print(file.suffix)
+    print(file.size)
+
+### Working with Folders
+
+    from filesysman import Folder
+
+    folder = Folder("my_folder")
+
+    folder.create()
+
+    print(folder.exists())
+    print(folder.name)
+    print(folder.path)
+
+### Working with Multiple Files
+
+    from filesysman import create_files, get_files
+
+    create_files(
+        "file1.txt",
+        "file2.txt",
+        "file3.txt"
+    )
+
+    files = get_files()
+
+    for file in files:
+        print(file)
+
+## Searching for Files
+
+Search for files containing a specific keyword in their names:
+
+    from filesysman import find_files
+
+    files = find_files("report")
+
+    for file in files:
+        print(file)
+
+You can also search recursively through subfolders:
+
+    from filesysman import find_files_recursive
+
+    files = find_files_recursive("report")
+
+    for file in files:
+        print(file)
+
+## Organizing Files by Extension
+
+Files can be organized into folders based on their extensions:
+
+    from filesysman import organize_by_extension
+
+    organize_by_extension()
+
+For example:
+
+    Before:
+
+    folder/
+    ├── photo.jpg
+    ├── document.pdf
+    ├── script.py
+    └── notes.txt
+
+    After:
+
+    folder/
+    ├── JPG/
+    │   └── photo.jpg
+    ├── PDF/
+    │   └── document.pdf
+    ├── PY/
+    │   └── script.py
+    └── TXT/
+        └── notes.txt
+
+## Main API
+
+### Classes
+
+- File
+- Folder
+
+### File and Folder Operations
+
+- create_files()
+- delete_files()
+- rename_files()
+- copy_files()
+- move_files()
+
+### Searching and Retrieving
+
+- get_files()
+- find_files()
+- get_files_count()
+- get_files_recursive()
+- find_files_recursive()
+- get_folders()
+
+### Organization and Cleanup
+
+- organize_by_extension()
+- rename_by_keyword()
+- delete_by_keyword()
+- clear_empty_folders()
+
+## Requirements
+
+- Python 3.8 or newer
+
+## License
+
+This project is licensed under the MIT License.

filesysman-1.0.0/README.md

@@ -0,0 +1,156 @@
+# filesysman
+
+A simple Python library for creating, managing, searching, copying, moving, and organizing files and folders.
+
+## Features
+
+- Create and delete files and folders
+- Read, write, and append file content
+- Rename files and folders
+- Copy and move files and folders
+- Search for files by keyword
+- Search recursively through subfolders
+- Find files by extension
+- Organize files by extension
+- Get information about files and folders
+- Count files
+- Find and remove empty folders
+- Work with multiple files at once
+
+## Installation
+
+Install the package using pip:
+
+    pip install filesysman
+
+## Quick Start
+
+### Working with Files
+
+    from filesysman import File
+
+    file = File("example.txt")
+
+    file.create()
+    file.write("Hello, World!")
+
+    print(file.read())
+    print(file.name)
+    print(file.suffix)
+    print(file.size)
+
+### Working with Folders
+
+    from filesysman import Folder
+
+    folder = Folder("my_folder")
+
+    folder.create()
+
+    print(folder.exists())
+    print(folder.name)
+    print(folder.path)
+
+### Working with Multiple Files
+
+    from filesysman import create_files, get_files
+
+    create_files(
+        "file1.txt",
+        "file2.txt",
+        "file3.txt"
+    )
+
+    files = get_files()
+
+    for file in files:
+        print(file)
+
+## Searching for Files
+
+Search for files containing a specific keyword in their names:
+
+    from filesysman import find_files
+
+    files = find_files("report")
+
+    for file in files:
+        print(file)
+
+You can also search recursively through subfolders:
+
+    from filesysman import find_files_recursive
+
+    files = find_files_recursive("report")
+
+    for file in files:
+        print(file)
+
+## Organizing Files by Extension
+
+Files can be organized into folders based on their extensions:
+
+    from filesysman import organize_by_extension
+
+    organize_by_extension()
+
+For example:
+
+    Before:
+
+    folder/
+    ├── photo.jpg
+    ├── document.pdf
+    ├── script.py
+    └── notes.txt
+
+    After:
+
+    folder/
+    ├── JPG/
+    │   └── photo.jpg
+    ├── PDF/
+    │   └── document.pdf
+    ├── PY/
+    │   └── script.py
+    └── TXT/
+        └── notes.txt
+
+## Main API
+
+### Classes
+
+- File
+- Folder
+
+### File and Folder Operations
+
+- create_files()
+- delete_files()
+- rename_files()
+- copy_files()
+- move_files()
+
+### Searching and Retrieving
+
+- get_files()
+- find_files()
+- get_files_count()
+- get_files_recursive()
+- find_files_recursive()
+- get_folders()
+
+### Organization and Cleanup
+
+- organize_by_extension()
+- rename_by_keyword()
+- delete_by_keyword()
+- clear_empty_folders()
+
+## Requirements
+
+- Python 3.8 or newer
+
+## License
+
+This project is licensed under the MIT License.

filesysman-1.0.0/filesysman/__init__.py

@@ -0,0 +1,20 @@
+from .filesysman import (
+    File,
+    Folder,
+    create_files,
+    delete_files,
+    rename_files,
+    get_files,
+    find_files,
+    rename_by_keyword,
+    delete_by_keyword,
+    get_files_count,
+    copy_files,
+    move_files,
+    organize_by_extension,
+    get_files_recursive,
+    find_files_recursive,
+    get_folders,
+    clear_empty_files,
+    clear_empty_folders,
+)