Metadata-Version: 2.4
Name: wixok.folder
Version: 25.8.2
Summary: Simple Python package for folder operations.
Author-email: Wixok <contact@wixok.com>
Maintainer-email: Mohammed Dellihr <mohammeddellihr@maildoo.com>
License: The MIT License (MIT)
        
        Copyright (c) 2025 Mohammed Dellihr
        
        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.
Project-URL: Repository, https://github.com/wixok/folder
Project-URL: Issues, https://github.com/wixok/folder/issues
Keywords: folder,folders,folder-management
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Dynamic: license-file

# folder

Simple Python package for folder operations.

## Install

```bash
pip install wixok.folder
```

## Usage

```python
from wixok.folder import Folder

# Check if a folder exists
exists = Folder.exists("/tmp/myfolder")
print(exists)  # True

# Create a folder
success = Folder.create("/tmp", "myfolder")
print(success)  # True

# Delete the folder
deleted = Folder.delete("/tmp/myfolder")
print(deleted)  # True

# Get the current working directory
cwd = Folder.cwd()
print(cwd)  # e.g., '/home/user/project'
```

## Methods

| Method | Description | Returns |
|--------|-------------|---------|
| `Folder.exists(path)` | Check if a folder exists and is a directory | `bool` |
| `Folder.create(path, name="")` | Create a folder at the given path (and optional subfolder name) | `bool` |
| `Folder.delete(path)` | Delete a folder at the given path | `bool` |
| `Folder.cwd()` | Get the current working directory path | `str` |

## Debug Mode

```python
folder.debug = True  # Enable error messages
```
