modforge-cli 0.1.5__tar.gz

modforge_cli-0.1.5/LICENSE

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

modforge_cli-0.1.5/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: modforge-cli
+Version: 0.1.5
+Summary: ModForge-CLI — a Modrinth-based Minecraft modpack builder
+License: MIT
+License-File: LICENSE
+Author: Frank1o3
+Author-email: jahdy1o3@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Dist: aiofiles (>=25.1.0,<26.0.0)
+Requires-Dist: aiohttp (>=3.13.3,<4.0.0)
+Requires-Dist: jsonschema (>=4.25.1,<5.0.0)
+Requires-Dist: pydantic (>=2.12.5,<3.0.0)
+Requires-Dist: pyfiglet (>=1.0.4,<2.0.0)
+Requires-Dist: pyzipper (>=0.3.6,<0.4.0)
+Requires-Dist: requests (>=2.32.5,<3.0.0)
+Requires-Dist: rich (>=14.2.0,<15.0.0)
+Requires-Dist: typer (>=0.21.1,<0.22.0)
+Project-URL: Homepage, https://frank1o3.github.io/ModForge-CLI/
+Project-URL: Repository, https://github.com/Frank1o3/ModForge-CLI
+Description-Content-Type: text/markdown
+
+# ModForge-CLI ⛏
+
+[![Python 3.13+](https://img.shields.io/badge/python-3.13%2B-blue)](https://www.python.org/)
+[![MIT License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+[![Modrinth API v2](https://img.shields.io/badge/Modrinth-API%20v2-orange)](https://docs.modrinth.com/api-spec)
+
+**ModForge-CLI** is a powerful CLI tool for building and managing custom Minecraft modpacks using the Modrinth API v2.
+
+Search for projects, fetch versions, validate manifests, download mods with hash checks, and generate complete files — all from the terminal.
+
+Ideal for modpack developers, server admins, and automation scripts.
+
+## Terminal Banner
+
+When you run ModForge-CLI, you'll be greeted with this colorful Minecraft-themed banner
+
+## Key Features
+
+- **Modrinth API v2 Integration**: Search projects, list versions, fetch metadata in bulk.
+- **Modpack Management**: Read/validate `modrinth.index.json`, build packs from metadata.
+- **Validation**: Full JSON Schema checks + optional Pydantic models for strict typing.
+
+## Installation
+
+Requires **Python 3.13+**.
+
+**Recommended (Poetry)**:
+
+```bash
+poetry install
+```
+
+**Alternative (pip)**:
+
+```bash
+pip install -r requirements.txt
+```
+

modforge_cli-0.1.5/README.md

@@ -0,0 +1,37 @@
+# ModForge-CLI ⛏
+
+[![Python 3.13+](https://img.shields.io/badge/python-3.13%2B-blue)](https://www.python.org/)
+[![MIT License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+[![Modrinth API v2](https://img.shields.io/badge/Modrinth-API%20v2-orange)](https://docs.modrinth.com/api-spec)
+
+**ModForge-CLI** is a powerful CLI tool for building and managing custom Minecraft modpacks using the Modrinth API v2.
+
+Search for projects, fetch versions, validate manifests, download mods with hash checks, and generate complete files — all from the terminal.
+
+Ideal for modpack developers, server admins, and automation scripts.
+
+## Terminal Banner
+
+When you run ModForge-CLI, you'll be greeted with this colorful Minecraft-themed banner
+
+## Key Features
+
+- **Modrinth API v2 Integration**: Search projects, list versions, fetch metadata in bulk.
+- **Modpack Management**: Read/validate `modrinth.index.json`, build packs from metadata.
+- **Validation**: Full JSON Schema checks + optional Pydantic models for strict typing.
+
+## Installation
+
+Requires **Python 3.13+**.
+
+**Recommended (Poetry)**:
+
+```bash
+poetry install
+```
+
+**Alternative (pip)**:
+
+```bash
+pip install -r requirements.txt
+```

modforge_cli-0.1.5/pyproject.toml

@@ -0,0 +1,55 @@
+[project]
+name = "modforge-cli"
+version = "0.1.5"
+description = "ModForge-CLI — a Modrinth-based Minecraft modpack builder"
+authors = [{ name = "Frank1o3", email = "jahdy1o3@gmail.com" }]
+license = { text = "MIT" }
+readme = "README.md"
+requires-python = ">=3.10,<4.0"
+dependencies = [
+    "requests (>=2.32.5,<3.0.0)",
+    "jsonschema (>=4.25.1,<5.0.0)",
+    "aiofiles (>=25.1.0,<26.0.0)",
+    "pydantic (>=2.12.5,<3.0.0)",
+    "pyzipper (>=0.3.6,<0.4.0)",
+    "rich (>=14.2.0,<15.0.0)",
+    "aiohttp (>=3.13.3,<4.0.0)",
+    "pyfiglet (>=1.0.4,<2.0.0)",
+    "typer (>=0.21.1,<0.22.0)",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Build Tools",
+]
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[dependency-groups]
+dev = [
+    "types-requests (>=2.32.4.20250913,<3.0.0.0)",
+    "types-jsonschema (>=4.25.1.20251009,<5.0.0.0)",
+    "types-tqdm (>=4.67.0.20250809,<5.0.0.0)",
+    "ruff (>=0.14.8,<0.15.0)",
+    "mypy (>=1.19.0,<2.0.0)",
+    "types-colorama (>=0.4.15.20250801,<0.5.0.0)",
+]
+
+[tool.poetry]
+package-mode = true
+
+[tool.poetry.scripts]
+modforge = "modforge_cli.__main__:main"
+
+[project.urls]
+Homepage = "https://frank1o3.github.io/ModForge-CLI/"
+Repository = "https://github.com/Frank1o3/ModForge-CLI"

modforge_cli-0.1.5/src/modforge_cli/__init__.py

@@ -0,0 +1,5 @@
+"""
+ModForge-CLI - A CLI tool for building and managing Minecraft modpacks
+"""
+
+__version__ = "0.1.0"

modforge_cli-0.1.5/src/modforge_cli/__main__.py

@@ -0,0 +1,8 @@
+"""
+__main__.py - Entry point for the ModForge-CLI CLI
+"""
+
+from modforge_cli.cli import main
+
+if __name__ == "__main__":
+    main()

modforge_cli-0.1.5/src/modforge_cli/__version__.py

@@ -0,0 +1,5 @@
+"""
+Auto-generated file. DO NOT EDIT.
+"""
+__version__ = "0.1.5"
+__author__ = "Frank1o3"

modforge_cli-0.1.5/src/modforge_cli/api/__init__.py

@@ -0,0 +1,7 @@
+"""
+api package - Exposes the Modrinth API client globally.
+"""
+
+from .modrinth import ModrinthAPIConfig
+
+__all__ = ["ModrinthAPIConfig"]

modforge_cli-0.1.5/src/modforge_cli/api/modrinth.py

@@ -0,0 +1,218 @@
+"""
+api/modrith_api.py - Modrinth API v2 URL builder using modrinth_api.json
+"""
+
+from __future__ import annotations
+
+import json
+from pathlib import Path
+from typing import Any, Dict, List, Optional
+from urllib.parse import quote_plus
+
+
+class ModrinthAPIConfig:
+    """Loads modrinth_api.json and builds Modrinth API URLs."""
+
+    def __init__(self, config_path: str | Path = "configs/modrinth_api.json"):
+        self.config_path = config_path if isinstance(config_path, Path) else Path(config_path)
+        self.base_url: str = ""
+        self.endpoints: Dict[str, Any] = {}
+        self._load_config()
+
+    def _load_config(self) -> None:
+        if not self.config_path.exists():
+            raise FileNotFoundError(
+                f"Modrinth API config not found: {self.config_path}"
+            )
+
+        with open(self.config_path, "r", encoding="utf-8") as f:
+            data = json.load(f)
+
+        self.base_url = data.get("BASE_URL", "").rstrip("/")
+        if not self.base_url:
+            raise ValueError("BASE_URL missing in modrinth_api.json")
+
+        self.endpoints = data.get("ENDPOINTS", {})
+        if not isinstance(self.endpoints, Dict):
+            raise ValueError("ENDPOINTS section is invalid")
+
+    def build_url(self, template: str, **kwargs: str) -> str:
+        """Format a template string with kwargs and prepend base URL."""
+        try:
+            path = template.format(**kwargs)
+            return f"{self.base_url}{path}"
+        except KeyError as e:
+            raise ValueError(f"Missing URL parameter: {e}")
+
+    # === Search ===
+
+    def search(
+        self,
+        query: Optional[str] = None,
+        facets: Optional[List[List[str]] | str] = None,
+        categories: Optional[List[str]] = None,
+        loaders: Optional[List[str]] = None,
+        game_versions: Optional[List[str]] = None,
+        license_: Optional[str] = None,
+        project_type: Optional[str] = None,
+        offset: Optional[int] = None,
+        limit: Optional[int] = 10,
+        index: Optional[str] = "relevance",
+    ) -> str:
+        """
+        Build the Modrinth search URL with query parameters.
+
+        Docs: https://docs.modrinth.com/api-spec#endpoints-search
+
+        Facets format: [[inner AND], [inner AND]] = outer OR
+        Example: [["categories:performance"], ["project_type:mod"]]
+
+        Args:
+            query: Search term (e.g., "sodium")
+            facets: Advanced filters as list of lists or JSON string
+            categories: Filter by categories (e.g., ["performance"])
+            loaders: Filter by loaders (e.g., ["fabric", "quilt"])
+            game_versions: Filter by Minecraft versions (e.g., ["1.21.1"])
+            license_: Filter by license (e.g., "MIT")
+            project_type: "mod", "resourcepack", "shader", "modpack", "datapack"
+            offset: Pagination offset
+            limit: Results per page (max 100)
+            index: Sort by "relevance", "downloads", "updated", "newest"
+
+        Returns:
+            Full search URL with query parameters
+        """
+        base = self.build_url(self.endpoints["search"])
+        params = []
+        if query:
+            params.append(f"query={quote_plus(query)}")
+
+        facets_array = []
+        if facets:
+            if isinstance(facets, str):
+                params.append(f"facets={quote_plus(facets)}")
+            else:
+                facets_array.extend(facets)
+
+        if project_type:
+            facets_array.append([f"project_type:{project_type}"])
+        if categories:
+            [facets_array.append([f"categories:{c}"]) for c in categories]
+        if loaders:
+            facets_array.append([f"categories:{l}" for l in loaders])
+        if game_versions:
+            facets_array.append([f"versions:{v}" for v in game_versions])
+        if license_:
+            facets_array.append([f"license:{license_}"])
+
+        if facets_array and not (isinstance(facets, str)):
+            params.append(f"facets={quote_plus(json.dumps(facets_array))}")
+
+        if offset is not None:
+            params.append(f"offset={offset}")
+        if limit is not None:
+            params.append(f"limit={min(limit, 100)}")
+        if index:
+            params.append(f"index={index}")
+
+        return f"{base}?{'&'.join(params)}" if params else base
+
+    # === Projects ===
+
+    def project(self, project_id: str) -> str:
+        return self.build_url(self.endpoints["projects"]["project"], id=project_id)
+
+    def project_versions(self, project_id: str) -> str:
+        return self.build_url(
+            self.endpoints["projects"]["project_versions"], id=project_id
+        )
+
+    def project_dependencies(self, project_id: str) -> str:
+        return self.build_url(self.endpoints["projects"]["dependencies"], id=project_id)
+
+    def project_gallery(self, project_id: str) -> str:
+        return self.build_url(self.endpoints["projects"]["gallery"], id=project_id)
+
+    def project_icon(self, project_id: str) -> str:
+        return self.build_url(self.endpoints["projects"]["icon"], id=project_id)
+
+    def check_following(self, project_id: str) -> str:
+        return self.build_url(
+            self.endpoints["projects"]["check_following"], id=project_id
+        )
+
+    # === Versions ===
+
+    def version(self, version_id: str) -> str:
+        return self.build_url(self.endpoints["versions"]["version"], id=version_id)
+
+    def version_files(self, version_id: str) -> str:
+        return self.build_url(self.endpoints["versions"]["files"], id=version_id)
+
+    def version_file_download(self, version_id: str, filename: str) -> str:
+        return self.build_url(
+            self.endpoints["versions"]["download"], id=version_id, filename=filename
+        )
+
+    def file_by_hash(self, hash_: str) -> str:
+        return self.build_url(self.endpoints["versions"]["file_by_hash"], hash=hash_)
+
+    def versions_by_hash(self, hash_: str) -> str:
+        return self.build_url(
+            self.endpoints["versions"]["versions_by_hash"], hash=hash_
+        )
+
+    def latest_version_for_hash(self, hash_: str, algorithm: str = "sha1") -> str:
+        return self.build_url(
+            self.endpoints["versions"]["latest_for_hash"], hash=hash_, algo=algorithm
+        )
+
+    # === Tags ===
+
+    def categories(self) -> str:
+        return self.build_url(self.endpoints["tags"]["categories"])
+
+    def loaders(self) -> str:
+        return self.build_url(self.endpoints["tags"]["loaders"])
+
+    def game_versions(self) -> str:
+        return self.build_url(self.endpoints["tags"]["game_versions"])
+
+    def licenses(self) -> str:
+        return self.build_url(self.endpoints["tags"]["licenses"])
+
+    def environments(self) -> str:
+        return self.build_url(self.endpoints["tags"]["environments"])
+
+    # === Teams ===
+
+    def team(self, team_id: str) -> str:
+        return self.build_url(self.endpoints["teams"]["team"], id=team_id)
+
+    def team_members(self, team_id: str) -> str:
+        return self.build_url(self.endpoints["teams"]["members"], id=team_id)
+
+    # === User ===
+
+    def user(self, user_id: str) -> str:
+        return self.build_url(self.endpoints["user"]["user"], id=user_id)
+
+    def user_projects(self, user_id: str) -> str:
+        return self.build_url(self.endpoints["user"]["user_projects"], id=user_id)
+
+    def user_notifications(self, user_id: str) -> str:
+        return self.build_url(self.endpoints["user"]["notifications"], id=user_id)
+
+    def user_avatar(self, user_id: str) -> str:
+        return self.build_url(self.endpoints["user"]["avatar"], id=user_id)
+
+    # === Bulk ===
+
+    def bulk_projects(self) -> str:
+        return self.build_url(self.endpoints["bulk"]["projects"])
+
+    def bulk_versions(self) -> str:
+        return self.build_url(self.endpoints["bulk"]["versions"])
+
+    def bulk_version_files(self) -> str:
+        return self.build_url(self.endpoints["bulk"]["version_files"])