miss-lemon 0.2.0__tar.gz

miss_lemon-0.2.0/LICENCE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026, David Thenon
+
+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.

miss_lemon-0.2.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include MANIFEST.in
+include LICENCE.txt
+include README.rst
+
+exclude sphinx_reload.py
+
+recursive-exclude tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

miss_lemon-0.2.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: miss-lemon
+Version: 0.2.0
+Summary: Rename a file structure with auto incremented prefix number
+Home-page: https://github.com/sveetch/miss-lemon
+Author: David Thenon
+Author-email: sveetch@gmail.com
+License: MIT
+Project-URL: Source Code, https://github.com/sveetch/miss-lemon
+Project-URL: Issue Tracker, https://github.com/sveetch/miss-lemon/issues
+Project-URL: Changelog, https://miss-lemon.readthedocs.io/en/latest/history.html
+Project-URL: Documentation, https://miss-lemon.readthedocs.io/
+Keywords: Python
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENCE.txt
+Requires-Dist: click>=8.0
+Requires-Dist: colorlog
+Requires-Dist: bigtree>=1.5.3
+Provides-Extra: rich
+Requires-Dist: rich-click<2.0.0,>=1.9.9; extra == "rich"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Provides-Extra: quality
+Requires-Dist: flake8>=6.0.0; extra == "quality"
+Requires-Dist: tox>=4.11.0; extra == "quality"
+Provides-Extra: doc
+Requires-Dist: sphinx>=8.0.2; extra == "doc"
+Requires-Dist: furo>=2024.8.6; extra == "doc"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
+Provides-Extra: doc-live
+Requires-Dist: livereload>=2.6.0; extra == "doc-live"
+Provides-Extra: release
+Requires-Dist: twine>=5.0.0; extra == "release"
+Dynamic: license-file
+
+.. _Python: https://www.python.org/
+.. _Click: https://click.palletsprojects.com
+.. _Big Tree: https://bigtree.readthedocs.io/
+.. _rich-click: https://ewels.github.io/rich-click/latest/
+
+
+==========
+Miss Lemon
+==========
+
+Miss Lemon is tool to rename resources (files and directories) with a prefix like
+``0010_stuff/`` or ``0011_foo.py``.
+
+The purpose of numbering resources is to organize them in order.
+
+This tool helps to do it automatically without to rename them each time you introduce
+a new resource or shift some ones.
+
+
+Dependencies
+************
+
+* `Python`_>=3.8;
+* `Click`_>=8.0;
+* `Big Tree`_>=1.5.3;
+* Optionnally `rich-click`_>=1.9.9, <2.0.0;
+
+Links
+*****
+
+* Read the documentation on `Read the docs <https://miss-lemon.readthedocs.io/>`_;
+* Download its `PyPi package <https://pypi.python.org/pypi/miss-lemon>`_;
+* Clone it on its `Github repository <https://github.com/sveetch/miss-lemon>`_;

miss_lemon-0.2.0/README.rst

@@ -0,0 +1,33 @@
+.. _Python: https://www.python.org/
+.. _Click: https://click.palletsprojects.com
+.. _Big Tree: https://bigtree.readthedocs.io/
+.. _rich-click: https://ewels.github.io/rich-click/latest/
+
+
+==========
+Miss Lemon
+==========
+
+Miss Lemon is tool to rename resources (files and directories) with a prefix like
+``0010_stuff/`` or ``0011_foo.py``.
+
+The purpose of numbering resources is to organize them in order.
+
+This tool helps to do it automatically without to rename them each time you introduce
+a new resource or shift some ones.
+
+
+Dependencies
+************
+
+* `Python`_>=3.8;
+* `Click`_>=8.0;
+* `Big Tree`_>=1.5.3;
+* Optionnally `rich-click`_>=1.9.9, <2.0.0;
+
+Links
+*****
+
+* Read the documentation on `Read the docs <https://miss-lemon.readthedocs.io/>`_;
+* Download its `PyPi package <https://pypi.python.org/pypi/miss-lemon>`_;
+* Clone it on its `Github repository <https://github.com/sveetch/miss-lemon>`_;

