add dirganize

Author: aahnik

dirganize/__init__.py

@@ -0,0 +1,17 @@
+"""Package dirganize.
+
+Declutter you folders and get peace of mind.
+A command-line tool to organize files into category directories.
+
+MIT License
+
+Copyright (c) 2021 Aahnik Daw
+
+https://github.com/aahnik/dirganize
+"""
+
+from importlib.metadata import version
+
+from dirganize.dirganize import dirganize
+
+__version__ = version(__package__)

dirganize/cli.py

@@ -0,0 +1,67 @@
+"""Command line interface for dirganize."""
+
+import logging
+import os
+from typing import Optional
+
+import typer
+from rich.logging import RichHandler
+
+from dirganize import __version__
+from dirganize.dirganize import dirganize
+
+app = typer.Typer(add_completion=False)
+
+
+def version_callback(value: bool):
+    """Show current version and exit."""
+    if value:
+        print(__version__)
+        raise typer.Exit()
+
+
+def verbosity_callback(value: bool):
+    """Set logging level."""
+    if value:
+        logging.basicConfig(
+            level=logging.INFO,
+            format="[dim]%(name)s[/dim]\t%(message)s",
+            handlers=[
+                RichHandler(
+                    markup=True,
+                    show_path=False,
+                )
+            ],
+        )
+        logging.info("Loud logging enabled.")
+
+
+@app.command()
+def main(
+    path: str = typer.Option(
+        os.getcwd(),
+        "--path",
+        "-p",
+        help="Path of the directory to dirganize",
+    ),
+    verbose: Optional[bool] = typer.Option(  # pylint: disable=unused-argument
+        None,
+        "--loud",
+        "-l",
+        callback=verbosity_callback,
+        envvar="LOUD",
+        help="Increase output verbosity.",
+    ),
+    version: Optional[bool] = typer.Option(  # pylint: disable=unused-argument
+        None,
+        "--version",
+        "-v",
+        callback=version_callback,
+        help="Show version and exit.",
+    ),
+):
+    """Declutter you folders and get peace of mind.
+
+    A command-line tool to organize files into category directories.
+    """
+    dirganize(path=path)

dirganize/conf.py

@@ -0,0 +1,29 @@
+"""Configuration manager for dirganize."""
+
+import logging
+import os
+from typing import Dict
+
+import yaml
+
+CONFIG_FILE = ".dirganize.yml"
+
+
+def get_mapping() -> Dict[str, str]:
+    """Parse the .dirganize.yml file and return mapping of extension -> folder."""
+    structure = {"Documents": ["pdf", "docx"]}
+    mapping = {}
+
+    if os.path.isfile(CONFIG_FILE):
+        with open(CONFIG_FILE) as stream:
+            structure.update(yaml.safe_load(stream))
+
+    logging.info(structure)
+
+    for folder, extensions in structure.items():
+        for ext in extensions:
+            mapping[ext] = folder
+
+    logging.info(mapping)
+
+    return mapping

dirganize/dirganize.py

@@ -0,0 +1,46 @@
+"""Dirganize your directory."""
+
+import logging
+import os
+from mimetypes import guess_type
+from typing import Dict
+
+from rich.progress import track
+
+from dirganize.conf import get_mapping
+
+
+def _guess_type(filename) -> str:
+    try:
+        return guess_type(filename)[0].split("/")[0].title() + "s"  # type: ignore
+    except:  # pylint: disable=bare-except
+        return "Others"
+
+
+def _get_dir(filename: str, mapping: Dict[str, str]) -> str:
+    ext = filename.split(".")[-1]
+    folder = mapping.get(ext)
+    if not folder:
+        folder = _guess_type(filename)
+    return folder
+
+
+def dirganize(path: str):
+    """Organizes files into folders."""
+    os.chdir(path)
+    mapping = get_mapping()
+    logging.info("Current working directory is %s", os.getcwd())
+    all_files = [file for file in os.listdir() if os.path.isfile(file)]
+    logging.info(all_files)
+
+    for file in track(all_files, description="Moving files "):
+        if file.startswith("."):
+            continue
+        new_parent_dir = _get_dir(file, mapping)
+        if new_parent_dir:
+            new_file = os.path.join(new_parent_dir, file)
+            if not os.path.isdir(new_parent_dir):
+                os.makedirs(new_parent_dir)
+            os.rename(file, new_file)
+            logging.info("%s renamed to %s", file, new_file)
+    return os.walk(".")