Metadata-Version: 2.4
Name: chtoolbox
Version: 1.4.0
Summary: Various Python tools used in daily work
License-Expression: MIT
Project-URL: Homepage, https://github.com/chagenvik/chtoolbox
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.26.2
Requires-Dist: pandas>=2.1.4
Requires-Dist: pathspec>=0.12.1
Dynamic: license-file

# chtoolbox
chtoolbox is a library containing various python tools used in my daily work

## Installation
To install chtoolbox, use pip:

```sh
pip install chtoolbox
```

## Usage
Examples are provided in the `examples` folder in the repository.

### Folder size check
Use `check_folder_sizes` to inspect the direct files and subfolders inside a folder. Subfolder sizes include all files recursively below each subfolder.

```python
from chtoolbox.misc import check_folder_sizes

sizes = check_folder_sizes('.')
```

After installing the package, you can also run the same check directly from CMD:

```sh
chfolder-size
chfolder-size C:\path\to\folder
chfolder-size C:\path\to\folder --sort-by name --ascending
```

If Windows blocks generated `.exe` launchers in your environment, run the same command through Python instead:

```sh
python -m chtoolbox.folder_size
python -m chtoolbox.folder_size C:\path\to\folder
python -m chtoolbox.folder_size C:\path\to\folder --sort-by name --ascending
```

## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
