add pico8, update dev docs, new add-app CLI tool, add validation tool
This commit is contained in:
Richard Macias
330
scripts/add-app.py
Normal file
330
scripts/add-app.py
Normal file
@@ -0,0 +1,330 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Interactive CLI to quickly add new apps to applications.json."""
|
||||
|
||||
import json
|
||||
import re
|
||||
import sys
|
||||
from pathlib import Path
|
||||
from urllib.parse import urlparse
|
||||
|
||||
# Default Obtainium settings for GitHub apps
|
||||
DEFAULT_ADDITIONAL_SETTINGS = {
|
||||
"includePrereleases": False,
|
||||
"fallbackToOlderReleases": True,
|
||||
"filterReleaseTitlesByRegEx": "",
|
||||
"filterReleaseNotesByRegEx": "",
|
||||
"verifyLatestTag": False,
|
||||
"sortMethodChoice": "date",
|
||||
"useLatestAssetDateAsReleaseDate": False,
|
||||
"releaseTitleAsVersion": False,
|
||||
"trackOnly": False,
|
||||
"versionExtractionRegEx": "",
|
||||
"matchGroupToUse": "",
|
||||
"versionDetection": True,
|
||||
"releaseDateAsVersion": False,
|
||||
"useVersionCodeAsOSVersion": False,
|
||||
"apkFilterRegEx": "",
|
||||
"invertAPKFilter": False,
|
||||
"autoApkFilterByArch": True,
|
||||
"appName": "",
|
||||
"appAuthor": "",
|
||||
"shizukuPretendToBeGooglePlay": False,
|
||||
"allowInsecure": False,
|
||||
"exemptFromBackgroundUpdates": False,
|
||||
"skipUpdateNotifications": False,
|
||||
"about": "",
|
||||
"refreshBeforeDownload": False,
|
||||
}
|
||||
|
||||
CATEGORIES = [
|
||||
"Emulator",
|
||||
"Frontend",
|
||||
"Utility",
|
||||
"Dual Screen",
|
||||
"PC Emulation",
|
||||
"Streaming",
|
||||
]
|
||||
|
||||
VARIANT_OPTIONS = [
|
||||
"Both", # Include in both standard and dual-screen
|
||||
"Standard only", # Include in standard only
|
||||
"Dual-screen only", # Include in dual-screen only
|
||||
"README only", # Exclude from export, show in table only
|
||||
]
|
||||
|
||||
SOURCE_DETECTION = {
|
||||
"github.com": "GitHub",
|
||||
"gitlab.com": "GitLab",
|
||||
"codeberg.org": "Codeberg",
|
||||
"f-droid.org": "F-Droid",
|
||||
}
|
||||
|
||||
|
||||
def detect_source(url: str) -> str | None:
|
||||
"""Detect the source type from URL."""
|
||||
parsed = urlparse(url)
|
||||
host = parsed.netloc.lower()
|
||||
for domain, source in SOURCE_DETECTION.items():
|
||||
if domain in host:
|
||||
return source
|
||||
return None
|
||||
|
||||
|
||||
def extract_github_info(url: str) -> tuple[str, str] | None:
|
||||
"""Extract author and repo name from GitHub URL."""
|
||||
match = re.match(r"https?://github\.com/([^/]+)/([^/]+)", url)
|
||||
if match:
|
||||
return match.group(1), match.group(2)
|
||||
return None
|
||||
|
||||
|
||||
def prompt(message: str, default: str = "") -> str:
|
||||
"""Prompt user for input with optional default."""
|
||||
if default:
|
||||
result = input(f"{message} [{default}]: ").strip()
|
||||
return result if result else default
|
||||
return input(f"{message}: ").strip()
|
||||
|
||||
|
||||
def prompt_yes_no(message: str, default: bool = True) -> bool:
|
||||
"""Prompt user for yes/no."""
|
||||
default_str = "Y/n" if default else "y/N"
|
||||
result = input(f"{message} [{default_str}]: ").strip().lower()
|
||||
if not result:
|
||||
return default
|
||||
return result in ("y", "yes")
|
||||
|
||||
|
||||
def select_menu(title: str, choices: list[str], default: int = 0) -> str:
|
||||
"""Interactive menu with arrow key navigation."""
|
||||
# Only use curses if we have a real terminal
|
||||
if not sys.stdin.isatty():
|
||||
return _select_menu_fallback(title, choices, default)
|
||||
|
||||
try:
|
||||
import curses
|
||||
return _select_menu_curses(title, choices, default)
|
||||
except Exception:
|
||||
# Fallback to simple input if curses fails
|
||||
return _select_menu_fallback(title, choices, default)
|
||||
|
||||
|
||||
def _select_menu_curses(title: str, choices: list[str], default: int = 0) -> str:
|
||||
"""Curses-based interactive menu."""
|
||||
def menu(stdscr):
|
||||
curses.curs_set(0) # Hide cursor
|
||||
current = default
|
||||
|
||||
while True:
|
||||
stdscr.clear()
|
||||
stdscr.addstr(0, 0, title)
|
||||
stdscr.addstr(1, 0, "(Use arrow keys, Enter to select)")
|
||||
|
||||
for i, choice in enumerate(choices):
|
||||
y = i + 3
|
||||
if i == current:
|
||||
stdscr.attron(curses.A_REVERSE)
|
||||
stdscr.addstr(y, 2, f" {choice} ")
|
||||
stdscr.attroff(curses.A_REVERSE)
|
||||
else:
|
||||
stdscr.addstr(y, 2, f" {choice} ")
|
||||
|
||||
stdscr.refresh()
|
||||
key = stdscr.getch()
|
||||
|
||||
if key == curses.KEY_UP and current > 0:
|
||||
current -= 1
|
||||
elif key == curses.KEY_DOWN and current < len(choices) - 1:
|
||||
current += 1
|
||||
elif key in (curses.KEY_ENTER, 10, 13):
|
||||
return choices[current]
|
||||
elif key == 27: # ESC
|
||||
return choices[default]
|
||||
|
||||
import curses
|
||||
return curses.wrapper(menu)
|
||||
|
||||
|
||||
def _select_menu_fallback(title: str, choices: list[str], default: int = 0) -> str:
|
||||
"""Fallback menu using simple input."""
|
||||
print(f"\n{title}")
|
||||
for i, choice in enumerate(choices):
|
||||
marker = ">" if i == default else " "
|
||||
print(f" {marker} {i + 1}. {choice}")
|
||||
|
||||
while True:
|
||||
result = input(f"Enter number [{default + 1}]: ").strip()
|
||||
if not result:
|
||||
return choices[default]
|
||||
try:
|
||||
idx = int(result) - 1
|
||||
if 0 <= idx < len(choices):
|
||||
return choices[idx]
|
||||
except ValueError:
|
||||
pass
|
||||
print("Invalid choice, try again.")
|
||||
|
||||
|
||||
def generate_app_entry(
|
||||
app_id: str,
|
||||
url: str,
|
||||
author: str,
|
||||
name: str,
|
||||
categories: list[str],
|
||||
source: str,
|
||||
variant: str,
|
||||
name_override: str | None = None,
|
||||
url_override: str | None = None,
|
||||
) -> dict:
|
||||
"""Generate a complete app entry."""
|
||||
app = {
|
||||
"id": app_id,
|
||||
"url": url,
|
||||
"author": author,
|
||||
"name": name,
|
||||
"preferredApkIndex": 0,
|
||||
"additionalSettings": json.dumps(
|
||||
DEFAULT_ADDITIONAL_SETTINGS, separators=(",", ":")
|
||||
),
|
||||
"categories": categories,
|
||||
"overrideSource": source,
|
||||
}
|
||||
|
||||
# Build meta based on variant selection
|
||||
meta = {}
|
||||
if variant == "Standard only":
|
||||
meta["includeInDualScreen"] = False
|
||||
elif variant == "Dual-screen only":
|
||||
meta["includeInStandard"] = False
|
||||
elif variant == "README only":
|
||||
meta["excludeFromExport"] = True
|
||||
# "Both" = no meta needed (default behavior)
|
||||
|
||||
if name_override:
|
||||
meta["nameOverride"] = name_override
|
||||
if url_override:
|
||||
meta["urlOverride"] = url_override
|
||||
|
||||
if meta:
|
||||
app["meta"] = meta
|
||||
|
||||
return app
|
||||
|
||||
|
||||
def main() -> int:
|
||||
"""Interactive CLI to add a new app."""
|
||||
print("=" * 50)
|
||||
print(" Add New App to Obtainium Emulation Pack")
|
||||
print("=" * 50)
|
||||
|
||||
# Get URL first - we can auto-detect a lot from it
|
||||
url = prompt("\nApp URL (GitHub/GitLab/etc.)")
|
||||
if not url:
|
||||
print("URL is required.")
|
||||
return 1
|
||||
|
||||
# Detect source
|
||||
source = detect_source(url)
|
||||
if source:
|
||||
print(f" Detected source: {source}")
|
||||
else:
|
||||
source = prompt("Source type", "GitHub")
|
||||
|
||||
# Try to extract info from GitHub URL
|
||||
author = ""
|
||||
name = ""
|
||||
github_info = extract_github_info(url)
|
||||
if github_info:
|
||||
author, repo_name = github_info
|
||||
# Clean up name (replace hyphens with spaces, title case)
|
||||
name = repo_name.replace("-", " ").replace("_", " ").title()
|
||||
print(f" Detected author: {author}")
|
||||
print(f" Detected name: {name}")
|
||||
|
||||
# Confirm or override detected values
|
||||
author = prompt("Author", author)
|
||||
name = prompt("App name", name)
|
||||
|
||||
# App ID
|
||||
app_id = prompt("Android package ID (e.g., com.example.app)")
|
||||
if not app_id:
|
||||
print("Package ID is required.")
|
||||
return 1
|
||||
|
||||
# Category - interactive menu
|
||||
category = select_menu("Select category:", CATEGORIES)
|
||||
print(f" Selected: {category}")
|
||||
|
||||
# Variant - interactive menu
|
||||
variant = select_menu("Include in which release(s):", VARIANT_OPTIONS)
|
||||
print(f" Selected: {variant}")
|
||||
|
||||
# Optional overrides
|
||||
print("")
|
||||
name_override = ""
|
||||
if prompt_yes_no("Override display name in README table?", False):
|
||||
name_override = prompt("Display name override")
|
||||
|
||||
url_override = ""
|
||||
if prompt_yes_no("Override homepage URL in README table?", False):
|
||||
url_override = prompt("Homepage URL override")
|
||||
|
||||
# Generate the entry
|
||||
app_entry = generate_app_entry(
|
||||
app_id=app_id,
|
||||
url=url,
|
||||
author=author,
|
||||
name=name,
|
||||
categories=[category],
|
||||
source=source,
|
||||
variant=variant,
|
||||
name_override=name_override or None,
|
||||
url_override=url_override or None,
|
||||
)
|
||||
|
||||
# Show preview
|
||||
print("\n" + "=" * 50)
|
||||
print(" Generated Entry Preview")
|
||||
print("=" * 50)
|
||||
print(json.dumps(app_entry, indent=2))
|
||||
|
||||
# Confirm and save
|
||||
if not prompt_yes_no("\nAdd this app to applications.json?", True):
|
||||
print("Cancelled.")
|
||||
return 0
|
||||
|
||||
# Load existing file
|
||||
apps_file = Path("src/applications.json")
|
||||
if not apps_file.exists():
|
||||
print(f"Error: {apps_file} not found. Run from repo root.")
|
||||
return 1
|
||||
|
||||
with open(apps_file, "r", encoding="utf-8") as f:
|
||||
data = json.load(f)
|
||||
|
||||
# Check for duplicate ID
|
||||
existing_ids = {app["id"] for app in data.get("apps", [])}
|
||||
if app_id in existing_ids:
|
||||
print(f"\nWarning: App with ID '{app_id}' already exists!")
|
||||
if not prompt_yes_no("Add anyway?", False):
|
||||
print("Cancelled.")
|
||||
return 0
|
||||
|
||||
# Add the new app
|
||||
data["apps"].append(app_entry)
|
||||
|
||||
# Write back
|
||||
with open(apps_file, "w", encoding="utf-8") as f:
|
||||
json.dump(data, f, indent=2, ensure_ascii=False)
|
||||
f.write("\n")
|
||||
|
||||
print(f"\nApp added to {apps_file}")
|
||||
print("\nNext steps:")
|
||||
print(" 1. Run 'make release' to regenerate all files")
|
||||
print(" 2. Review the diff before committing")
|
||||
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
Reference in New Issue
Block a user