mcserver-cli 3.0.0__py3-none-any.whl → 4.0.0.dev0__py3-none-any.whl

mcserver/__init__.py

@@ -1 +1 @@
-__version__ = "3.0.0"
+__version__ = "4.0.0.dev0"

mcserver/app.py

@@ -1,24 +1,28 @@
-def main() -> None:
+def main():
     import sys
 
-    if (sys.argv[1] if len(sys.argv) > 1 else "") == "cake":
-        from .mysterious import nothing_to_see_here_move_along
-
-        nothing_to_see_here_move_along()
-
-    MIN_PYTHON_VERSION: tuple[int, int] = (3, 14)
+    MIN_PYTHON_VERSION: tuple[int, int] = (3, 12)
     if sys.version_info < MIN_PYTHON_VERSION:
         sys.exit(
             f"MCServer requires Python {'.'.join(map(str, MIN_PYTHON_VERSION))} or newer."
         )
 
+    if (sys.argv[1] if len(sys.argv) > 1 else "") == "uh...":
+        from .mysterious import nothing_to_see_here_move_along
+
+        nothing_to_see_here_move_along()
+
     import logging as log
     import os
 
     from . import cli
 
     debug_mode = os.getenv("MCSERVER_DEBUG") == "1"
-    log_level = log.DEBUG if debug_mode else log.INFO
-    log.basicConfig(level=log_level, format="[%(levelname)s]: %(message)s")
+    if debug_mode:
+        log.basicConfig(
+            level=log.DEBUG, format="[%(levelname)s] [%(module)s]: %(message)s"
+        )
+    else:
+        log.basicConfig(level=log.INFO, format="[%(levelname)s]: %(message)s")
 
     sys.exit(cli.main())

mcserver/caching.py

@@ -0,0 +1,16 @@
+import os
+from pathlib import Path
+
+cache_dir = Path.home() / ".cache"
+
+xdg_cache_dir = os.getenv("XDG_CACHE_DIR")
+if xdg_cache_dir:
+    cache_dir = Path(xdg_cache_dir)
+
+mcserver_cache_dir = cache_dir / "mcserver"
+
+
+def create_file(file_name: str, file_data: bytes):
+    mcserver_cache_dir.mkdir(parents=True, exist_ok=True)
+    cache_file = mcserver_cache_dir / file_name
+    cache_file.write_bytes(file_data)

mcserver/cli.py

@@ -1,9 +1,30 @@
 def main() -> int:
     import argparse
+    import sys
 
     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):
+        def parse(cli_string: str):
+            try:
+                integer = int(cli_string)
+            except TypeError:
+                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
 
@@ -86,6 +107,8 @@ def main() -> int:
                 log.error(f"Unknown command: {command_name}")
                 return 1
 
+    # Parser Setup
+
     parser = argparse.ArgumentParser(
         prog="mcserver",
         description="A CLI tool for managing Minecraft: Java Edition servers.",
@@ -95,10 +118,12 @@ def main() -> int:
         add_help=True,
         allow_abbrev=False,
         exit_on_error=True,
-        suggest_on_error=True,
-        color=True,
     )
 
+    if sys.version_info >= (3, 14):
+        parser.suggest_on_error = True
+        parser.color = True
+
     parser.set_defaults(func=command_function, command_name="help", parser=parser)
     parser.add_argument(
         "-v",
@@ -112,13 +137,13 @@ def main() -> int:
     # 'add' command
     add_command = commands.add_parser(
         "add",
-        help="Add mods/projects",
-        description="Add mods/plugins and their dependencies.",
+        help="Add Modrinth projects to the server",
+        description="Add Modrinth mods/plugins to the server",
     )
 
     add_command.set_defaults(command_name="add")
     add_command.add_argument(
-        "projects", nargs="+", type=str, help="Project slugs or IDs"
+        "projects", nargs="+", type=str, help="Modrinth project slugs or IDs"
     )
 
     # 'import' command
@@ -129,7 +154,7 @@ def main() -> int:
     )
 
     import_command.set_defaults(command_name="import")
