android-localisation 1.1.2__tar.gz → 1.1.3__tar.gz

{android_localisation-1.1.2/android_localisation.egg-info → android_localisation-1.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: android-localisation
-Version: 1.1.2
+Version: 1.1.3
 Summary: Zero-dependency Android strings.xml translation and verification using LLMs (Gemini, OpenAI, Anthropic, Ollama).
 License: MIT
 Project-URL: Homepage, https://github.com/BharathKmalviya/android-llm-localization
@@ -56,6 +56,30 @@ Requires Python 3.8+. No other dependencies.
 
 CLI output uses UTF-8, including when redirected to a file or pipe on Windows.
 
+### Windows PATH setup
+
+If PowerShell cannot find `android-localise`, run this once using the same Python
+that installed the package:
+
+```powershell
+python -m android_localisation setup-path
+```
+
+This detects the installed Scripts folder and adds it to your **user PATH**,
+preserving existing entries and avoiding duplicates. No administrator access is
+required. Close and reopen your terminal application afterward. Normal wheel
+installation with `pip` does not run this setup automatically, and existing
+PowerShell sessions cannot have their environment changed by the child Python
+process. Virtual environments should be activated instead; their Scripts folders
+are not persisted in user PATH.
+
+The CLI also works immediately through Python on any platform:
+
+```powershell
+python -m android_localisation --help
+python -m android_localisation translate --api-key YOUR_KEY
+```
+
 ### Update notices
 
 Interactive `android-localise` commands check PyPI for a newer stable release in
@@ -148,6 +172,20 @@ Run `android-localise translate --api-key YOUR_KEY` and it picks up locale folde
 
 ## Commands
 
+Run `android-localise` or `android-localise --help` to see every command and the
+typical workflow. Each command has detailed help with its options and examples:
+
+```bash
+android-localise translate --help
+android-localise fix --help
+android-localise verify --help
+android-localise models --help
+python -m android_localisation setup-path --help
+```
+
+Use `android-localise --version` to check the installed version. Help/version
+requests do not call providers, check for updates or modify files/PATH.
+
 ### `translate`
 
 ```bash
@@ -234,6 +272,18 @@ Lists this CLI's configured defaults and automatic fallbacks, not the provider's
 
 ---
 
+### `setup-path` (Windows)
+
+```powershell
+python -m android_localisation setup-path
+```
+
+Adds the installed Scripts directory to Windows user PATH. See
+[Windows PATH setup](#windows-path-setup) for terminal restart and virtual
+environment behavior. All commands can also run through `python -m android_localisation`.
+
+---
+
 ## Providers
 
 By default the tool uses Gemini with `gemini-3.8-flash`. You can switch providers with `--provider` and optionally pin a specific model with `--model`. Configured defaults and fallbacks use only the latest general-purpose text-model lineup, with defaults favoring speed and cost within that lineup.

{android_localisation-1.1.2 → android_localisation-1.1.3}/README.md

@@ -28,6 +28,30 @@ Requires Python 3.8+. No other dependencies.
 
 CLI output uses UTF-8, including when redirected to a file or pipe on Windows.
 
+### Windows PATH setup
+
+If PowerShell cannot find `android-localise`, run this once using the same Python
+that installed the package:
+
+```powershell
+python -m android_localisation setup-path
+```
+
+This detects the installed Scripts folder and adds it to your **user PATH**,
+preserving existing entries and avoiding duplicates. No administrator access is
+required. Close and reopen your terminal application afterward. Normal wheel
+installation with `pip` does not run this setup automatically, and existing
+PowerShell sessions cannot have their environment changed by the child Python
+process. Virtual environments should be activated instead; their Scripts folders
+are not persisted in user PATH.
+
+The CLI also works immediately through Python on any platform:
+
+```powershell
+python -m android_localisation --help
+python -m android_localisation translate --api-key YOUR_KEY
+```
+
 ### Update notices
 
 Interactive `android-localise` commands check PyPI for a newer stable release in
@@ -120,6 +144,20 @@ Run `android-localise translate --api-key YOUR_KEY` and it picks up locale folde
 
 ## Commands
 
+Run `android-localise` or `android-localise --help` to see every command and the
+typical workflow. Each command has detailed help with its options and examples:
+
+```bash
+android-localise translate --help
+android-localise fix --help
+android-localise verify --help
+android-localise models --help
+python -m android_localisation setup-path --help
+```
+
+Use `android-localise --version` to check the installed version. Help/version
+requests do not call providers, check for updates or modify files/PATH.
+
 ### `translate`
 
 ```bash
@@ -206,6 +244,18 @@ Lists this CLI's configured defaults and automatic fallbacks, not the provider's
 
 ---
 
+### `setup-path` (Windows)
+
+```powershell
+python -m android_localisation setup-path
+```
+
+Adds the installed Scripts directory to Windows user PATH. See
+[Windows PATH setup](#windows-path-setup) for terminal restart and virtual
+environment behavior. All commands can also run through `python -m android_localisation`.
+
+---
+
 ## Providers
 
 By default the tool uses Gemini with `gemini-3.8-flash`. You can switch providers with `--provider` and optionally pin a specific model with `--model`. Configured defaults and fallbacks use only the latest general-purpose text-model lineup, with defaults favoring speed and cost within that lineup.

{android_localisation-1.1.2 → android_localisation-1.1.3}/android_localisation/__init__.py

@@ -2,4 +2,4 @@
 android-localisation: Zero-dependency Android strings.xml translation using LLMs.
 """
 
-__version__ = "1.1.2"
+__version__ = "1.1.3"

android_localisation-1.1.3/android_localisation/__main__.py

@@ -0,0 +1,6 @@
+"""Run the CLI through Python when its console script is not on PATH."""
+
+from android_localisation.cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())

android_localisation-1.1.3/android_localisation/cli.py

@@ -0,0 +1,191 @@
+"""
+Unified CLI entry point for android-localisation.
+
+Usage:
+    android-localise translate --api-key KEY
+    android-localise fix
+    android-localise verify
+    android-localise models
+"""
+
+import argparse
+import sys
+from android_localisation import __version__
+
+
+def main(args=None):
+    for stream in (sys.stdout, sys.stderr):
+        if hasattr(stream, "reconfigure"):
+            stream.reconfigure(encoding="utf-8", errors="replace")
+    parser = argparse.ArgumentParser(
+        prog="android-localise",
+        description="Zero-dependency Android strings.xml localization using LLMs.",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""Typical workflow:
+  android-localise translate --languages hi,es --app-context "a notes app"
+  android-localise fix
+  android-localise verify
+
+Other examples:
+  android-localise translate --languages hi --missing-only --dry-run
+  android-localise models --provider openai
+  python -m android_localisation setup-path          (Windows, one-time)
+
+Use android-localise COMMAND --help for flags, defaults and examples.
+All commands also work with: python -m android_localisation COMMAND
+Keys: GEMINI_API_KEY, OPENAI_API_KEY, ANTHROPIC_API_KEY, or API_KEY.
+Update notices: set ANDROID_LOCALISE_NO_UPDATE_CHECK=1 to disable them.""",
+    )
+    parser.add_argument("--version", action="version", version=f"android-localisation {__version__}")
+
+    subparsers = parser.add_subparsers(dest="command", metavar="COMMAND", title="commands")
+    subparsers.required = True
+
+    # --- translate ---
+    translate_parser = subparsers.add_parser(
+        "translate", help="Translate strings.xml into selected or existing locales",
+        description="""Translate values/strings.xml using the selected provider and app context.
+Output is validated before saving. Existing locale files are refreshed by
+default; --missing-only preserves existing resources and fills missing ones.""",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""Examples:
+  android-localise translate --languages hi,es --app-context "a notes app"
+  android-localise translate --provider openai --res-dir path/to/res
+  android-localise translate --languages hi --missing-only --dry-run
+  android-localise translate --provider custom --model YOUR_LOCAL_MODEL --base-url http://localhost:11434/v1/chat/completions
+
+Source: RES_DIR/values/strings.xml. Existing locale folders are used when
+--languages is omitted. --dry-run may incur API charges.
+Exit codes: 0 success, 1 setup/API/validation/save failure, 2 invalid arguments.
+Use android-localise models to see current defaults and fallbacks.""",
+    )
+    translate_parser.add_argument("--res-dir", default="app/src/main/res", help="Path to the Android res/ directory (default: app/src/main/res)")
+    translate_parser.add_argument("--provider", choices=["gemini", "openai", "anthropic", "custom"], default="gemini", help="AI provider (default: gemini)")
+    translate_parser.add_argument("--model", help="Pin any supported model and disable fallbacks (default: provider default; see models)")
+    translate_parser.add_argument("--api-key", help="API key, or set GEMINI_API_KEY / OPENAI_API_KEY / ANTHROPIC_API_KEY / API_KEY")
+    translate_parser.add_argument("--base-url", help="Custom OpenAI-compatible endpoint URL (required for 'custom' provider)")
+    translate_parser.add_argument("--app-context", help="Short description of your app for better translations")
+    translate_parser.add_argument("--sleep", type=float, default=5.0, help="Seconds between API requests (default: 5.0)")
+    from android_localisation.translate import DEFAULT_API_TIMEOUT, MAX_TIMEOUT_RETRIES
+    translate_parser.add_argument(
+        "--timeout", type=float, default=DEFAULT_API_TIMEOUT,
+        help=f"Seconds to wait for each API response, up to {MAX_TIMEOUT_RETRIES + 1} attempts on timeout (default: {DEFAULT_API_TIMEOUT})",
+    )
+    translate_parser.add_argument("--languages", help="Comma-separated locales (hi,es-rES,b+zh+Hans); folders are created after valid output")
+    translate_parser.add_argument("--missing-only", action="store_true", help="Translate missing resources while retaining existing translations")
+    translate_parser.add_argument("--dry-run", action="store_true", help="Generate and validate translations, then show a diff without writing files (API usage applies)")
+
+    # --- fix ---
+    fix_parser = subparsers.add_parser(
+        "fix", help="Repair apostrophe and percent escaping in locale strings",
+        description="""Repair escaping in locale <string> text and save validated XML atomically.
+Skips formatted=false and translatable=false strings. Does not repair
+malformed XML, double quotes, string-array items or plural items.""",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""Examples:
+  android-localise fix
+  android-localise fix --res-dir path/to/res
+
+Run verify and your Android build afterward. Exit code 1 reports failures.""",
+    )
+    fix_parser.add_argument("--res-dir", default="app/src/main/res", help="Path to the Android res/ directory (default: app/src/main/res)")
+
+    # --- verify ---
+    verify_parser = subparsers.add_parser(
+        "verify", help="Check XML resources and Java format arguments (requires JDK)",
+        description="""Compare localized strings.xml files with values/strings.xml, then run
+Java formatting checks for strings, arrays and plurals. Checks cover XML,
+resource coverage, protected content, attributes, markup and format arguments.
+Requires java and javac on PATH; does not replace an Android build or review.""",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""Examples:
+  android-localise verify
+  android-localise verify --res-dir path/to/res
+
+Exit code 0 means checks passed; 1 reports resource, Java or setup failures.""",
+    )
+    verify_parser.add_argument("--res-dir", default="app/src/main/res", help="Path to the Android res/ directory (default: app/src/main/res)")
+
+    # --- models ---
+    models_parser = subparsers.add_parser(
+        "models", help="List configured model defaults and fallbacks",
+        description="""List this CLI release's provider defaults and automatic fallback models.
+Use translate --model to pin a model, including models not in this list.
+Custom/local providers require an explicit --model.""",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""Examples:
+  android-localise models
+  android-localise models --provider openai""",
+    )
+    models_parser.add_argument("--provider", choices=["gemini", "openai", "anthropic"], default=None,
+                               help="Filter by provider (shows all if not set)")
+
+    subparsers.add_parser(
+        "setup-path", help="Add the installed Scripts folder to Windows user PATH",
+        description="""One-time Windows setup for an installed CLI that PowerShell cannot find.
+Adds the installed Scripts folder to user PATH without administrator access,
+preserving entries and avoiding duplicates. Virtual environments use activation.
+Ordinary commands and pip installation do not change PATH.""",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""Run with the same Python that installed the package:
+  python -m android_localisation setup-path
+
+Close and reopen your terminal application afterward. Until then, use:
+  python -m android_localisation --help
+
+Exit code 1 reports unsupported platforms, virtual environments or setup failures.""",
+    )
+
+    if args is None or isinstance(args, list):
+        argv = sys.argv[1:] if args is None else args
+        if not argv:
+            parser.print_help()
+            return 0
+        args = parser.parse_args(argv)
+
+    from android_localisation.updates import start_update_check, show_update_notice
+    update_state = start_update_check()
+    try:
+        return _run_command(args)
+    finally:
+        show_update_notice(update_state)
+
+
+def _run_command(args):
+    if args.command == "setup-path":
+        from android_localisation.setup_path import main as run
+        return run(args)
+
+    elif args.command == "translate":
+        from android_localisation.translate import main as run
+        return run(args)
+
+    elif args.command == "fix":
+        from android_localisation.fix import main as run
+        return run(args)
+
+    elif args.command == "verify":
+        from android_localisation.verify import main as run
+        return run(args)
+
+    elif args.command == "models":
+        from android_localisation.translate import PROVIDER_MODELS
+        providers = [args.provider] if args.provider else ["gemini", "openai", "anthropic"]
+        print()
+        for p in providers:
+            models = PROVIDER_MODELS.get(p, [])
+            print(f"  {p.upper()}")
+            for i, m in enumerate(models):
+                tag = " (default)" if i == 0 else f" (fallback {i})" if i < len(models) - 1 else " (fallback)"
+                print(f"    {'→' if i == 0 else ' '} {m}{tag}")
+            print()
+        print("  CUSTOM (Ollama, LM Studio, etc.)")
+        print("    → Any model name your local server supports (must use --model)")
+        print()
+        print("  Tip: use --model to pick any model, e.g:")
+        print("    android-localise translate --provider openai --model gpt-6-luna --api-key KEY")
+        print()
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

{android_localisation-1.1.2 → android_localisation-1.1.3}/android_localisation/fix.py

@@ -46,8 +46,8 @@ def _fix_text(text):
 
 
 def _parse_args(args=None):
-    parser = argparse.ArgumentParser(description="Fix common string formatting issues in Android strings.xml files.")
-    parser.add_argument("--res-dir", default="app/src/main/res", help="Path to the Android res/ directory")
+    parser = argparse.ArgumentParser(description="Repair apostrophe and percent escaping in locale string text; requires parseable XML. Skips formatted=false/translatable=false strings and does not repair arrays or plurals.")
+    parser.add_argument("--res-dir", default="app/src/main/res", help="Path to the Android res/ directory (default: app/src/main/res)")
     return parser.parse_args(args)
 
 

android_localisation-1.1.3/android_localisation/setup_path.py

@@ -0,0 +1,104 @@
+"""One-time Windows user PATH setup; never run implicitly during imports."""
+
+import argparse
+import os
+from pathlib import Path
+import sys
+import sysconfig
+
+
+def _script_directory():
+    directories = [sysconfig.get_path("scripts")]
+    if "nt_user" in sysconfig.get_scheme_names():
+        user_scripts = sysconfig.get_path("scripts", scheme="nt_user")
+        user_library = sysconfig.get_path("purelib", scheme="nt_user")
+        try:
+            if os.path.normcase(os.path.commonpath([os.path.abspath(__file__), user_library])) == os.path.normcase(user_library):
+                directories.insert(0, user_scripts)
+            else:
+                directories.append(user_scripts)
+        except ValueError:
+            directories.append(user_scripts)
+    for directory in directories:
+        if (Path(directory) / "android-localise.exe").is_file():
+            return str(Path(directory).resolve())
+    raise ValueError(
+        "Cannot find android-localise.exe for this Python. Reinstall with: "
+        "python -m pip install --upgrade android-localisation"
+    )
+
+
+def _contains_directory(path, directory):
+    def normalized(value):
+        return os.path.normcase(os.path.normpath(os.path.expandvars(value.strip().strip('"'))))
+    return any(entry.strip() and normalized(entry) == normalized(directory)
+               for entry in path.split(";"))
+
+
+def _add_user_path(directory):
+    import winreg
+    if ";" in directory:
+        raise ValueError("The Scripts directory contains a semicolon and cannot be added to PATH.")
+    with winreg.CreateKeyEx(winreg.HKEY_CURRENT_USER, "Environment", 0,
+                           winreg.KEY_QUERY_VALUE | winreg.KEY_SET_VALUE) as key:
+        try:
+            existing, kind = winreg.QueryValueEx(key, "Path")
+        except FileNotFoundError:
+            existing, kind = "", winreg.REG_EXPAND_SZ
+        if not isinstance(existing, str) or kind not in (winreg.REG_SZ, winreg.REG_EXPAND_SZ):
+            raise ValueError("User PATH has an unexpected registry type; no changes made.")
+        if _contains_directory(existing, directory):
+            return False
+        separator = ";" if existing and not existing.endswith(";") else ""
+        updated = existing + separator + directory
+        if len(updated) >= 32767:
+            raise ValueError("User PATH would exceed Windows' length limit; no changes made.")
+        winreg.SetValueEx(key, "Path", 0, kind, updated)
+    return True
+
+
+def _notify_environment_change():
+    # Let Windows shells refresh their environment; existing terminals still
+    # inherit their original environment until the terminal application restarts.
+    try:
+        import ctypes
+        from ctypes import wintypes
+        notify = ctypes.WinDLL("user32", use_last_error=True).SendMessageTimeoutW
+        notify.argtypes = [wintypes.HWND, wintypes.UINT, wintypes.WPARAM,
+                           ctypes.c_wchar_p, wintypes.UINT, wintypes.UINT,
+                           ctypes.POINTER(ctypes.c_size_t)]
+        notify.restype = wintypes.LPARAM
+        result = ctypes.c_size_t()
+        notify(0xffff, 0x001a, 0, "Environment", 2, 1000, ctypes.byref(result))
+    except Exception:
+        pass
+
+
+def _parse_args(args=None):
+    return argparse.ArgumentParser(description="Add this Python's CLI Scripts directory to Windows user PATH.").parse_args(args)
+
+
+def main(args=None):
+    if args is None or isinstance(args, list):
+        args = _parse_args(args)
+    if os.name != "nt":
+        print("setup-path is for Windows. You can run the CLI with: python -m android_localisation --help")
+        return 1
+    if sys.prefix != sys.base_prefix or hasattr(sys, "real_prefix"):
+        print("Virtual environment detected. Activate it to use android-localise; its temporary Scripts directory will not be added to user PATH.")
+        return 1
+    try:
+        directory = _script_directory()
+        changed = _add_user_path(directory)
+    except (OSError, ValueError) as error:
+        print("PATH setup failed: {}".format(error))
+        return 1
+    _notify_environment_change()
+    print("{}: {}".format("Added to user PATH" if changed else "Already on user PATH", directory))
+    print("Close and reopen your terminal application, then run: android-localise --help")
+    print("You can use it immediately in this terminal with: python -m android_localisation --help")
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

{android_localisation-1.1.2 → android_localisation-1.1.3}/android_localisation/translate.py

@@ -294,17 +294,20 @@ def translate_xml(provider, api_key, model, source_xml, target_folder_name, app_
 
 
 def _parse_args(args=None):
-    parser = argparse.ArgumentParser(description="Translate Android strings.xml using LLMs.")
-    parser.add_argument("--res-dir", default=DEFAULT_RES_DIR)
-    parser.add_argument("--provider", choices=["gemini", "openai", "anthropic", "custom"], default="gemini")
-    parser.add_argument("--model", help="Any model name for the chosen provider. Uses provider default if not set.")
-    parser.add_argument("--api-key")
-    parser.add_argument("--base-url")
-    parser.add_argument("--app-context")
-    parser.add_argument("--sleep", type=float, default=5.0)
+    parser = argparse.ArgumentParser(
+        description="Translate values/strings.xml using LLMs; validate output before saving. Existing locale files are refreshed unless --missing-only is set.",
+        epilog="Use python -m android_localisation translate --help for workflow examples, or python -m android_localisation models for model defaults.",
+    )
+    parser.add_argument("--res-dir", default=DEFAULT_RES_DIR, help="Path to the Android res/ directory (default: app/src/main/res)")
+    parser.add_argument("--provider", choices=["gemini", "openai", "anthropic", "custom"], default="gemini", help="AI provider (default: gemini)")
+    parser.add_argument("--model", help="Pin any supported model and disable fallbacks (default: provider default; see models)")
+    parser.add_argument("--api-key", help="API key, or set GEMINI_API_KEY / OPENAI_API_KEY / ANTHROPIC_API_KEY / API_KEY")
+    parser.add_argument("--base-url", help="Custom OpenAI-compatible endpoint URL (required for 'custom' provider)")
+    parser.add_argument("--app-context", help="Short description of your app for better translations")
+    parser.add_argument("--sleep", type=float, default=5.0, help="Seconds between API requests (default: 5.0)")
     parser.add_argument("--timeout", type=float, default=DEFAULT_API_TIMEOUT,
                         help=f"Seconds to wait for each API response, up to {MAX_TIMEOUT_RETRIES + 1} attempts on timeout (default: {DEFAULT_API_TIMEOUT})")
-    parser.add_argument("--languages", help="Comma-separated language codes to translate into, e.g. hi,es,fr,de. Creates folders automatically if they don't exist.")
+    parser.add_argument("--languages", help="Comma-separated locales (hi,es-rES,b+zh+Hans); folders are created after valid output")
     parser.add_argument("--missing-only", action="store_true", help="Translate missing resources while retaining existing translations")
     parser.add_argument("--dry-run", action="store_true", help="Generate and validate translations, then show a diff without writing files (API usage applies)")
     return parser.parse_args(args)

{android_localisation-1.1.2 → android_localisation-1.1.3}/android_localisation/verify.py

@@ -11,8 +11,8 @@ from android_localisation.resources import locale_folders, parse_resources, vali
 
 
 def _parse_args(args=None):
-    parser = argparse.ArgumentParser(description="Verify Android strings formatting.")
-    parser.add_argument("--res-dir", default="app/src/main/res", help="Path to the Android res/ directory")
+    parser = argparse.ArgumentParser(description="Check XML resource coverage, protected content and format arguments, then run Java formatting checks. Requires java and javac on PATH.")
+    parser.add_argument("--res-dir", default="app/src/main/res", help="Path to the Android res/ directory (default: app/src/main/res)")
     return parser.parse_args(args)
 
 

{android_localisation-1.1.2 → android_localisation-1.1.3/android_localisation.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: android-localisation
-Version: 1.1.2
+Version: 1.1.3
 Summary: Zero-dependency Android strings.xml translation and verification using LLMs (Gemini, OpenAI, Anthropic, Ollama).
 License: MIT
 Project-URL: Homepage, https://github.com/BharathKmalviya/android-llm-localization
@@ -56,6 +56,30 @@ Requires Python 3.8+. No other dependencies.
 
 CLI output uses UTF-8, including when redirected to a file or pipe on Windows.
 
+### Windows PATH setup
+
+If PowerShell cannot find `android-localise`, run this once using the same Python
+that installed the package:
+
+```powershell
+python -m android_localisation setup-path
+```
+
+This detects the installed Scripts folder and adds it to your **user PATH**,
+preserving existing entries and avoiding duplicates. No administrator access is
+required. Close and reopen your terminal application afterward. Normal wheel
+installation with `pip` does not run this setup automatically, and existing
+PowerShell sessions cannot have their environment changed by the child Python
+process. Virtual environments should be activated instead; their Scripts folders
+are not persisted in user PATH.
+
+The CLI also works immediately through Python on any platform:
+
+```powershell
+python -m android_localisation --help
+python -m android_localisation translate --api-key YOUR_KEY
+```
+
 ### Update notices
 
 Interactive `android-localise` commands check PyPI for a newer stable release in
@@ -148,6 +172,20 @@ Run `android-localise translate --api-key YOUR_KEY` and it picks up locale folde
 
 ## Commands
 
+Run `android-localise` or `android-localise --help` to see every command and the
+typical workflow. Each command has detailed help with its options and examples:
+
+```bash
+android-localise translate --help
+android-localise fix --help
+android-localise verify --help
+android-localise models --help
+python -m android_localisation setup-path --help
+```
+
+Use `android-localise --version` to check the installed version. Help/version
+requests do not call providers, check for updates or modify files/PATH.
+
 ### `translate`
 
 ```bash
@@ -234,6 +272,18 @@ Lists this CLI's configured defaults and automatic fallbacks, not the provider's
 
 ---
 
+### `setup-path` (Windows)
+
+```powershell
+python -m android_localisation setup-path
+```
+
+Adds the installed Scripts directory to Windows user PATH. See
+[Windows PATH setup](#windows-path-setup) for terminal restart and virtual
+environment behavior. All commands can also run through `python -m android_localisation`.
+
+---
+
 ## Providers
 
 By default the tool uses Gemini with `gemini-3.8-flash`. You can switch providers with `--provider` and optionally pin a specific model with `--model`. Configured defaults and fallbacks use only the latest general-purpose text-model lineup, with defaults favoring speed and cost within that lineup.

{android_localisation-1.1.2 → android_localisation-1.1.3}/android_localisation.egg-info/SOURCES.txt

@@ -3,9 +3,11 @@ MANIFEST.in
 README.md
 pyproject.toml
 android_localisation/__init__.py
+android_localisation/__main__.py
 android_localisation/cli.py
 android_localisation/fix.py
 android_localisation/resources.py
+android_localisation/setup_path.py
 android_localisation/translate.py
 android_localisation/updates.py
 android_localisation/verify.py

{android_localisation-1.1.2 → android_localisation-1.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "android-localisation"
-version = "1.1.2"
+version = "1.1.3"
 description = "Zero-dependency Android strings.xml translation and verification using LLMs (Gemini, OpenAI, Anthropic, Ollama)."
 readme = "README.md"
 license = { text = "MIT" }

android_localisation-1.1.2/android_localisation/cli.py

@@ -1,104 +0,0 @@
-"""
-Unified CLI entry point for android-localisation.
-
-Usage:
-    android-localise translate --api-key KEY
-    android-localise fix
-    android-localise verify
-    android-localise models
-"""
-
-import argparse
-import sys
-from android_localisation import __version__
-
-
-def main(args=None):
-    for stream in (sys.stdout, sys.stderr):
-        if hasattr(stream, "reconfigure"):
-            stream.reconfigure(encoding="utf-8", errors="replace")
-    parser = argparse.ArgumentParser(
-        prog="android-localise",
-        description="Zero-dependency Android strings.xml localization using LLMs.",
-    )
-    parser.add_argument("--version", action="version", version=f"android-localisation {__version__}")
-
-    subparsers = parser.add_subparsers(dest="command", metavar="COMMAND")
-    subparsers.required = True
-
-    # --- translate ---
-    translate_parser = subparsers.add_parser("translate", help="Translate strings.xml into all locale directories")
-    translate_parser.add_argument("--res-dir", default="app/src/main/res", help="Path to the Android res/ directory (default: app/src/main/res)")
-    translate_parser.add_argument("--provider", choices=["gemini", "openai", "anthropic", "custom"], default="gemini", help="AI provider (default: gemini)")
-    translate_parser.add_argument("--model", help="Any model name supported by the provider (uses provider default if not set)")
-    translate_parser.add_argument("--api-key", help="API key (or set GEMINI_API_KEY / OPENAI_API_KEY / ANTHROPIC_API_KEY)")
-    translate_parser.add_argument("--base-url", help="Custom OpenAI-compatible endpoint URL (required for 'custom' provider)")
-    translate_parser.add_argument("--app-context", help="Short description of your app for better translations")
-    translate_parser.add_argument("--sleep", type=float, default=5.0, help="Seconds between API requests (default: 5.0)")
-    from android_localisation.translate import DEFAULT_API_TIMEOUT, MAX_TIMEOUT_RETRIES
-    translate_parser.add_argument(
-        "--timeout", type=float, default=DEFAULT_API_TIMEOUT,
-        help=f"Seconds to wait for each API response, up to {MAX_TIMEOUT_RETRIES + 1} attempts on timeout (default: {DEFAULT_API_TIMEOUT})",
-    )
-    translate_parser.add_argument("--languages", help="Comma-separated language codes, e.g. hi,es,fr,de — creates folders and strings.xml automatically")
-    translate_parser.add_argument("--missing-only", action="store_true", help="Translate missing resources while retaining existing translations")
-    translate_parser.add_argument("--dry-run", action="store_true", help="Generate and validate translations, then show a diff without writing files (API usage applies)")
-
-    # --- fix ---
-    fix_parser = subparsers.add_parser("fix", help="Fix XML escaping issues in translated strings.xml files")
-    fix_parser.add_argument("--res-dir", default="app/src/main/res", help="Path to the Android res/ directory (default: app/src/main/res)")
-
-    # --- verify ---
-    verify_parser = subparsers.add_parser("verify", help="Verify translated strings won't crash the app (requires javac)")
-    verify_parser.add_argument("--res-dir", default="app/src/main/res", help="Path to the Android res/ directory (default: app/src/main/res)")
-
-    # --- models ---
-    models_parser = subparsers.add_parser("models", help="List configured model defaults and fallbacks")
-    models_parser.add_argument("--provider", choices=["gemini", "openai", "anthropic"], default=None,
-                               help="Filter by provider (shows all if not set)")
-
-    if args is None or isinstance(args, list):
-        args = parser.parse_args(args)
-
-    from android_localisation.updates import start_update_check, show_update_notice
-    update_state = start_update_check()
-    try:
-        return _run_command(args)
-    finally:
-        show_update_notice(update_state)
-
-
-def _run_command(args):
-    if args.command == "translate":
-        from android_localisation.translate import main as run
-        return run(args)
-
-    elif args.command == "fix":
-        from android_localisation.fix import main as run
-        return run(args)
-
-    elif args.command == "verify":
-        from android_localisation.verify import main as run
-        return run(args)
-
-    elif args.command == "models":
-        from android_localisation.translate import PROVIDER_MODELS
-        providers = [args.provider] if args.provider else ["gemini", "openai", "anthropic"]
-        print()
-        for p in providers:
-            models = PROVIDER_MODELS.get(p, [])
-            print(f"  {p.upper()}")
-            for i, m in enumerate(models):
-                tag = " (default)" if i == 0 else f" (fallback {i})" if i < len(models) - 1 else " (fallback)"
-                print(f"    {'→' if i == 0 else ' '} {m}{tag}")
-            print()
-        print("  CUSTOM (Ollama, LM Studio, etc.)")
-        print("    → Any model name your local server supports (must use --model)")
-        print()
-        print("  Tip: use --model to pick any model, e.g:")
-        print("    android-localise translate --provider openai --model gpt-6-luna --api-key KEY")
-        print()
-
-
-if __name__ == "__main__":
-    raise SystemExit(main())