stewbeet 0.0.1__tar.gz

stewbeet-0.0.1/.gitignore

@@ -0,0 +1,11 @@
+
+env
+venv
+.env
+.venv
+__pycache__
+extensive_template/continuous_delivery/
+upload.py
+perf.html
+.beet_cache
+

stewbeet-0.0.1/LICENSE

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

stewbeet-0.0.1/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.4
+Name: stewbeet
+Version: 0.0.1
+Summary: Beet Framework made to help generating advanced Minecraft datapack contents
+Project-URL: Homepage, https://github.com/Stoupy51/stewbeet
+Project-URL: Issues, https://github.com/Stoupy51/stewbeet/issues
+Author-email: Stoupy51 <stoupy51@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Requires-Dist: beet>=0.110.1
+Requires-Dist: bolt>=0.49.1
+Requires-Dist: mecha>=0.98.1
+Requires-Dist: model-resolver>=1.8.0
+Requires-Dist: mutagen>=1.47.0
+Requires-Dist: pyperclip>=1.8.0
+Requires-Dist: smithed>=0.19.0
+Requires-Dist: stouputils>=1.3.12
+Description-Content-Type: text/markdown
+
+
+# 📦 Package Link
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/stewbeet?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stewbeet/)
+
+# 🐍 StewBeet
+Here is a template to a GitHub repository using this Python package: 📝
+[https://github.com/Stoupy51/StewBeet](https://github.com/Stoupy51/StewBeet)
+
+Here is an advanced example using this Python package: ⚡
+[https://github.com/Stoupy51/SimplEnergy](https://github.com/Stoupy51/SimplEnergy)
+
+## ⭐ Star History
+
+<a href="https://star-history.com/#Stoupy51/stewbeet&Date">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stewbeet&type=Date&theme=dark" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stewbeet&type=Date" />
+   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/stewbeet&type=Date" />
+ </picture>
+</a>
+

stewbeet-0.0.1/README.md

@@ -0,0 +1,21 @@
+
+# 📦 Package Link
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/stewbeet?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stewbeet/)
+
+# 🐍 StewBeet
+Here is a template to a GitHub repository using this Python package: 📝
+[https://github.com/Stoupy51/StewBeet](https://github.com/Stoupy51/StewBeet)
+
+Here is an advanced example using this Python package: ⚡
+[https://github.com/Stoupy51/SimplEnergy](https://github.com/Stoupy51/SimplEnergy)
+
+## ⭐ Star History
+
+<a href="https://star-history.com/#Stoupy51/stewbeet&Date">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stewbeet&type=Date&theme=dark" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stewbeet&type=Date" />
+   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/stewbeet&type=Date" />
+ </picture>
+</a>
+

stewbeet-0.0.1/pyproject.toml

@@ -0,0 +1,47 @@
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "stewbeet"
+version = "0.0.1"
+description = "Beet Framework made to help generating advanced Minecraft datapack contents"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.12"
+classifiers = [
+	"Programming Language :: Python :: 3",
+	"License :: OSI Approved :: MIT License",
+	"Operating System :: OS Independent",
+]
+dependencies = [
+	"stouputils>=1.3.12",
+	"model_resolver>=1.8.0",
+	"beet>=0.110.1",
+	"bolt>=0.49.1",
+	"mecha>=0.98.1",
+	"smithed>=0.19.0",
+	"mutagen>=1.47.0",
+	"pyperclip>=1.8.0",
+]
+[[project.authors]]
+name = "Stoupy51"
+email = "stoupy51@gmail.com"
+
+[project.urls]
+Homepage = "https://github.com/Stoupy51/stewbeet"
+Issues = "https://github.com/Stoupy51/stewbeet/issues"
+
+[project.scripts]
+stewbeet = "stewbeet.cli:main"
+
+[tool.pyright]
+typeCheckingMode = "basic"
+
+[tool.setuptools]
+license-files = ["LICENSE"]
+
+[tool.hatch.build]
+include = ["stewbeet"]
+

stewbeet-0.0.1/stewbeet/__init__.py

@@ -0,0 +1 @@
+

stewbeet-0.0.1/stewbeet/__main__.py

@@ -0,0 +1,4 @@
+
+# Imports
+from .cli import main  # noqa: F401
+

stewbeet-0.0.1/stewbeet/cli.py

@@ -0,0 +1,76 @@
+
+# Imports
+import importlib
+import os
+import shutil
+import subprocess
+import sys
+
+from beet import ProjectConfig, load_config, locate_config
+from box import Box
+from stouputils.decorators import LogLevels, handle_error
+from stouputils.io import clean_path
+from stouputils.print import error, info
+
+
+@handle_error(message="Error while running 'stewbeet'")
+def main():
+    second_arg: str = sys.argv[1] if len(sys.argv) == 2 else ""
+
+    # Try to find and load the beet configuration file
+    cfg: ProjectConfig | None = None
+    if config_path := locate_config(os.getcwd(), parents=True):
+        cfg = load_config(filename=config_path)
+        if cfg:
+            os.chdir(config_path.parent)
+    if not cfg:
+        error(f"No beet config file found in the current directory '{clean_path(os.getcwd())}'")
+
+    # Check if the command is "clean" or "rebuild"
+    if second_arg in ["clean", "rebuild"]:
+        info("Cleaning project and caches...")
+
+        # Remove the beet cache directory
+        subprocess.run(["beet", "cache", "-c"], check=False, capture_output=True)
+        if os.path.exists(".beet_cache"):
+            shutil.rmtree(".beet_cache", ignore_errors=True)
+
+        # Remove the output directory specified in the config
+        shutil.rmtree(cfg.output, ignore_errors=True)
+
+        # Remove all __pycache__ folders
+        for root, dirs, _ in os.walk("."):
+            if "__pycache__" in dirs:
+                cache_dir: str = os.path.join(root, "__pycache__")
+                shutil.rmtree(cache_dir, ignore_errors=True)
+
+        # Load metadata from config into a Box
+        meta: Box = Box(cfg.meta, default_box=True, default_box_attr={})
+
+        # Remove manual cache directory if specified in metadata
+        cache_path: str = meta.stewbeet.manual.cache_path
+        if cache_path and os.path.exists(cache_path):
+            shutil.rmtree(cache_path, ignore_errors=True)
+
+        # Remove debug definitions file if it exists
+        definitions_debug: str = meta.stewbeet.definitions_debug
+        if definitions_debug and os.path.exists(definitions_debug):
+            os.remove(definitions_debug)
+        info("Cleaning done!")
+
+    if second_arg != "clean":
+        # Add current directory to Python path
+        current_dir: str = os.getcwd()
+        if current_dir not in sys.path:
+            sys.path.insert(0, current_dir)
+
+        # Try to import all pipeline
+        for plugin in cfg.pipeline:
+            handle_error(importlib.import_module, error_log=LogLevels.ERROR_TRACEBACK)(plugin)
+
+        # Run beet with all remaining arguments
+        subprocess.run(["beet"] + [x for x in sys.argv[1:] if x != "rebuild"], check=False)
+
+
+if __name__ == "__main__":
+    main()

stewbeet-0.0.1/stewbeet/continuous_delivery/__init__.py

@@ -0,0 +1,8 @@
+
+# Imports
+from .cd_utils import *
+from .github import *
+from .modrinth import *
+from .pmc import *
+from .smithed import *
+

stewbeet-0.0.1/stewbeet/continuous_delivery/cd_utils.py

@@ -0,0 +1,27 @@
+
+# Imports
+import os
+
+from stouputils.continuous_delivery.cd_utils import handle_response, load_credentials  # noqa: F401
+
+from ...stewbeet.core.constants import MINECRAFT_VERSION
+
+
+# Function that replace the "~" by the user's home directory
+def replace_tilde(path: str) -> str:
+	return path.replace("~", os.path.expanduser("~"))
+
+# Supported versions
+def get_supported_versions(version: str = MINECRAFT_VERSION) -> list[str]:
+	""" Get the supported versions for a given version of Minecraft
+
+	Args:
+		version (str): Version of Minecraft
+	Returns:
+		list[str]: List of supported versions, ex: ["1.21.3", "1.21.2"]
+	"""
+	supported_versions: list[str] = [version]
+	if version == "1.21.3":
+		supported_versions.append("1.21.2")
+	return supported_versions
+

stewbeet-0.0.1/stewbeet/continuous_delivery/github.py

@@ -0,0 +1,3 @@
+
+from stouputils.continuous_delivery.github import *
+

stewbeet-0.0.1/stewbeet/continuous_delivery/modrinth.py

@@ -0,0 +1,259 @@
+
+# Imports
+import json
+import os
+
+import requests
+import stouputils as stp
+
+from .cd_utils import get_supported_versions, handle_response
+
+# Constants
+MODRINTH_API_URL: str = "https://api.modrinth.com/v2"
+PROJECT_ENDPOINT: str = f"{MODRINTH_API_URL}/project"
+VERSION_ENDPOINT: str = f"{MODRINTH_API_URL}/version"
+
+def validate_credentials(credentials: dict[str, str]) -> str:
+	""" Get and validate Modrinth credentials
+
+	Args:
+		credentials (dict[str, str]): Credentials for the Modrinth API
+	Returns:
+		str: API key for Modrinth
+	"""
+	if "modrinth_api_key" not in credentials:
+		raise ValueError("The credentials file must contain a 'modrinth_api_key' key, which is a PAT (Personal Access Token) for the Modrinth API: https://modrinth.com/settings/pats")
+	return credentials["modrinth_api_key"]
+
+def validate_config(modrinth_config: dict[str, str]) -> tuple[str, str, str, str, str, str, str]:
+	""" Validate Modrinth configuration
+
+	Args:
+		modrinth_config (dict[str, str]): Configuration for the Modrinth project
+	Returns:
+		str: Project name on Modrinth
+		str: Version of the project
+		str: Slug (namespace) of the project
+		str: Summary of the project
+		str: Description in Markdown format
+		str: Version type (release, beta, alpha)
+		str: Build folder path
+	"""
+	required_keys = [
+		"project_name", "version", "slug", "summary",
+		"description_markdown", "version_type", "build_folder"
+	]
+	error_messages = {
+		"project_name": "name of the project on Modrinth",
+		"version": "version of the project",
+		"slug": "namespace of the project",
+		"summary": "summary of the project",
+		"description_markdown": "description of the project in Markdown format",
+		"version_type": "version type of the project (release, beta, alpha)",
+		"build_folder": "folder containing the build of the project (datapack and resourcepack zip files)"
+	}
+
+	for key in required_keys:
+		if key not in modrinth_config:
+			raise ValueError(f"The modrinth_config dictionary must contain a '{key}' key, which is the {error_messages[key]}")
+
+	return (
+		modrinth_config["project_name"],
+		modrinth_config["version"],
+		modrinth_config["slug"],
+		modrinth_config["summary"],
+		modrinth_config["description_markdown"],
+		modrinth_config["version_type"],
+		modrinth_config["build_folder"]
+	)
+
+def get_project(slug: str, headers: dict[str, str]) -> dict:
+	""" Get project from Modrinth
+
+	Args:
+		slug (str): Project slug/namespace
+		headers (dict[str, str]): Headers for Modrinth API requests
+	Returns:
+		dict: Project data
+	"""
+	stp.progress(f"Getting project {slug} from Modrinth")
+	search_response = requests.get(f"{PROJECT_ENDPOINT}/{slug}", headers=headers)
+	handle_response(search_response, f"Project not found on Modrinth, with namespace {slug}, please create it manually on https://modrinth.com/")
+	return search_response.json()
+
+def update_project_description(slug: str, description: str, summary: str, headers: dict[str, str]) -> None:
+	""" Update project description and summary
+
+	Args:
+		slug (str): Project slug/namespace
+		description (str): Project description in Markdown
+		summary (str): Project summary
+		headers (dict[str, str]): Headers for Modrinth API requests
+	"""
+	stp.progress("Updating project description")
+	update_response = requests.patch(
+		f"{PROJECT_ENDPOINT}/{slug}",
+		headers=headers,
+		json={"body": description.strip(), "description": summary.strip()}
+	)
+	handle_response(update_response, "Failed to update project description")
+
+def handle_existing_version(slug: str, version: str, headers: dict[str, str]) -> bool:
+	""" Check and handle existing version
+
+	Args:
+		slug (str): Project slug/namespace
+		version (str): Version to check
+		headers (dict[str, str]): Headers for Modrinth API requests
+	Returns:
+		bool: True if we should continue, False otherwise
+	"""
+	version_response = requests.get(f"{PROJECT_ENDPOINT}/{slug}/version/{version}", headers=headers)
+	if version_response.status_code == 200:
+		stp.warning(f"Version {version} already exists on Modrinth, do you want to delete it? (y/N)")
+		if input().lower() != "y":
+			return False
+		version_id: str = version_response.json()["id"]
+		delete_response = requests.delete(f"{VERSION_ENDPOINT}/{version_id}", headers=headers)
+		handle_response(delete_response, "Failed to delete the version")
+	elif version_response.status_code == 404:
+		stp.info(f"Version {version} not found on Modrinth, uploading...")
+	else:
+		stp.handle_response(version_response, "Failed to check if the version already exists")
+	return True
+
+def get_file_parts(project_name: str, build_folder: str) -> list[str]:
+	""" Get file parts to upload
+
+	Args:
+		project_name (str): Name of the project
+		build_folder (str): Path to build folder
+	Returns:
+		list[str]: List of file paths to upload
+	"""
+	file_parts: list[str] = [
+		f"{build_folder}/{project_name}_datapack_with_libs.zip",
+		f"{build_folder}/{project_name}_resource_pack_with_libs.zip"
+	]
+	file_parts = [file_part for file_part in file_parts if os.path.exists(file_part)]
+	if len(file_parts) == 0:
+		file_parts = [
+			f"{build_folder}/{project_name}_datapack.zip",
+			f"{build_folder}/{project_name}_resource_pack.zip"
+		]
+		file_parts = [file_part for file_part in file_parts if os.path.exists(file_part)]
+	if len(file_parts) == 0:
+		raise ValueError(f"No file parts (datapack and resourcepack zip files) found in {build_folder}, please check the build_folder path in the modrinth_config file")
+	return file_parts
+
+def upload_version(
+	project_id: str,
+	project_name: str,
+	version: str,
+	version_type: str,
+	changelog: str,
+	file_parts: list[str],
+	headers: dict[str, str],
+	dependencies: list[str] | None = None
+) -> dict:
+	""" Upload new version
+
+	Args:
+		project_id		(str):				Modrinth project ID
+		project_name	(str):				Name of the project
+		version			(str):				Version number
+		version_type	(str):				Type of version (release, beta, alpha)
+		changelog		(str):				Changelog text
+		file_parts		(list[str]):		List of files to upload
+		headers			(dict[str, str]):	Headers for Modrinth API requests
+		dependencies	(list[str]):		List of dependencies
+	Returns:
+		dict: Upload response data
+	"""
+	if dependencies is None:
+		dependencies = []
+	stp.progress(f"Creating version {version}")
+	files: dict[str, bytes] = {}
+	for file_part in file_parts:
+		stp.progress(f"Reading file {os.path.basename(file_part)}")
+		with open(file_part, "rb") as file:
+			files[os.path.basename(file_part)] = file.read()
+
+	request_data: dict = {
+		"name": f"{project_name} [v{version}]",
+		"version_number": version,
+		"changelog": changelog,
+		"dependencies": dependencies,
+		"game_versions": get_supported_versions(),
+		"version_type": version_type,
+		"loaders": ["datapack"],
+		"featured": False,
+		"status": "listed",
+		"project_id": project_id,
+		"file_parts": [os.path.basename(file_part) for file_part in file_parts],
+		"primary_file": os.path.basename(file_parts[0])
+	}
+
+	upload_response = requests.post(
+		VERSION_ENDPOINT,
+		headers=headers,
+		data={"data": json.dumps(request_data)},
+		files=files,
+		timeout=10,
+		stream=False
+	)
+	json_response: dict = upload_response.json()
+	handle_response(upload_response, "Failed to upload the version")
+	return json_response
+
+def set_resource_pack_required(version_id: str, resource_pack_hash: str, headers: dict[str, str]) -> None:
+	""" Set resource pack as required
+
+	Args:
+		version_id (str): ID of the version
+		resource_pack_hash (str): SHA1 hash of resource pack
+		headers (dict[str, str]): Headers for Modrinth API requests
+	"""
+	stp.progress("Setting resource pack as required")
+	version_response = requests.patch(
+		f"{VERSION_ENDPOINT}/{version_id}",
+		headers=headers,
+		json={"file_types": [{"algorithm": "sha1", "hash": resource_pack_hash, "file_type": "required-resource-pack"}]}
+	)
+	handle_response(version_response, "Failed to put the resource pack as required")
+
+@stp.measure_time(stp.progress, "Uploading to modrinth took")
+@stp.handle_error()
+def upload_to_modrinth(credentials: dict[str, str], modrinth_config: dict, changelog: str = "") -> None:
+	""" Upload the project to Modrinth using the credentials and the configuration
+
+	Args:
+		credentials		(dict[str, str]):	Credentials for the Modrinth API
+		modrinth_config	(dict):				Configuration for the Modrinth project
+		changelog		(str):				Changelog text for the release
+	"""
+	api_key = validate_credentials(credentials)
+	headers: dict[str, str] = {"Authorization": api_key}
+
+	project_name, version, slug, summary, description_markdown, version_type, build_folder = validate_config(modrinth_config)
+
+	project = get_project(slug, headers)
+	update_project_description(slug, description_markdown, summary, headers)
+	can_continue: bool = handle_existing_version(slug, version, headers)
+	if not can_continue:
+		return
+
+	file_parts = get_file_parts(project_name, build_folder)
+
+	json_response = upload_version(
+		project["id"], project_name, version, version_type,
+		changelog, file_parts, headers, modrinth_config.get("dependencies", [])
+	)
+
+	if len(file_parts) > 1:
+		resource_pack_hash: str = json_response["files"][1]["hashes"]["sha1"]
+		set_resource_pack_required(json_response["id"], resource_pack_hash, headers)
+
+	stp.info(f"Project {project_name} updated on Modrinth!")
+
+