-    import_command.add_argument("modpack", type=str, help="The Modrinth modpack file")
+    import_command.add_argument("file", type=str, help="The Modrinth modpack file")
 
     # 'init' command
     init_command = commands.add_parser(
@@ -140,12 +165,11 @@ def main() -> int:
 
     init_command.set_defaults(command_name="init")
     init_command.add_argument(
-        "--mc-version",
+        "--game-version",
         default="latest-release",
         type=str,
         help="Minecraft version of the server",
         metavar="Version",
-        dest="game_version",
     )
 
     init_command.add_argument(
@@ -169,19 +193,38 @@ def main() -> int:
     init_command.add_argument(
         "--min-ram",
         default=512,
-        type=int,
-        help="Minimum RAM for the server (in MebiBytes)",
+        type=bound_int(1024),
+        help="Minimum RAM for the server (in MebiBytes) (minimum value: 1024)",
         metavar="Size",
     )
 
     init_command.add_argument(
         "--max-ram",
-        default=2048,
+        default=bound_int(1024),
         type=int,
-        help="Maximum RAM for the server (in MebiBytes)",
+        help="Maximum RAM for the server (in MebiBytes) (minimum value: 1024)",
         metavar="Size",
     )
 
+    init_command.add_argument(
+        "--search-limit",
+        default=20,
+        type=bound_int(1, 100),
+        help="Default search limit value (value between (inclusive): 1-100)",
+        metavar="Number",
+        dest="search_limit",
+    )
+
+    init_command.add_argument(
+        "--search-sort",
+        default="relevance",
+        type=str,
+        choices=search_sort_index,
+        help="Default search sort index",
+        metavar="Index",
+        dest="search_limit",
+    )
+
     # 'list' command
     list_command = commands.add_parser(
         "list", help="List all added projects", description="List all added projects."
@@ -197,18 +240,7 @@ def main() -> int:
     op_command.set_defaults(parser=op_command)
     op_subcommands = op_command.add_subparsers(title="Subcommands")
 
-    # 'op grant'
-    op_grant_command = op_subcommands.add_parser(
-        "grant",
-        help="Grant operator to players",
-        description="Grant operator status to players.",
-    )
-
-    op_grant_command.set_defaults(command_name="op_grant")
-    op_grant_command.add_argument(
-        "players", nargs="+", type=str, help="Player names or UUIDs"
-    )
-
+    # op_grant and op_revoke is not going to be implemented in this version
     # 'op list'
     op_list_command = op_subcommands.add_parser(
         "list", help="List operator players", description="List all operator players."
@@ -216,23 +248,16 @@ 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 from players",
-        description="Revoke operator status from players.",
-    )
-
-    op_revoke_command.set_defaults(command_name="op_revoke")
-    op_revoke_command.add_argument(
-        "players", nargs="+", type=str, help="Player names or UUIDs"
-    )
-
     # 'remove' command
     remove_command = commands.add_parser(
         "remove", help="Remove projects", description="Remove projects"
     )
 
+    remove_command.set_defaults(command_name="remove")
+    remove_command.add_argument(
+        "projects", nargs="+", type=str, help="Modrinth project slugs or IDs"
+    )
+
     # 'search' command
     search_command = commands.add_parser(
         "search",
@@ -241,7 +266,60 @@ def main() -> int:
     )
 
     search_command.set_defaults(command_name="search")
-    search_command.add_argument("query", nargs="*", type=str, help="Query to search")
+    search_command.add_argument(
+        "search_query", nargs="*", type=str, help="Query to search"
+    )
+
+    search_command.add_argument(
+        "--limit",
+        default=20,
+        type=bound_int(1, 100),
+        help="Search projects per page (value between (inclusive): 1-100)",
+        metavar="Number",
+        dest="search_limit",
+    )
+
+    search_command.add_argument(
+        "--page",
+        default=1,
+        type=bound_int(1),
+        help="Show mods in page number (minimum value: 1)",
+        metavar="Number",
+        dest="page_number",
+    )
+
+    search_command.add_argument(
+        "--sort",
+        default="relevance",
+        type=str,
+        choices=search_sort_index,
+        help="Sort by index",
+        metavar="Index",
+        dest="sort_index",
+    )
+
+    search_command.add_argument(
+        "--game-version",
+        type=str,
+        help="Override the Minecraft version filter",
+        metavar="Version",
+        dest="game_version",
+    )
+
+    search_command.add_argument(
+        "--no-version",
+        action="store_true",
+        help="Ignore game version at all",
+    )
+
+    search_command.add_argument(
+        "--loader",
+        type=str,
+        choices=loader_list,
+        help="Override the loader filter",
+        metavar="Loader",
+        dest="loader_name",
+    )
 
     # 'show' command
     show_command = commands.add_parser(
@@ -262,22 +340,13 @@ def main() -> int:
 
     start_command.set_defaults(command_name="start")
 
+    # status_command is not going to be implemented in this version
     # "stop" command
     stop_command = commands.add_parser(
         "stop", help="Stop the server", description="Stop the running server"
     )
 
     stop_command.set_defaults(command_name="stop")
-    stop_command.add_argument(
-        "--force-stop", action="store_true", help="Force stop the server"
-    )
-
-    # "update" command
-    update_command = commands.add_parser(
-        "update",
-        help="Update projects from Modrinth",
-        description="Update projects from Modrinth",
-    )
 
     # 'whitelist' command
     whitelist_command = commands.add_parser(
@@ -289,18 +358,7 @@ def main() -> int:
     whitelist_command.set_defaults(parser=whitelist_command)
     whitelist_subcommands = whitelist_command.add_subparsers(title="Subcommands")
 
-    # 'whitelist add'
-    whitelist_add_command = whitelist_subcommands.add_parser(
-        "add",
-        help="Add players to whitelist",
-        description="Add players to the whitelist.",
-    )
-
-    whitelist_add_command.set_defaults(command_name="whitelist_add")
-    whitelist_add_command.add_argument(
-        "players", nargs="+", type=str, help="Player names or UUIDs"
-    )
-
+    # whitelist_add and whitelist_remove is not going to be implemented in this version
     # 'whitelist list'
     whitelist_list_command = whitelist_subcommands.add_parser(
         "list",
@@ -310,17 +368,5 @@ 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 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="Player names or UUIDs"
-    )
-
     args = parser.parse_args()
     return args.func(args)

mcserver/commands/__init__.py

@@ -8,8 +8,8 @@ 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_projects import main as search_projects
-from .show_projects import main as show_projects
 from .server_status import main as server_status
+from .show_projects import main as show_projects
 from .start_server import main as start_server
 from .stop_server import main as stop_server
 from .update_projects import main as update_projects

mcserver/commands/add_projects.py

@@ -1,7 +1,148 @@
-import argparse
+from argparse import Namespace
 
 
-def main(args: argparse.Namespace) -> int:
+def main(args: Namespace) -> int:
     projects: list[str] = args.projects
-    print(args)
+
+    # from ..modrinth.apis import get_project_versions
+    from ..config import load_config
+    from ..resolver import (
+        Dependency,
+        human_to_resolver,
+        resolve_dependencies,
+        resolver_to_human,
+    )
+
+    def get_project_versions(
+        project_id, loader_names, game_versions, featured=None, include_changelog=True
+    ):
+        project_version = {
+            "embeddium": {
+                "dependencies": [
+                    {"project_id": "AANobbMI", "dependency_type": "incompatible"}
+                ],
+                "project_id": "sk9rgfiA",
+            },
+            "fabric-api": {"dependencies": [], "project_id": "P7dR8mSH"},
+            "jade": {
+                "dependencies": [
+                    {"project_id": "AANobbMI", "dependency_type": "required"},
+                    {"project_id": "u6dRKJwZ", "dependency_type": "optional"},
+                ],
+                "project_id": "nvQzSEkH",
+            },
+            "jei": {"dependencies": [], "project_id": "u6dRKJwZ"},
+            "just-enough-resources-jer": {
+                "dependencies": [
+                    {"project_id": "u6dRKJwZ", "dependency_type": "required"}
+                ],
+                "project_id": "uEfK2CXF",
+            },
+            "origins": {
+                "dependencies": [
+                    {"project_id": "P7dR8mSH", "dependency_type": "required"}
+                ],
+                "project_id": "3BeIrqZR",
+            },
+            "pehkui": {
+                "dependencies": [
+                    {"project_id": "P7dR8mSH", "dependency_type": "required"}
+                ],
+                "project_id": "t5W7Jfwy",
+            },
+            "podium": {
+                "dependencies": [
+                    {"project_id": "AANobbMI", "dependency_type": "required"}
+                ],
+                "project_id": "fW8woQj4",
+            },
+            "sodium": {"dependencies": [], "project_id": "AANobbMI"},
+            "thdilos-fox-origin-expanded": {
+                "dependencies": [
+                    {"project_id": "9qGn08Dr", "dependency_type": "required"},
+                    {"project_id": "3BeIrqZR", "dependency_type": "required"},
+                    {"project_id": "t5W7Jfwy", "dependency_type": "required"},
+                ],
+                "project_id": "CbsRGXBx",
+            },
+            "thdilos-fox-origin": {
+                "dependencies": [
+                    {"project_id": "3BeIrqZR", "dependency_type": "required"},
+                    {"project_id": "t5W7Jfwy", "dependency_type": "required"},
+                ],
+                "project_id": "9qGn08Dr",
+            },
+        }
+
+        id_slug = {
+            "3BeIrqZR": "origins",
+            "9qGn08Dr": "thdilos-fox-origin",
+            "AANobbMI": "sodium",
+            "CbsRGXBx": "thdilos-fox-origin-expanded",
+            "P7dR8mSH": "fabric-api",
+            "fW8woQj4": "podium",
+            "nvQzSEkH": "jade",
+            "sk9rgfiA": "embeddium",
+            "t5W7Jfwy": "pehkui",
+            "u6dRKJwZ": "jei",
+            "uEfK2CXF": "just-enough-resources-jer",
+        }
+
+        a = [
+            (
+                project_version[project_id]
+                if project_id in project_version
+                else project_version[id_slug[project_id]]
+            )
+        ]
+        return a
+
+    server_config = load_config("server")
+    loader_name = server_config["loader"]["name"]
+    game_version = server_config["game_version"]
+
+    cached_project_versions = {}
+    project_ids = []
+
+    for project in projects:
+        project_version = get_project_versions(
+            project, loader_name, game_version, include_changelog=False
+        )[0]
+
+        cached_project_versions[project_version["project_id"]] = project_version
+        project_ids.append(project_version["project_id"])
+
+    def get_dependencies(project_id: str) -> dict[str, int]:
+        dependencies: list[Dependency] = []
+
+        # Get the latest version
+        project_version = get_project_versions(
+            project_id, loader_name, game_version, include_changelog=False
+        )[0]
+        if "dependencies" in project_version:
+            project_dependencies = project_version["dependencies"]
+            for dependency in project_dependencies:
+                if not "project_id" in dependency:
+                    continue
+
+                if dependency["project_id"] is None:
+                    continue
+
+                dependencies.append(
+                    {
+                        "project_id": dependency["project_id"],
+                        "dependency_type": dependency["dependency_type"],
+                    }
+                )
+
+        return human_to_resolver(dependencies)
+
+    def required_only(dependency_type: int) -> bool:
+        return dependency_type == 2
+
+    print(
+        resolver_to_human(
+            resolve_dependencies(project_ids, get_dependencies, required_only, 2)
+        )
+    )
     return 0

mcserver/commands/import_setup.py

@@ -1,6 +1,9 @@
-import argparse
+from argparse import Namespace
 
 
-def main(args: argparse.Namespace) -> int:
-    print(args)
-    return 0
+def main(args: Namespace) -> int:
+    file: str = args.file
+    import logging as log
+
+    log.error("Command is not implemented yet.")
+    return 1

mcserver/commands/initialize_server.py

@@ -1,7 +1,9 @@
-import argparse
+from argparse import Namespace
 
 
-def main(args: argparse.Namespace) -> int:
+def main(args: Namespace) -> int:
+    from ..modrinth.shared import SearchSortIndex
+
     # CLI Arguments
     game_version: str = args.game_version
 
@@ -11,6 +13,9 @@ def main(args: argparse.Namespace) -> int:
     min_ram: int = args.min_ram
     max_ram: int = args.max_ram
 
+    search_limit: int = args.search_limit
+    sort_index: SearchSortIndex = args.sort_index
+
     # Imports
     import copy
     import logging as log
@@ -47,14 +52,16 @@ def main(args: argparse.Namespace) -> int:
                         loader_version = version["loader_version"]
                         break
 
-                log.info(f"Latest Fabric loader version is {loader_version}")
+                log.info(f"Latest Fabric loader version is: {loader_version}")
+            case "legacyfabric":
+                pass
             case "quilt":
                 from ..quiltmc import meta as quiltmc_meta
 
                 loader_versions = quiltmc_meta.get_loader_versions()
                 latest_quilt_version = loader_versions[0]
                 loader_version = str(latest_quilt_version["loader_version"])
-                log.info(f"Latest Quilt loader version is {loader_version}")
+                log.info(f"Latest Quilt loader version is: {loader_version}")
             # Plugin Loader
             case "paper":
                 from ..papermc import api as papermc_api
@@ -98,6 +105,12 @@ def main(args: argparse.Namespace) -> int:
             case "launcher":
                 config_override = {"ram": {"min": min_ram, "max": max_ram}}
 
+            case "modrinth":
+                config_override = {
+                    "search_limit": search_limit,
+                    "sort_index": sort_index,
+                }
+
             case "server":
                 config_override = {
                     "game_version": game_version,

mcserver/commands/list_projects.py

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

mcserver/commands/op_grant.py

@@ -1,7 +1,9 @@
-import argparse
+from argparse import Namespace
 
 
-def main(args: argparse.Namespace) -> int:
+def main(args: Namespace) -> int:
     players: list[str] = args.players
-    print(args)
-    return 0
+    import logging as log
+
+    log.error("Command is not implemented yet.")
+    return 1

mcserver/commands/op_list.py

@@ -1,7 +1,7 @@
-import argparse
+from argparse import Namespace
 
 
-def main(args: argparse.Namespace) -> int:
+def main(args: Namespace) -> int:
     import logging as log
 
     from ..server_files import ops
@@ -16,7 +16,7 @@ def main(args: argparse.Namespace) -> int:
     players: list[str] = []
     for player in operator_players:
         players.append(
-            f"{player['player_name']} ({player['player_uuid']}) Level: {player["permission_level"]}"
+            f"{player['player_name']} ({player['player_uuid']}) Level: {player['permission_level']}"
         )
 
     players.sort()
@@ -27,6 +27,6 @@ def main(args: argparse.Namespace) -> int:
         log.info("There's no operator player.")
         return 0
 
-    log.info(f"All {player_count} operator {pluralize("player", player_count)}:")
+    log.info(f"All {player_count} operator {pluralize('player', player_count)}:")
     print(sorted_players)
     return 0

mcserver/commands/op_revoke.py

@@ -1,7 +1,9 @@
-import argparse
+from argparse import Namespace
 
 
-def main(args: argparse.Namespace) -> int:
+def main(args: Namespace) -> int:
     players: list[str] = args.players
-    print(args)
-    return 0
+    import logging as log
+
+    log.error("Command is not implemented yet.")
+    return 1

mcserver/commands/remove_projects.py

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