elastro-client 1.0.0__tar.gz

elastro_client-1.0.0/.coveragerc

@@ -0,0 +1,18 @@
+[run]
+source = elastro
+omit = 
+    elastro/cli/*
+    tests/*
+    setup.py
+
+[report]
+exclude_lines =
+    pragma: no cover
+    def __repr__
+    raise NotImplementedError
+    if __name__ == .__main__.:
+    pass
+    raise ImportError
+
+[html]
+directory = htmlcov 

elastro_client-1.0.0/LICENSE

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

elastro_client-1.0.0/MANIFEST.in

@@ -0,0 +1,14 @@
+include LICENSE
+include README.md
+include requirements.txt
+include pyproject.toml
+include elastro/py.typed
+recursive-include docs *.md
+recursive-include examples *.py
+recursive-include tests *.py
+include pytest.ini
+include .coveragerc
+global-exclude *.pyc
+global-exclude __pycache__
+global-exclude *.so
+global-exclude .DS_Store 

elastro_client-1.0.0/PKG-INFO

@@ -0,0 +1,271 @@
+Metadata-Version: 2.4
+Name: elastro-client
+Version: 1.0.0
+Summary: A comprehensive Python library for Elasticsearch management with both programmatic and CLI interfaces
+Author: Austin Jorgensen
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Fremen-Labs
+Project-URL: Repository, https://github.com/Fremen-Labs/elastro
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Database
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: elasticsearch<9.0.0,>=8.18.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: python-dotenv>=0.19.0
+Requires-Dist: pydantic==2.11.3
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: colorlog>=6.0.0
+Requires-Dist: rich>=10.0.0
+Requires-Dist: rich-click>=1.7.0
+Provides-Extra: test
+Requires-Dist: pytest>=7.0.0; extra == "test"
+Requires-Dist: pytest-cov>=3.0.0; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: isort>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=0.9.0; extra == "dev"
+Requires-Dist: flake8>=4.0.0; extra == "dev"
+Dynamic: license-file
+
+# Elastro
+
+```text
+      .   *   .       .   *   .      .
+    .   _   .   *   .    *    .   *
+  _ __| | __ _ ___| |_ _ __ ___    .
+  / _ \ |/ _` / __| __| '__/ _ \  *
+ |  __/ | (_| \__ \ |_| | | (_) |  .
+  \___|_|\__,_|___/\__|_|  \___/ .
+      .    *     .      *    .   *
+```
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+
+A comprehensive Python module for managing Elasticsearch operations within pipeline processes.
+
+## Overview
+
+Elastro is a Python library designed to simplify interactions with Elasticsearch. It provides a clean, intuitive API for common Elasticsearch operations including:
+
+- Index management (create, update, delete)
+- Document operations (indexing, searching, updating)
+- Datastream management
+- Advanced query building and search functionality
+
+The library offers both a programmatic API and a command-line interface for seamless integration with various workflows.
+
+## Installation
+
+```bash
+pip install elastro
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/Fremen-Labs/elastro.git
+cd elastro
+pip install -e .
+```
+
+## Basic Usage
+
+### Client Connection
+
+```python
+from elastro import ElasticsearchClient
+
+# Connect using API key
+client = ElasticsearchClient(
+    hosts=["https://elasticsearch:9200"],
+    auth={"api_key": "your-api-key"}
+)
+
+# Or using basic auth
+client = ElasticsearchClient(
+    hosts=["https://elasticsearch:9200"],
+    auth={"username": "elastic", "password": "password"}
+)
+
+# Connect to Elasticsearch
+client.connect()
+```
+
+### Index Management
+
+```python
+from elastro import IndexManager
+
+index_manager = IndexManager(client)
+
+# Create an index
+index_manager.create(
+    name="products",
+    settings={
+        "number_of_shards": 3,
+        "number_of_replicas": 1
+    },
+    mappings={
+        "properties": {
+            "name": {"type": "text"},
+            "price": {"type": "float"},
+            "description": {"type": "text"},
+            "created": {"type": "date"}
+        }
+    }
+)
+
+# Check if an index exists
+if index_manager.exists("products"):
+    print("Products index exists!")
+    
+# Delete an index
+index_manager.delete("products")
+```
+
+### Document Operations
+
+```python
+from elastro import DocumentManager
+
+doc_manager = DocumentManager(client)
+
+# Index a document
+doc_manager.index(
+    index="products",
+    id="1",
+    document={
+        "name": "Laptop",
+        "price": 999.99,
+        "description": "High-performance laptop",
+        "created": "2023-05-01T12:00:00"
+    }
+)
+
+# Search for documents
+results = doc_manager.search(
+    index="products",
+    query={"match": {"name": "laptop"}}
+)
+
+print(results)
+```
+
+### CLI Usage
+
+```bash
+# Initialize configuration
+elastro config init
+
+# Create an index
+elastro index create products --shards 3 --replicas 1
+
+# Interactive Template Wizard
+elastro template wizard
+
+# Interactive ILM Policy Wizard
+elastro ilm create my-policy
+
+# List ILM Policies (Table View)
+elastro ilm list
+
+# Add a document
+elastro doc index products --id 1 --file ./product.json
+
+# Search documents
+elastro doc search products --term category=laptop
+```
+
+### ILM (Index Lifecycle Management)
+
+Elastro provides a powerful CLI for managing ILM policies, including an interactive wizard.
+
+```bash
+# List all policies (Table View)
+elastro ilm list
+
+# List with full JSON details (limited to first 2)
+elastro ilm list --full
+
+# Create a policy using the Interactive Wizard (Recommended)
+elastro ilm create my-policy
+# Follow the prompts to configure Hot, Warm, Cold, and Delete phases.
+
+# Create a policy from a file
+elastro ilm create my-policy --file ./policy.json
+
+# Explain lifecycle status for an index (includes step info for debugging)
+elastro ilm explain my-index
+```
+
+### Snapshot & Restore
+
+Manage backup repositories and snapshots with ease.
+
+**Repositories:**
+```bash
+# List all repositories
+elastro snapshot repo list
+
+# Create a filesystem repository
+elastro snapshot repo create my_backup fs --setting location=/tmp/backups
+
+# Create an S3 repository
+elastro snapshot repo create my_s3_backup s3 --setting bucket=my-bucket --setting region=us-east-1
+```
+
+**Snapshots:**
+```bash
+# List snapshots in a repository
+elastro snapshot list my_backup
+
+# Create a snapshot (async default)
+elastro snapshot create my_backup snapshot_1
+
+# Create and wait for completion
+elastro snapshot create my_backup snapshot_2 --wait --indices "logs-*,metrics-*"
+
+# Restore a snapshot (Interactive Wizard)
+elastro snapshot restore
+# Launches a wizard to select repo -> snapshot -> indices -> rename pattern
+
+# Restore specific indices from CLI
+elastro snapshot restore my_backup snapshot_1 --indices "logs-*"
+```
+
+- [Getting Started](https://github.com/Fremen-Labs/elastro/blob/main/docs/getting_started.md)
+- [API Reference](https://github.com/Fremen-Labs/elastro/blob/main/docs/api_reference.md)
+- [CLI Usage](https://github.com/Fremen-Labs/elastro/blob/main/docs/cli_usage.md)
+- [Advanced Features](https://github.com/Fremen-Labs/elastro/blob/main/docs/advanced_features.md)
+- [Troubleshooting](https://github.com/Fremen-Labs/elastro/blob/main/docs/troubleshooting.md)
+
+## Examples
+
+Check out the [examples](https://github.com/Fremen-Labs/elastro/tree/main/examples) directory for more usage examples:
+
+- [Client Connection](https://github.com/Fremen-Labs/elastro/blob/main/examples/client.py)
+- [Index Management](https://github.com/Fremen-Labs/elastro/blob/main/examples/index_management.py)
+- [Document Operations](https://github.com/Fremen-Labs/elastro/blob/main/examples/document_operations.py)
+- [Search Operations](https://github.com/Fremen-Labs/elastro/blob/main/examples/search.py)
+- [Datastream Management](https://github.com/Fremen-Labs/elastro/blob/main/examples/datastreams.py)
+
+## Contributing
+
+We welcome contributions to Elastro! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to get started, code standards, and submission processes.
+
+
+## License
+
+MIT 

elastro_client-1.0.0/README.md

@@ -0,0 +1,233 @@
+# Elastro
+
+```text
+      .   *   .       .   *   .      .
+    .   _   .   *   .    *    .   *
+  _ __| | __ _ ___| |_ _ __ ___    .
+  / _ \ |/ _` / __| __| '__/ _ \  *
+ |  __/ | (_| \__ \ |_| | | (_) |  .
+  \___|_|\__,_|___/\__|_|  \___/ .
+      .    *     .      *    .   *
+```
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+
+A comprehensive Python module for managing Elasticsearch operations within pipeline processes.
+
+## Overview
+
+Elastro is a Python library designed to simplify interactions with Elasticsearch. It provides a clean, intuitive API for common Elasticsearch operations including:
+
+- Index management (create, update, delete)
+- Document operations (indexing, searching, updating)
+- Datastream management
+- Advanced query building and search functionality
+
+The library offers both a programmatic API and a command-line interface for seamless integration with various workflows.
+
+## Installation
+
+```bash
+pip install elastro
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/Fremen-Labs/elastro.git
+cd elastro
+pip install -e .
+```
+
+## Basic Usage
+
+### Client Connection
+
+```python
+from elastro import ElasticsearchClient
+
+# Connect using API key
+client = ElasticsearchClient(
+    hosts=["https://elasticsearch:9200"],
+    auth={"api_key": "your-api-key"}
+)
+
+# Or using basic auth
+client = ElasticsearchClient(
+    hosts=["https://elasticsearch:9200"],
+    auth={"username": "elastic", "password": "password"}
+)
+
+# Connect to Elasticsearch
+client.connect()
+```
+
+### Index Management
+
+```python
+from elastro import IndexManager
+
+index_manager = IndexManager(client)
+
+# Create an index
+index_manager.create(
+    name="products",
+    settings={
+        "number_of_shards": 3,
+        "number_of_replicas": 1
+    },
+    mappings={
+        "properties": {
+            "name": {"type": "text"},
+            "price": {"type": "float"},
+            "description": {"type": "text"},
+            "created": {"type": "date"}
+        }
+    }
+)
+
+# Check if an index exists
+if index_manager.exists("products"):
+    print("Products index exists!")
+    
+# Delete an index
+index_manager.delete("products")
+```
+
+### Document Operations
+
+```python
+from elastro import DocumentManager
+
+doc_manager = DocumentManager(client)
+
+# Index a document
+doc_manager.index(
+    index="products",
+    id="1",
+    document={
+        "name": "Laptop",
+        "price": 999.99,
+        "description": "High-performance laptop",
+        "created": "2023-05-01T12:00:00"
+    }
+)
+
+# Search for documents
+results = doc_manager.search(
+    index="products",
+    query={"match": {"name": "laptop"}}
+)
+
+print(results)
+```
+
+### CLI Usage
+
+```bash
+# Initialize configuration
+elastro config init
+
+# Create an index
+elastro index create products --shards 3 --replicas 1
+
+# Interactive Template Wizard
+elastro template wizard
+
+# Interactive ILM Policy Wizard
+elastro ilm create my-policy
+
+# List ILM Policies (Table View)
+elastro ilm list
+
+# Add a document
+elastro doc index products --id 1 --file ./product.json
+
+# Search documents
+elastro doc search products --term category=laptop
+```
+
+### ILM (Index Lifecycle Management)
+
+Elastro provides a powerful CLI for managing ILM policies, including an interactive wizard.
+
+```bash
+# List all policies (Table View)
+elastro ilm list
+
+# List with full JSON details (limited to first 2)
+elastro ilm list --full
+
+# Create a policy using the Interactive Wizard (Recommended)
+elastro ilm create my-policy
+# Follow the prompts to configure Hot, Warm, Cold, and Delete phases.
+
+# Create a policy from a file
+elastro ilm create my-policy --file ./policy.json
+
+# Explain lifecycle status for an index (includes step info for debugging)
+elastro ilm explain my-index
+```
+
+### Snapshot & Restore
+
+Manage backup repositories and snapshots with ease.
+
+**Repositories:**
+```bash
+# List all repositories
+elastro snapshot repo list
+
+# Create a filesystem repository
+elastro snapshot repo create my_backup fs --setting location=/tmp/backups
+
+# Create an S3 repository
+elastro snapshot repo create my_s3_backup s3 --setting bucket=my-bucket --setting region=us-east-1
+```
+
+**Snapshots:**
+```bash
+# List snapshots in a repository
+elastro snapshot list my_backup
+
+# Create a snapshot (async default)
+elastro snapshot create my_backup snapshot_1
+
+# Create and wait for completion
+elastro snapshot create my_backup snapshot_2 --wait --indices "logs-*,metrics-*"
+
+# Restore a snapshot (Interactive Wizard)
+elastro snapshot restore
+# Launches a wizard to select repo -> snapshot -> indices -> rename pattern
+
+# Restore specific indices from CLI
+elastro snapshot restore my_backup snapshot_1 --indices "logs-*"
+```
+
+- [Getting Started](https://github.com/Fremen-Labs/elastro/blob/main/docs/getting_started.md)
+- [API Reference](https://github.com/Fremen-Labs/elastro/blob/main/docs/api_reference.md)
+- [CLI Usage](https://github.com/Fremen-Labs/elastro/blob/main/docs/cli_usage.md)
+- [Advanced Features](https://github.com/Fremen-Labs/elastro/blob/main/docs/advanced_features.md)
+- [Troubleshooting](https://github.com/Fremen-Labs/elastro/blob/main/docs/troubleshooting.md)
+
+## Examples
+
+Check out the [examples](https://github.com/Fremen-Labs/elastro/tree/main/examples) directory for more usage examples:
+
+- [Client Connection](https://github.com/Fremen-Labs/elastro/blob/main/examples/client.py)
+- [Index Management](https://github.com/Fremen-Labs/elastro/blob/main/examples/index_management.py)
+- [Document Operations](https://github.com/Fremen-Labs/elastro/blob/main/examples/document_operations.py)
+- [Search Operations](https://github.com/Fremen-Labs/elastro/blob/main/examples/search.py)
+- [Datastream Management](https://github.com/Fremen-Labs/elastro/blob/main/examples/datastreams.py)
+
+## Contributing
+
+We welcome contributions to Elastro! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to get started, code standards, and submission processes.
+
+
+## License
+
+MIT