chtoolbox 1.2.0__tar.gz → 1.4.0__tar.gz

chtoolbox-1.4.0/PKG-INFO

@@ -0,0 +1,54 @@
+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.

chtoolbox-1.4.0/README.md

@@ -0,0 +1,40 @@
+# 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.

chtoolbox-1.4.0/chtoolbox/folder_size.py

@@ -0,0 +1,12 @@
+"""Command line entry point for folder size checks."""
+
+from .misc import folder_sizes_cli
+
+
+def main(argv=None):
+    """Run the folder size command line interface."""
+    folder_sizes_cli(argv)
+
+
+if __name__ == '__main__':
+    main()

{chtoolbox-1.2.0 → chtoolbox-1.4.0}/chtoolbox/misc.py

@@ -21,8 +21,113 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 """
 
-import pandas as pd
 from itertools import product
+from pathlib import Path
+import argparse
+
+import pandas as pd
+
+
+def _get_path_size(path: Path) -> int:
+    """Return file bytes for a file or total recursive bytes for a folder."""
+    if path.is_file():
+        return path.stat().st_size
+
+    total_size = 0
+    for child in path.rglob('*'):
+        if child.is_file():
+            total_size += child.stat().st_size
+
+    return total_size
+
+
+def _format_file_size(size_bytes: int) -> str:
+    """Format bytes as a compact human-readable file size."""
+    size = float(size_bytes)
+    for unit in ['B', 'KB', 'MB', 'GB', 'TB']:
+        if size < 1024 or unit == 'TB':
+            if unit == 'B':
+                return f'{int(size)} {unit}'
+            return f'{size:.2f} {unit}'
+        size /= 1024
+
+
+def check_folder_sizes(folder='.', sort_by='size', reverse=True):
+    """
+    Get sizes for direct files and subfolders inside a folder.
+
+    Subfolder sizes include all files recursively below each subfolder.
+
+    Parameters
+    ----------
+    folder : str or pathlib.Path, optional
+        Folder to inspect. Defaults to the current working folder.
+    sort_by : {'size', 'name', 'type'}, optional
+        Field used to sort the result. Defaults to 'size'.
+    reverse : bool, optional
+        Sort descending when True. Defaults to True.
+
+    Returns
+    -------
+    list of dict
+        One dictionary per direct child with name, path, type, size_bytes and size.
+
+    Examples
+    --------
+    >>> check_folder_sizes('.')
+    [{'name': 'README.md', 'path': 'README.md', 'type': 'file', 'size_bytes': 154, 'size': '154 B'}]
+    """
+    folder_path = Path(folder).expanduser().resolve()
+
+    if not folder_path.exists():
+        raise FileNotFoundError(f'Folder does not exist: {folder_path}')
+    if not folder_path.is_dir():
+        raise NotADirectoryError(f'Path is not a folder: {folder_path}')
+    if sort_by not in {'size', 'name', 'type'}:
+        raise ValueError("sort_by must be one of: 'size', 'name', 'type'")
+
+    items = []
+    for child in folder_path.iterdir():
+        size_bytes = _get_path_size(child)
+        items.append({
+            'name': child.name,
+            'path': str(child),
+            'type': 'folder' if child.is_dir() else 'file',
+            'size_bytes': size_bytes,
+            'size': _format_file_size(size_bytes),
+        })
+
+    sort_key = 'size_bytes' if sort_by == 'size' else sort_by
+    return sorted(items, key=lambda item: item[sort_key], reverse=reverse)
+
+
+def _print_folder_sizes(items):
+    """Print folder size results as a simple table."""
+    if not items:
+        print('No files or folders found.')
+        return
+
+    name_width = max(len('Name'), *(len(item['name']) for item in items))
+    type_width = max(len('Type'), *(len(item['type']) for item in items))
+    size_width = max(len('Size'), *(len(item['size']) for item in items))
+
+    print(f"{'Name':<{name_width}}  {'Type':<{type_width}}  {'Size':>{size_width}}")
+    print(f"{'-' * name_width}  {'-' * type_width}  {'-' * size_width}")
+    for item in items:
+        print(f"{item['name']:<{name_width}}  {item['type']:<{type_width}}  {item['size']:>{size_width}}")
+
+
+def folder_sizes_cli(argv=None):
+    """Command line entry point for checking file and subfolder sizes."""
+    parser = argparse.ArgumentParser(description='Show sizes of files and subfolders in a folder.')
+    parser.add_argument('folder', nargs='?', default='.', help='Folder to inspect. Defaults to the current folder.')
+    parser.add_argument('--sort-by', choices=['size', 'name', 'type'], default='size', help='Sort output by this field.')
+    parser.add_argument('--ascending', action='store_true', help='Sort from smallest to largest or A to Z.')
+    args = parser.parse_args(argv)
+
+    items = check_folder_sizes(args.folder, sort_by=args.sort_by, reverse=not args.ascending)
+    _print_folder_sizes(items)
+
 
 def clipboard_to_dict(print_dict=True):
     """
@@ -247,4 +352,5 @@ def filter_dictionary(input_dict: dict, filter: str | list[str]) -> dict:
     
     filtered_dict = {key: value for key, value in input_dict.items() if any(f.lower() in key.lower() for f in filter)}
     
-    return filtered_dict
+    return filtered_dict
+

chtoolbox-1.4.0/chtoolbox.egg-info/PKG-INFO

@@ -0,0 +1,54 @@
+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.