miss_lemon-0.2.0/copy_tests/conftest.py

@@ -0,0 +1,97 @@
+"""
+Pytest fixtures
+"""
+import shutil
+from pathlib import Path
+
+import pytest
+
+import miss_lemon
+
+
+class FixturesSettingsTestMixin(object):
+    """
+    A mixin containing settings about application. This is almost only about useful
+    paths which may be used in tests.
+
+    Attributes:
+        application_path (pathlib.Path): Absolute path to the application directory.
+        package_path (pathlib.Path): Absolute path to the package directory.
+        tests_dir (pathlib.Path): Directory name which include tests.
+        tests_path (pathlib.Path): Absolute path to the tests directory.
+        datas_dir (pathlib.Path): Directory name which include tests datas.
+        datas_path (pathlib.Path): Absolute path to the tests datas.
+    """
+    def __init__(self):
+        self.application_path = Path(
+            miss_lemon.__file__
+        ).parents[0].resolve()
+
+        self.package_path = self.application_path.parent
+
+        self.tests_dir = "tests"
+        self.tests_path = self.package_path / self.tests_dir
+
+        self.datas_dir = "data_fixtures"
+        self.datas_path = self.tests_path / self.datas_dir
+
+    def format(self, content):
+        """
+        Format given string to include some values related to this application.
+
+        Arguments:
+            content (str): Content string to format with possible values.
+
+        Returns:
+            str: Given string formatted with possible values.
+        """
+        return content.format(
+            HOMEDIR=Path.home(),
+            PACKAGE=str(self.package_path),
+            APPLICATION=str(self.application_path),
+            TESTS=str(self.tests_path),
+            FIXTURES=str(self.datas_path),
+            VERSION=miss_lemon.__version__,
+        )
+
+
+@pytest.fixture(scope="function")
+def temp_builds_dir(tmp_path):
+    """
+    Prepare a temporary build directory.
+
+    NOTE: You should use directly the "tmp_path" fixture in your tests.
+    """
+    return tmp_path
+
+
+@pytest.fixture(scope="module")
+def settings():
+    """
+    Initialize and return settings for tests.
+
+    Example:
+        You may use it like: ::
+
+            def test_foo(settings):
+                print(settings.package_path)
+                print(settings.format("Application version: {VERSION}"))
+    """
+    return FixturesSettingsTestMixin()
+
+
+@pytest.fixture(scope="function")
+def basic_structure(tmp_path, settings):
+    """
+    Copy the "basic_suite" structure into a temporary directory.
+
+    Returns:
+        Path: The path to the copied structure in temp directory.
+    """
+    dirname = "basic_structure"
+    basic_sample_path = settings.datas_path / dirname
+    destination = tmp_path / dirname
+
+    shutil.copytree(basic_sample_path, destination)
+
+    return destination

miss_lemon-0.2.0/miss_lemon/__init__.py

@@ -0,0 +1,6 @@
+"""Rename a file structure with auto incremented prefix number"""
+from importlib.metadata import version
+
+
+__pkgname__ = "miss-lemon"
+__version__ = version(__pkgname__)

miss_lemon-0.2.0/miss_lemon/cli/check.py

