mcserver-cli 4.2.0__py3-none-any.whl → 4.4.0__py3-none-any.whl

mcserver/__init__.py

@@ -1 +1 @@
-__version__ = "4.2.0"
+__version__ = "4.4.0"

mcserver/cli.py

@@ -1,115 +1,119 @@
-def main() -> int:
-    import argparse
-    import sys
-    from types import FunctionType
-
-    from . import __version__
-    from .modrinth.shared import search_sort_index
-    from .shared import loader_list
-
-    def bound_int(min_integer: int, max_integer: int | None = None) -> FunctionType:
-        def parse(cli_string: str) -> int:
-            try:
-                integer = int(cli_string)
-            except ValueError:
-                raise argparse.ArgumentTypeError(f"{cli_string} is not an integer")
-
-            if integer < min_integer:
-                raise argparse.ArgumentTypeError(
-                    f"{integer} must be higher than or equal to {min_integer}"
-                )
-            if max_integer is not None and integer > max_integer:
-                raise argparse.ArgumentTypeError(
-                    f"{integer} must be between {min_integer} and {max_integer} (inclusive)"
-                )
-            return integer
-
-        return parse
-
-    def command_function(args: argparse.Namespace) -> int:
-        command_name: str = args.command_name
-
-        match command_name:
-            case "add":
-                from .commands import add
-
-                return add(args)
-            case "import":
-                from .commands import import_setup
-
-                return import_setup(args)
-            case "help":
-                from .commands import print_help
-
-                return print_help(args)
-            case "init":
-                from .commands import init
-
-                return init(args)
-            case "list":
-                from .commands import list_projects
-
-                return list_projects(args)
-            case "op_grant":
-                from .commands import op_grant
-
-                return op_grant(args)
-            case "op_list":
-                from .commands import op_list
-
-                return op_list(args)
-            case "op_revoke":
-                from .commands import op_revoke
-
-                return op_revoke(args)
-            case "remove":
-                from .commands import remove_projects
-
-                return remove_projects(args)
-            case "search":
-                from .commands import search
-
-                return search(args)
-            case "show":
-                from .commands import show
-
-                return show(args)
-            case "start":
-                from .commands import start
-
-                return start(args)
-            case "status":
-                from .commands import server_status
-
-                return server_status(args)
-            case "stop":
-                from .commands import stop
-
-                return stop(args)
-            case "update":
-                from .commands import update_projects
-
-                return update_projects(args)
-            case "whitelist_add":
-                from .commands import whitelist_add
-
-                return whitelist_add(args)
-            case "whitelist_list":
-                from .commands import whitelist_list
-
-                return whitelist_list(args)
-            case "whitelist_remove":
-                from .commands import whitelist_remove
-
-                return whitelist_remove(args)
-            case _:
-                import logging as log
-
-                log.error(f"Unknown command: {command_name}")
-                return 1
+import argparse
+import sys
+from types import FunctionType
 
-    # Parser Setup
+from . import __version__
+from .modrinth.shared import search_sort_index
+from .shared import loader_list
+
+
+def bound_int(min_integer: int, max_integer: int | None = None) -> FunctionType:
+    def parse(cli_string: str) -> int:
+        try:
+            integer = int(cli_string)
+        except ValueError:
+            raise argparse.ArgumentTypeError(f"{cli_string} is not an integer")
+
+        if integer < min_integer:
+            raise argparse.ArgumentTypeError(
+                f"{integer} must be higher than or equal to {min_integer}"
+            )
+        if max_integer is not None and integer > max_integer:
+            raise argparse.ArgumentTypeError(
+                f"{integer} must be between {min_integer} and {max_integer} (inclusive)"
+            )
+        return integer
+
+    return parse
+
+
+def command_function(args: argparse.Namespace) -> int:
+    command_name: str = args.command_name
+
+    match command_name:
+        case "add":
+            from .commands import add_projects
+
+            return add_projects(args)
+        case "import":
+            from .commands import import_setup
+
+            return import_setup(args)
+        case "help":
+            from .commands import print_help
+
+            return print_help(args)
+        case "init":
+            from .commands import initialize_server
+
+            return initialize_server(args)
+        case "list":
+            from .commands import list_projects
+
+            return list_projects(args)
+        case "op_grant":
+            from .commands import op_grant
+
+            return op_grant(args)
+        case "op_list":
+            from .commands import op_list
+
+            return op_list(args)
+        case "op_revoke":
+            from .commands import op_revoke
+
+            return op_revoke(args)
+        case "remove":
+            from .commands import remove_projects
+
+            return remove_projects(args)
+        case "search":
+            from .commands import search_projects
+
+            return search_projects(args)
+        case "show":
+            from .commands import show_projects
+
+            return show_projects(args)
+        case "start":
+            from .commands import start_server
 