{chtoolbox-1.2.0 → chtoolbox-1.4.0}/chtoolbox.egg-info/SOURCES.txt

@@ -1,14 +1,17 @@
 LICENSE
 README.md
-setup.py
+pyproject.toml
+requirements.txt
 chtoolbox/__init__.py
 chtoolbox/add_license.py
+chtoolbox/folder_size.py
 chtoolbox/misc.py
 chtoolbox/testing.py
 chtoolbox.egg-info/PKG-INFO
 chtoolbox.egg-info/SOURCES.txt
 chtoolbox.egg-info/dependency_links.txt
+chtoolbox.egg-info/entry_points.txt
 chtoolbox.egg-info/requires.txt
 chtoolbox.egg-info/top_level.txt
-tests/__init__.py
+tests/test_misc.py
 tests/test_testing.py

chtoolbox-1.4.0/chtoolbox.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+chfolder-size = chtoolbox.folder_size:main

{chtoolbox-1.2.0 → chtoolbox-1.4.0}/chtoolbox.egg-info/top_level.txt

@@ -1,2 +1 @@
 chtoolbox
-tests

chtoolbox-1.4.0/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["setuptools>=64", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "chtoolbox"
+version = "1.4.0"
+description = "Various Python tools used in daily work"
+readme = "README.md"
+requires-python = ">=3.10"
+dynamic = ["dependencies"]
+license = "MIT"
+license-files = ["LICENSE"]
+urls = {Homepage = "https://github.com/chagenvik/chtoolbox"}
+
+[project.scripts]
+chfolder-size = "chtoolbox.folder_size:main"
+
+[tool.setuptools.packages.find]
+include = ["chtoolbox*"]
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}

chtoolbox-1.4.0/requirements.txt

@@ -0,0 +1,3 @@
+numpy>=1.26.2
+pandas>=2.1.4
+pathspec>=0.12.1

chtoolbox-1.4.0/tests/test_misc.py

@@ -0,0 +1,60 @@
+"""MIT License
+
+Copyright (c) 2025 Christian Hågenvik
+
+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.
+"""
+
+from chtoolbox.misc import check_folder_sizes, folder_sizes_cli
+
+
+def test_check_folder_sizes_includes_files_and_recursive_folder_size(tmp_path):
+    file_path = tmp_path / 'file.txt'
+    file_path.write_text('abcd')
+
+    subfolder = tmp_path / 'subfolder'
+    subfolder.mkdir()
+    (subfolder / 'nested.txt').write_text('123456')
+
+    result = check_folder_sizes(tmp_path)
+    result_by_name = {item['name']: item for item in result}
+
+    assert result_by_name['file.txt']['type'] == 'file'
+    assert result_by_name['file.txt']['size_bytes'] == 4
+    assert result_by_name['subfolder']['type'] == 'folder'
+    assert result_by_name['subfolder']['size_bytes'] == 6
+
+
+def test_check_folder_sizes_can_sort_by_name(tmp_path):
+    (tmp_path / 'b.txt').write_text('b')
+    (tmp_path / 'a.txt').write_text('a')
+
+    result = check_folder_sizes(tmp_path, sort_by='name', reverse=False)
+
+    assert [item['name'] for item in result] == ['a.txt', 'b.txt']
+
+
+def test_folder_sizes_cli_prints_requested_folder(tmp_path, capsys):
+    (tmp_path / 'file.txt').write_text('abcd')
+
+    folder_sizes_cli([str(tmp_path), '--sort-by', 'name', '--ascending'])
+
+    output = capsys.readouterr().out
+    assert 'file.txt' in output
+    assert '4 B' in output

chtoolbox-1.2.0/PKG-INFO

@@ -1,22 +0,0 @@
-Metadata-Version: 2.1
-Name: chtoolbox
-Version: 1.2.0
-Home-page: https://github.com/chagenvik/chtoolbox
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# 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.
-
-## License
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

chtoolbox-1.2.0/README.md

@@ -1,15 +0,0 @@
-# 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.
-
-## License
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

chtoolbox-1.2.0/chtoolbox.egg-info/PKG-INFO

@@ -1,22 +0,0 @@
-Metadata-Version: 2.1
-Name: chtoolbox
-Version: 1.2.0
-Home-page: https://github.com/chagenvik/chtoolbox
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# 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.
-
-## License
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

chtoolbox-1.2.0/setup.py

@@ -1,46 +0,0 @@
-"""MIT License
-
-Copyright (c) 2025 Christian Hågenvik
-
-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.
-"""
-
-from setuptools import setup, find_packages
-from pathlib import Path
-
-# Read the requirements from the requirements.txt file
-requirements_path = Path(__file__).parent / 'requirements.txt'
-with requirements_path.open() as requirements_file:
-    requirements = requirements_file.read().splitlines()
-
-# Read the contents of the README file
-readme_path = Path(__file__).parent / 'README.md'
-with readme_path.open() as readme_file:
-    long_description = readme_file.read()
-
-setup(
-    name='chtoolbox',
-    version='1.2.0',
-    packages=find_packages(),
-    install_requires=requirements,
-    long_description=long_description,
-    long_description_content_type='text/markdown',
-    url='https://github.com/chagenvik/chtoolbox'
-)
-

chtoolbox-1.2.0/tests/__init__.py

@@ -1,23 +0,0 @@
-"""MIT License
-
-Copyright (c) 2025 Christian Hågenvik
-
-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.
-"""
-