@@ -0,0 +1,126 @@
+from pathlib import Path
+
+from ..walker import DirWalker
+from ..diff import DiffTree
+
+# On default rich is not present in outputs and may become available further
+AVAILABLE_OUTPUTS = ["json", "tree"]
+# On default Big tree output is prefered
+DEFAULT_OUTPUT = "tree"
+# First try to get Rich stack, fallback to basic Click and BigTree
+try:
+    import rich_click as click
+except ImportError:
+    import click
+else:
+    from rich import print as RichPrint
+    # Append Rich to output and make it the default one
+    AVAILABLE_OUTPUTS.append("rich")
+    DEFAULT_OUTPUT = "rich"
+
+
+@click.command()
+@click.argument(
+    "source",
+    nargs=1,
+    type=click.Path(
+        exists=True,
+        file_okay=False,
+        dir_okay=True,
+        path_type=Path,
+        resolve_path=True,
+    )
+)
+@click.option(
+    "--step",
+    metavar="INTEGER",
+    show_default=True,
+    type=click.INT,
+    default=100,
+    help=(
+        "The lowest number slot step for the leaf resources."
+    ),
+)
+@click.option(
+    "--output",
+    metavar="NAME",
+    show_default=True,
+    type=click.Choice(AVAILABLE_OUTPUTS),
+    help=(
+        "Report output format name. 'json' will print a dictionnary of computed "
+        "resources. 'tree' and 'rich' are similar but the latter one "
+        "is only allowed if the rich stack has been installed, it will provide colored "
+        "nodes (according to their status). Both will print a tree of differences "
+        "between original and renamed tree"
+    ),
+    default=DEFAULT_OUTPUT,
+)
+@click.option(
+    "--unprefixed",
+    is_flag=True,
+    help=(
+        "Allows to collect all resource even if they don't match the regex for "
+        "\"filename with prefix\" (eg: '0001_foo'). Default behavior when this option "
+        "is not enabled, is to ignore those files without prefix, they won't be "
+        "renamed. This is commonly used with '--excludes' to prevent some resources to "
+        "be renamed."
+    ),
+)
+@click.option(
+    "--excludes",
+    metavar="PATTERN",
+    show_default=True,
+    multiple=True,
+    help=(
+        "Define a 'Unix filename pattern'(compatible with Python module 'fnmatch') to "
+        "exclude resources from collect. This can be defined multiple times."
+    ),
+)
+@click.option(
+    "--from-original",
+    is_flag=True,
+    help=(
+        "If enabled, the tree will display the original name first then the renamed "
+        "name. On default the renamed name is printed first."
+    ),
+)
+@click.pass_context
+def check_command(context, source, step, output, unprefixed, excludes, from_original):
+    """
+    Proceed to analyze and prefix computation on a path then output a report.
+
+    This does not write or rename anything.
+
+    The preview report can be either a JSON payload or a tree of the original structure
+    including a preview of renaming that would occurs with the command 'rename'.
+    """
+    logger = context.obj["logger"]
+
+    logger.debug("Working on: {}".format(source))
+    logger.debug("Select output: {}".format(output))
+    logger.debug("Collecting resource without prefix: {}".format(unprefixed))
+    if excludes:
+        logger.debug("Excludes: {}".format(", ".join(excludes)))
+
+    # Collect and compute with user options
+    new_walker = DirWalker(source, allow_unprefixed=unprefixed, excludes=excludes)
+    new_root = new_walker.compute(step=step)
+
+    # Just print output as simple JSON
+    if output == "json":
+        click.echo(new_root.as_json())
+        return
+
+    differ = DiffTree(source_first=from_original)
+
+    # Collect the full structure without any exclusions
+    original_walker = DirWalker(source, allow_unprefixed=True)
+    original_root = original_walker.collect()
+
+    # Print tree preview with differences report
+    if output == "tree":
+        click.echo("🎨 Big Tree preview")
+        click.echo(differ.build_bigtree(original_root, new_root).show(alias="label"))
+    elif output == "rich":
+        click.echo("🎨 Rich tree preview")
+        RichPrint(differ.build_richtree(original_root, new_root))

miss_lemon-0.2.0/miss_lemon/cli/entrypoint.py