+            return start_server(args)
+        case "status":
+            from .commands import server_status
+
+            return server_status(args)
+        case "stop":
+            from .commands import stop_server
+
+            return stop_server(args)
+        case "update":
+            from .commands import update_projects
+
+            return update_projects(args)
+        case "whitelist_add":
+            from .commands import whitelist_add
+
+            return whitelist_add(args)
+        case "whitelist_list":
+            from .commands import whitelist_list
+
+            return whitelist_list(args)
+        case "whitelist_remove":
+            from .commands import whitelist_remove
+
+            return whitelist_remove(args)
+        case _:
+            import logging
+
+            logger = logging.getLogger(__name__)
+
+            logger.error(f"Unknown command: {command_name}")
+            return 1
+
+
+def main() -> int:
+    # Parser Setup
     parser = argparse.ArgumentParser(
         prog="mcserver",
         description="A CLI tool for managing Minecraft: Java Edition servers.",
@@ -220,6 +224,18 @@ def main() -> int:
 
     op_list_command.set_defaults(command_name="op_list")
 
+    # 'op revoke'
+    op_revoke_command = op_subcommands.add_parser(
+        "revoke",
+        help="Revoke operator players permission",
+        description="Revoke operator players permission.",
+    )
+
+    op_revoke_command.set_defaults(command_name="op_revoke")
+    op_revoke_command.add_argument(
+        "players", nargs="+", type=str, help="List of player names or UUIDs"
+    )
+
     # 'search' command
     search_command = commands.add_parser(
         "search",
@@ -328,5 +344,17 @@ def main() -> int:
 
     whitelist_list_command.set_defaults(command_name="whitelist_list")
 
+    # 'whitelist remove'
+    whitelist_remove_command = whitelist_subcommands.add_parser(
+        "remove",
+        help="Remove players from the whitelist",
+        description="Remove players from the whitelist.",
+    )
+
+    whitelist_remove_command.set_defaults(command_name="whitelist_remove")
+    whitelist_remove_command.add_argument(
+        "players", nargs="+", type=str, help="List of player names or UUIDs"
+    )
+
     args = parser.parse_args()
     return args.func(args)

mcserver/commands/__init__.py

@@ -1,37 +1,37 @@
-from .add import add
-from .import_setup import main as import_setup
-from .init import init
-from .list_projects import main as list_projects
-from .op_grant import main as op_grant
-from .op_list import main as op_list
-from .op_revoke import main as op_revoke
-from .print_help import main as print_help
-from .remove_projects import main as remove_projects
-from .search import search
-from .server_status import main as server_status
-from .show import show
-from .start import start
-from .stop import stop
-from .update_projects import main as update_projects
-from .whitelist_add import main as whitelist_add
-from .whitelist_list import main as whitelist_list
-from .whitelist_remove import main as whitelist_remove
+from .add_projects import run as add_projects
+from .import_setup import run as import_setup
+from .initialize_server import run as initialize_server
+from .list_projects import run as list_projects
+from .op_grant import run as op_grant
+from .op_list import run as op_list
+from .op_revoke import run as op_revoke
+from .print_help import run as print_help
+from .remove_projects import run as remove_projects
+from .search_projects import run as search_projects
+from .server_status import run as server_status
+from .show_projects import run as show_projects
+from .start_server import run as start_server
+from .stop_server import run as stop_server
+from .update_projects import run as update_projects
+from .whitelist_add import run as whitelist_add
+from .whitelist_list import run as whitelist_list
+from .whitelist_remove import run as whitelist_remove
 
 __all__ = [
-    "add",
+    "add_projects",
     "import_setup",
-    "init",
+    "initialize_server",
     "list_projects",
     "op_grant",
     "op_list",
     "op_revoke",
     "print_help",
     "remove_projects",
-    "search",
+    "search_projects",
     "server_status",
-    "show",
-    "start",
-    "stop",
+    "show_projects",
+    "start_server",
+    "stop_server",
     "update_projects",
     "whitelist_add",
     "whitelist_list",

mcserver/commands/{add.py → add_projects.py}

@@ -3,7 +3,7 @@ from argparse import Namespace
 
 from .. import config, paths, shared
 from ..modrinth import apis as modrinth_apis
-from ..modrinth import project_records, slug_index
+from ..modrinth import project_records
 from ..resolver import (
     Dependency,
     human_to_resolver,
@@ -13,13 +13,18 @@ from ..resolver import (
 
 logger = logging.getLogger(__name__)
 
-def add(args: Namespace) -> int:
+
+def run(args: Namespace) -> int:
     projects: list[str] = args.projects
 
     if not (paths.configs_dir / "server.json").exists():
-        logger.error("Configuration file for server does not exist, is server initialized?")
+        logger.error(
+            "Configuration file for server does not exist, is server initialized?"
+        )
 
-    server_config = config.read_config("server", shared.default_configs["server"]["format_version"])
+    server_config = config.read_config(
+        "server", shared.default_configs["server"]["format_version"]
+    )
     game_version = server_config["game_version"]
     loader_name = server_config["loader"]["name"]
 
@@ -35,11 +40,12 @@ def add(args: Namespace) -> int:
         dependencies: list[Dependency] = []
         if project_records.record_exists(project_id):
             project_record = project_records.read_record(project_id)
-            for dependency_id, dependency_type in project_record["dependencies"].items():
-                dependencies.append({
-                    "project_id": dependency_id,
-                    "dependency_type": dependency_type
-                })
+            for dependency_id, dependency_type in project_record[
+                "dependencies"
+            ].items():
+                dependencies.append(
+                    {"project_id": dependency_id, "dependency_type": dependency_type}
+                )
 
         else:
             project_version = modrinth_apis.get_project_versions(
@@ -64,7 +70,9 @@ def add(args: Namespace) -> int:
 
         return human_to_resolver(dependencies)
 
-    resolved_dependencies = resolve_dependencies(projects, get_dependencies, required_only)
+    resolved_dependencies = resolve_dependencies(
+        projects, get_dependencies, required_only
+    )
     print(resolved_dependencies)
     return 0
 
@@ -154,7 +162,6 @@ def add(args: Namespace) -> int:
     #     ]
     #     return a
 
-
     # server_config = config.read_config(
     #     "server", shared.default_configs["server"]["format_version"]
     # )

mcserver/commands/import_setup.py

@@ -1,7 +1,7 @@
 from argparse import Namespace
 
 
-def main(args: Namespace) -> int:
+def run(args: Namespace) -> int:
     file: str = args.file
     import logging as log
 

mcserver/commands/{init.py → initialize_server.py}

@@ -1,7 +1,7 @@
 from argparse import Namespace
 
 
-def init(args: Namespace) -> int:
+def run(args: Namespace) -> int:
     from ..modrinth.shared import SearchSortIndex
 
     # CLI Arguments

mcserver/commands/list_projects.py

@@ -1,7 +1,7 @@
 from argparse import Namespace
 
 
-def main(args: Namespace) -> int:
+def run(args: Namespace) -> int:
     import logging as log
 
     log.error("Command is not implemented yet.")

mcserver/commands/op_grant.py

@@ -1,7 +1,7 @@
 from argparse import Namespace
 
 
-def main(args: Namespace) -> int:
+def run(args: Namespace) -> int:
     players: list[str] = args.players
     import logging as log
 

mcserver/commands/op_list.py

@@ -1,32 +1,35 @@
+import logging
 from argparse import Namespace
 
+from ..server_files import ops
+from ..shared import pluralize
 
-def main(args: Namespace) -> int:
-    import logging as log
+logger = logging.getLogger(__name__)
 
-    from ..server_files import ops
-    from ..shared import pluralize
 
-    if not ops.ops_file.exists():
-        log.error(f"File '{ops.ops_file}' not found.")
+def run(args: Namespace) -> int:
+    ops_file = ops.ops_file_path
+    if not ops_file.exists():
+        logger.error(f"Operator file '{ops.ops_file_path}' not found.")
         return 1
 
     operator_players = ops.list_players()
 
-    players: list[str] = []
+    player_count = len(operator_players)
+    if player_count == 0:
+        logger.info("There's no operator player.")
+        return 0
+
+    player_list: list[str] = []
     for player in operator_players:
-        players.append(
+        player_list.append(
             f"{player['player_name']} ({player['player_uuid']}) Level: {player['permission_level']}"
         )
 
-    players.sort()
-    sorted_players = "\n".join(players)
-
-    player_count = len(operator_players)
-    if player_count == 0:
-        log.info("There's no operator player.")
-        return 0
+    logger.info(
+        f"There {pluralize('is', player_count)} {player_count} {pluralize('operator', player_count)}:"
+    )
 
-    log.info(f"All {player_count} operator {pluralize('player', player_count)}:")
-    print(sorted_players)
+    player_list.sort()
+    print("\n".join(player_list))
     return 0

mcserver/commands/op_revoke.py

@@ -1,9 +1,43 @@
+import logging
 from argparse import Namespace
+from uuid import UUID
 
+from ..server_files import ops
+from ..shared import pluralize
 
-def main(args: Namespace) -> int:
-    players: list[str] = args.players
-    import logging as log
+logger = logging.getLogger(__name__)
 
-    log.error("Command is not implemented yet.")
-    return 1
+
+def run(args: Namespace) -> int:
+    player_identifiers: list[str] = args.players
+
+    player_uuids: list[UUID] = []
+    player_names: list[str] = []
+    for player in player_identifiers:
+        if len(player) > 16:
+            logger.debug(f"{player} is probably an UUID")
+            player_uuids.append(UUID(player))
+        else:
+            logger.debug(f"{player} is probably a name")
+            player_names.append(player)
+
+    removed_players = ops.remove_players(player_uuids, player_names)
+
+    player_count: int = len(removed_players)
+    if player_count == 0:
+        logger.info("No matching player found.")
+        return 0
+
+    player_list: list[str] = []
+    for player in removed_players:
+        player_list.append(
+            f"{player['player_name']} ({player['player_uuid']}) Level: {player['permission_level']}"
+        )
+
+    logger.info(
+        f"There {pluralize('is', player_count)} {player_count} operator {pluralize('player', player_count)} that {pluralize('is', player_count)} removed:"
+    )
+
+    player_list.sort()
+    print("\n".join(player_list))
+    return 0

mcserver/commands/print_help.py

@@ -1,7 +1,7 @@
 import argparse
 
 
-def main(args: argparse.Namespace) -> int:
+def run(args: argparse.Namespace) -> int:
     parser: argparse.ArgumentParser = args.parser
     parser.print_help()
     return 0

mcserver/commands/remove_projects.py

@@ -1,7 +1,7 @@
 from argparse import Namespace
 
 
-def main(args: Namespace) -> int:
+def run(args: Namespace) -> int:
     import logging as log
 
     log.error("Command is not implemented yet.")

mcserver/commands/{search.py → search_projects.py}

@@ -18,7 +18,7 @@ from ..shared import (
 logger = logging.getLogger(__name__)
 
 
-def search(args: Namespace) -> int:
+def run(args: Namespace) -> int:
     search_query: list[str] = args.search_query
     search_limit: int | None = args.search_limit
     page_number: int = args.page_number
@@ -112,7 +112,7 @@ def search(args: Namespace) -> int:
         search_facets.append([f"project_type:{project_label}"])
         search_facets.append([f"categories:{loader_name}"])
     else:
-        search_facets.append(["project_type:mod","project_type:plugin"])
+        search_facets.append(["project_type:mod", "project_type:plugin"])
 
     search_info = f"Searching {pluralize(project_label, search_limit)}"
     if search_query:
@@ -165,17 +165,13 @@ def search(args: Namespace) -> int:
         for environment in environments:
             readable_environments.append(project_environment_name(environment))
 
+        print(f"{hit['project_name']} ({slug_or_id}) {project_author}")
         print(
-            f"{hit['project_name']} ({slug_or_id}) {project_author}"
-        )
-        print(f"> Downloads: {format_number(hit['download_count'])} | Follows: {format_number(hit['follower_count'])}")
-        print(
-            f"> {', '.join(readable_environments)}"
+            f"> Downloads: {format_number(hit['download_count'])} | Follows: {format_number(hit['follower_count'])}"
         )
+        print(f"> {', '.join(readable_environments)}")
         print(f"> https://modrinth.com/{hit['all_project_types'][0]}/{slug_or_id}")
-        print(
-            f"  {hit['short_description']}"
-        )
+        print(f"  {hit['short_description']}")
 
         if (count + 1) < len(search_hits):
             print()  # Print newline for readability

mcserver/commands/server_status.py

@@ -1,7 +1,7 @@
 from argparse import Namespace
 
 
-def main(args: Namespace) -> int:
+def run(args: Namespace) -> int:
     import logging as log
 
     log.error("Command is not implemented yet.")

mcserver/commands/{show.py → show_projects.py}

@@ -1,7 +1,7 @@
 from argparse import Namespace
 
 
-def show(args: Namespace) -> int:
+def run(args: Namespace) -> int:
     projects: list[str] = args.projects
 
     import logging

mcserver/commands/{start.py → start_server.py}

@@ -1,7 +1,7 @@
 from argparse import Namespace
 
 
-def start(args: Namespace) -> int:
+def run(args: Namespace) -> int:
     import logging as log
 
     from .. import state

mcserver/commands/{stop.py → stop_server.py}

@@ -1,7 +1,7 @@
 from argparse import Namespace
 
 
-def stop(args: Namespace) -> int:
+def run(args: Namespace) -> int:
     import logging as log
     import os
     from signal import SIGTERM

mcserver/commands/update_projects.py

@@ -1,7 +1,7 @@
 from argparse import Namespace
 
 
-def main(args: Namespace) -> int:
+def run(args: Namespace) -> int:
     import logging as log
 
     log.error("Command is not implemented yet.")

mcserver/commands/whitelist_add.py

@@ -1,7 +1,7 @@
 from argparse import Namespace
 
 
-def main(args: Namespace) -> int:
+def run(args: Namespace) -> int:
     players: list[str] = args.players
     import logging as log