elastro-client 1.3.30__tar.gz → 1.3.32__tar.gz

{elastro_client-1.3.30/elastro_client.egg-info → elastro_client-1.3.32}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: elastro-client
-Version: 1.3.30
+Version: 1.3.32
 Summary: A comprehensive Python library for Elasticsearch management with both programmatic and CLI interfaces
 Author: Austin Jorgensen
 License-Expression: MIT

{elastro_client-1.3.30 → elastro_client-1.3.32}/elastro/__init__.py

@@ -4,7 +4,7 @@ Elasticsearch Management Module.
 A module for managing Elasticsearch operations within a pipeline process.
 """
 
-__version__ = "1.3.30"
+__version__ = "1.3.32"
 
 # Core component imports
 from elastro.core.client import ElasticsearchClient

{elastro_client-1.3.30 → elastro_client-1.3.32}/elastro/cli/commands/config.py

@@ -220,12 +220,19 @@ def run_config_wizard() -> Dict[str, Any]:
     )
 
     # 1. Hosts
+    console.print("\n[bold]1. Cluster Connection:[/bold]")
+    console.print(
+        "Provide the HTTP(S) address of your Elasticsearch cluster. Multiple coordinates can be provided (comma-separated) for round-robin load balancing."
+    )
     default_host = "http://localhost:9200"
     hosts_input = Prompt.ask("🔌 [bold]Elasticsearch Host[/]", default=default_host)
     hosts = [h.strip() for h in hosts_input.split(",")]
 
     # 2. Authentication
-    console.print("\n🔑 [bold]Authentication[/]")
+    console.print("\n🔑 [bold]2. Authentication[/]")
+    console.print(
+        "Select how Elastro should authenticate with the cluster. API Keys are recommended for production environments."
+    )
     auth_type = Prompt.ask(
         "   Method", choices=["basic", "api_key", "none"], default="none"
     )

{elastro_client-1.3.30 → elastro_client-1.3.32}/elastro/cli/commands/ilm.py

@@ -165,6 +165,24 @@ def run_ilm_wizard(name: str) -> Optional[Dict[str, Any]]:
         )
     )
 
+    console.print("\n[bold]Phase Configuration:[/bold]")
+    console.print(
+        "ILM policies automate data tiering. You configure conditions (like index age or size) that dictate when an index moves to the next phase."
+    )
+    console.print(
+        "  [bold red]HOT[/]    - Actively queried and written to. Uses premium fast SSD nodes."
+    )
+    console.print(
+        "  [bold yellow]WARM[/]   - Rarely written to, but frequently queried. Uses standard nodes."
+    )
+    console.print(
+        "  [bold cyan]COLD[/]   - Read-only data. Uses dense, high-capacity nodes."
+    )
+    console.print(
+        "  [bold grey]DELETE[/] - End of lifecycle. Data is permanently purged from the cluster."
+    )
+    console.print()
+
     phases = {}
 
     # --- HOT PHASE ---

{elastro_client-1.3.30 → elastro_client-1.3.32}/elastro/cli/commands/index.py

@@ -421,6 +421,10 @@ def index_wizard(client: ElasticsearchClient) -> None:
     console.print(f"[italic]{recipe.description}[/]\n")
 
     # 3. Prompt for Basic Info
+    console.print("\n[bold]1. Basic Information:[/bold]")
+    console.print(
+        "Indices define where your documents live. Using descriptive, lowercase names (e.g., 'logs-api-prod') is standard practice."
+    )
     index_name = Prompt.ask("Enter index name", default="my-new-index")
 
     # 4. Prepare Configuration
@@ -428,6 +432,10 @@ def index_wizard(client: ElasticsearchClient) -> None:
     mappings = recipe.get_mappings()
 
     # Allow simple overrides for shards/replicas
+    console.print("\n[bold]2. Infrastructure Settings:[/bold]")
+    console.print(
+        "Primary shards dictate write parallelism. Replicas dictate read concurrency and High Availability (HA) resilience."
+    )
     if Confirm.ask("Customize shards/replicas?", default=False):
         settings["number_of_shards"] = IntPrompt.ask(
             "Primary Shards", default=settings.get("number_of_shards", 1)
@@ -440,7 +448,10 @@ def index_wizard(client: ElasticsearchClient) -> None:
 
     # A. Rename Default Fields
     if recipe.customizable_fields:
-        console.print("\n[bold]Customize Default Fields:[/]")
+        console.print("\n[bold]3. Customize Default Fields:[/]")
+        console.print(
+            "This recipe provides standard baseline fields. You may rename them to perfectly match your data model's keys."
+        )
         for field in recipe.customizable_fields:
             if field in mappings["properties"]:
                 new_name = Prompt.ask(f"Rename field '{field}'?", default=field)
@@ -448,7 +459,10 @@ def index_wizard(client: ElasticsearchClient) -> None:
                     mappings["properties"][new_name] = mappings["properties"].pop(field)
 
     # B. Add New Fields
-    console.print("\n[bold]Add Custom Fields:[/]")
+    console.print("\n[bold]4. Add Custom Fields:[/]")
+    console.print(
+        "Explicitly defining fields ensures Elasticsearch indexes data exactly how your application expects it (e.g., 'keyword' for exact matching, 'text' for full-text search)."
+    )
     valid_types = [
         "text",
         "keyword",

{elastro_client-1.3.30 → elastro_client-1.3.32}/elastro/cli/commands/ml.py

@@ -34,6 +34,10 @@ def init_job(client: ElasticsearchClient) -> None:
         "This wizard will configure a basic Single Metric anomaly detection job.\n"
     )
 
+    console.print("[bold]1. Job Definition:[/bold]")
+    console.print(
+        "The Job ID must be unique across the cluster. The Index Pattern defines what data the ML node will process."
+    )
     # 1. Job ID
     job_id = Prompt.ask("Enter a new [bold]Job ID[/bold]", default="anomaly-job-01")
 
@@ -43,14 +47,22 @@ def init_job(client: ElasticsearchClient) -> None:
     )
 
     # 3. Time Field
+    console.print("\n[bold]2. Analysis Configuration:[/bold]")
+    console.print(
+        "The time field is required to build time-series buckets. The metric field is the actual numerical value being analyzed (e.g., CPU %, response_time_ms)."
+    )
     time_field = Prompt.ask("Primary [bold]Time Field[/bold]", default="@timestamp")
 
     # 4. Metric Field
     metric_field = Prompt.ask("Metric Field to Analyze", default="response.time")
 
     # 5. Function Type
+    console.print("\n[bold]3. Analysis Algorithm:[/bold]")
+    console.print(
+        "The algorithm dictates what mathematical outlier the ML job hunts for."
+    )
     function_idx = Prompt.ask(
-        "\nSelect Analysis Function:\n  1. High Mean (Detect Spikes)\n  2. Low Mean (Detect Drops)\n  3. Count (Detect Log Volume Anomalies)\nChoice",
+        "Select Analysis Function:\n  1. High Mean (Detect Spikes)\n  2. Low Mean (Detect Drops)\n  3. Count (Detect Log Volume Anomalies)\nChoice",
         choices=["1", "2", "3"],
         default="1",
     )

{elastro_client-1.3.30 → elastro_client-1.3.32}/elastro/cli/commands/painless_commands.py

@@ -65,21 +65,38 @@ def scaffold() -> None:
         "Select the Script Context", choices=["1", "2", "3", "4"], default="1"
     )
 
+    console.print("\n[bold]Output Configuration:[/bold]")
+    console.print(
+        "Elastro will generate a local file containing your scaffolded script."
+    )
+    console.print(
+        "This file will automatically be saved with a [cyan].painless[/cyan] extension."
+    )
     filename = rich.prompt.Prompt.ask(
-        "Output Filename (without extension)", default="script"
+        "What should the file be named? (e.g., entering 'my_script' creates 'my_script.painless')",
+        default="script",
     )
     filename = f"{filename}.painless"
 
     if os.path.exists(filename):
         overwrite = rich.prompt.Confirm.ask(
-            f"[yellow]File {filename} exists. Overwrite?[/yellow]", default=False
+            f"[yellow]File {filename} already exists in this directory. Overwrite it?[/yellow]",
+            default=False,
         )
         if not overwrite:
             console.print("[red]Aborted.[/red]")
             return
 
+    console.print("\n[bold]Robust Null Checking (Optional):[/bold]")
+    console.print(
+        "Painless scripts throw NullPointerExceptions if you access fields that don't exist in a document."
+    )
+    console.print(
+        "Elastro can automatically generate safe null-check boilerplate for your expected inputs."
+    )
     expected_inputs = rich.prompt.Prompt.ask(
-        "Expected input fields (comma-separated, e.g., 'host.name, @timestamp')"
+        "Which input fields do you plan to use? (comma-separated, e.g., 'host.name, @timestamp', or press Enter to skip)",
+        default="",
     )
     fields = [f.strip() for f in expected_inputs.split(",")] if expected_inputs else []
 

{elastro_client-1.3.30 → elastro_client-1.3.32}/elastro/cli/commands/snapshot.py

@@ -271,6 +271,10 @@ def restore_snapshot(
     if not repository or not snapshot:
         console.print(Panel("🧙 [bold blue]Restore Wizard[/]", border_style="blue"))
 
+        console.print("\n[bold]Repository Configuration:[/bold]")
+        console.print(
+            "Snapshots are immutable point-in-time backups stored in external Repositories (like AWS S3 or a shared FileSystem)."
+        )
         # 1. Select Repository
         try:
             repos_dict = manager.list_repositories()
@@ -321,7 +325,11 @@ def restore_snapshot(
             snapshot = snaps[snap_idx]["snapshot"]
 
     # 3. Restore Options
-    indices = Prompt.ask("\nIndices to restore", default="_all")
+    console.print("\n[bold]Restore Options:[/bold]")
+    console.print(
+        "You can surgically restore specific indices or the entire snapshot. Renaming indices during restore (e.g. prefixing with 'restored_') prevents accidentally overwriting live production data."
+    )
+    indices = Prompt.ask("Indices to restore", default="_all")
     rename_pattern = None
     rename_replacement = None
 

{elastro_client-1.3.30 → elastro_client-1.3.32}/elastro/cli/commands/template.py

@@ -188,9 +188,17 @@ def wizard(client: ElasticsearchClient) -> None:
 
     console.print(Panel.fit("🧙‍♂️ Index Architect Wizard", style="bold blue"))
 
+    console.print("\n[bold]Template Type:[/bold]")
+    console.print(
+        "  [bold cyan]Component Templates[/] are Lego blocks. They define reusable mappings or settings that can be attached to multiple templates."
+    )
+    console.print(
+        "  [bold cyan]Index Templates[/] are blueprints. They dictate exactly how new indices should be created based on an index pattern (e.g., 'logs-*')."
+    )
+
     # 1. Choose Type
     template_type = Prompt.ask(
-        "What do you want to build?",
+        "\nWhat do you want to build?",
         choices=["component", "index"],
         default="component",
     )
@@ -202,6 +210,10 @@ def wizard(client: ElasticsearchClient) -> None:
     aliases: Dict[str, Any] = {}
 
     # 2. Settings Wizard
+    console.print("\n[bold]Settings (Optional):[/bold]")
+    console.print(
+        "Settings configure the physical infrastructure of the backing indices, such as shard allocation and compression codecs."
+    )
     if Confirm.ask("Configure Settings? (shards, replicas, codec)"):
         shards = IntPrompt.ask("Number of shards", default=1)
         replicas = IntPrompt.ask("Number of replicas", default=1)
@@ -217,6 +229,10 @@ def wizard(client: ElasticsearchClient) -> None:
             settings["codec"] = codec
 
     # 3. Mappings Wizard
+    console.print("\n[bold]Mappings (Optional):[/bold]")
+    console.print(
+        "Mappings enforce a strict data schema, converting arbitrary JSON into strongly-typed columnar formats optimized for aggregations and search."
+    )
     if Confirm.ask("Configure Mappings?"):
         while True:
             if not Confirm.ask("Add a field?"):

{elastro_client-1.3.30 → elastro_client-1.3.32/elastro_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: elastro-client
-Version: 1.3.30
+Version: 1.3.32
 Summary: A comprehensive Python library for Elasticsearch management with both programmatic and CLI interfaces
 Author: Austin Jorgensen
 License-Expression: MIT

{elastro_client-1.3.30 → elastro_client-1.3.32}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "elastro-client"
-version = "1.3.30"
+version = "1.3.32"
 description = "A comprehensive Python library for Elasticsearch management with both programmatic and CLI interfaces"
 readme = "README.md"
 requires-python = ">=3.9,<3.14"