@@ -0,0 +1,70 @@
+"""
+Main entrance to commandline actions
+"""
+try:
+    import rich_click as click
+except ImportError:
+    import click
+else:
+    # This is rich-click option only to show arguments in help
+    click.rich_click.SHOW_ARGUMENTS = True
+
+from miss_lemon.logger import init_logger
+
+from miss_lemon import __pkgname__
+from miss_lemon.cli.version import version_command
+from miss_lemon.cli.check import check_command
+from miss_lemon.cli.rename import rename_command
+
+
+# Help alias on "-h" argument
+CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
+
+
+# Default logger conf
+APP_LOGGER_CONF = ("DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL", None)
+
+
+@click.group(context_settings=CONTEXT_SETTINGS)
+@click.option(
+    "-v", "--verbose",
+    type=click.IntRange(min=0, max=5),
+    default=4,
+    metavar="INTEGER",
+    help=(
+        "An integer between 0 and 5, where '0' make a totaly "
+        "silent output and '5' set level to DEBUG (the most verbose "
+        "level). Default to '4' (Info level)."
+    )
+)
+@click.pass_context
+def cli_frontend(ctx, verbose):
+    """
+    Script for application commandline entrypoint.
+    """
+    printout = True
+    if verbose == 0:
+        verbose = 1
+        printout = False
+
+    # Verbosity is the inverse of logging levels
+    levels = [item for item in APP_LOGGER_CONF]
+    levels.reverse()
+    # Init the logger config
+    root_logger = init_logger(
+        __pkgname__,
+        levels[verbose],
+        printout=printout
+    )
+
+    # Init the default context that will be passed to commands
+    ctx.obj = {
+        "verbosity": verbose,
+        "logger": root_logger,
+    }
+
+
+# Attach commands methods to the main grouper
+cli_frontend.add_command(version_command, name="version")
+cli_frontend.add_command(check_command, name="check")
+cli_frontend.add_command(rename_command, name="rename")

miss_lemon-0.2.0/miss_lemon/cli/rename.py

@@ -0,0 +1,86 @@
+from pathlib import Path
+
+from ..walker import DirWalker
+from ..renamer import Renamer
+
+try:
+    import rich_click as click
+except ImportError:
+    import click
+
+
+@click.command()
+@click.argument(
+    "source",
+    nargs=1,
+    type=click.Path(
+        exists=True,
+        file_okay=False,
+        dir_okay=True,
+        path_type=Path,
+        resolve_path=True,
+    )
+)
+@click.option(
+    "--step",
+    metavar="INTEGER",
+    show_default=True,
+    type=click.INT,
+    default=100,
+    help=(
+        "The lowest number slot step for the leaf resources."
+    ),
+)
+@click.option(
+    "--command",
+    metavar="NAME",
+    show_default=True,
+    type=click.Choice(["mv", "git-mv"]),
+    help="Command name. All resource renaming lines will use this command.",
+    default="mv",
+)
+@click.option(
+    "--unprefixed",
+    is_flag=True,
+    help=(
+        "Allows to collect all resource even if they don't match the regex for "
+        "\"filename with prefix\" (eg: '0001_foo'). Default behavior when this option "
+        "is not enabled, is to ignore those files without prefix, they won't be "
+        "renamed. This is commonly used with '--exclude' to prevent some resources to "
+        "be renamed."
+    ),
+)
+@click.option(
+    "--excludes",
+    metavar="PATTERN",
+    multiple=True,
+    help=(
+        "Define a 'Unix filename pattern'(compatible with Python module 'fnmatch') to "
+        "exclude resources from collect. This can be defined multiple times."
+    ),
+)
+@click.pass_context
+def rename_command(context, source, step, command, unprefixed, excludes):
+    """
+    Rename resources (directories and files) from a path with a computed number prefix.
+    """
+    logger = context.obj["logger"]
+
+    logger.debug("Working on: {}".format(source))
+    logger.debug("Selected command: {}".format(command))
+    logger.debug("Collecting resource without prefix: {}".format(unprefixed))
+    if excludes:
+        logger.debug("Excludes: {}".format(", ".join(excludes)))
+
+    walker = DirWalker(source, allow_unprefixed=unprefixed, excludes=excludes)
+
+    root = walker.compute(step=step)
+
+    renamer = Renamer(root)
+
+    if command == "mv":
+        cmd_output = renamer.with_shell_mv()
+    elif command == "git-mv":
+        cmd_output = renamer.with_shell_gitmv()
+
+    click.echo(cmd_output)

miss_lemon-0.2.0/miss_lemon/cli/version.py

@@ -0,0 +1,15 @@
+try:
+    import rich_click as click
+except ImportError:
+    import click
+
+from miss_lemon import __version__
+
+
+@click.command()
+@click.pass_context
+def version_command(context):
+    """
+    Print out version information.
+    """
+    click.echo("miss-lemon {}".format(__version__))