redfishLiteApi 1.0.0__tar.gz

redfishliteapi-1.0.0/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: redfishLiteApi
+Version: 1.0.0
+Summary: A lightweight Redfish API command-line tool
+Home-page: https://github.com/jeffery12240122/redfishLiteAPI
+Author: Jeffery Lin
+Author-email: jeffery12240122@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.25.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+
+# 🔧 redfishLiteApi
+
+A lightweight command-line tool to interact with Redfish APIs using `GET`, `POST`, and `PATCH` methods. Designed for quick testing, debugging, and field extraction.
+
+----------
+
+## 📦 Features
+
+-   ✅ Support for `GET`, `POST`, and `PATCH`
+    
+-   🔐 Basic Authentication (`-U` / `-P`)
+    
+-   📁 JSON body input via file (`--json_file`)
+    
+-   🔍 Recursive field value search with `--find` (supports multiple fields)
+    
+-   💾 Save response to file (`--save`)
+    
+-   🧾 Custom HTTP headers (`--header`)
+    
+-   ⏱️ 10-second request timeout to prevent hanging
+    
+-   🧯 Disable SSL verification warnings
+    
+-   📡 HTTP Status display
+    
+-   ⚠️ JSON parse error handling with fallback to raw text
+    
+-   🔢 `--version` support
+    
+
+----------
+
+## 🚀 Usage
+
+
+`python redfishLiteApi.py --url <API_URL> --method <get|post|patch> [OPTIONS]` 
+
+### ✅ Example: Basic GET request
+
+
+`python redfishLiteApi.py --url https://<host>/redfish/v1/Systems --method get` 
+
+### 🔐 Example: Authenticated GET with header and find field
+
+`python redfishLiteApi.py --url https://<host>/redfish/v1/Systems --method get \
+    -U admin -P password \
+    --header "If-Match:W/\"etag-value\"" \
+    --find Id Name PowerState` 
+
+### 📝 Example: PATCH with body file
+
+`python redfishLiteApi.py --url https://<host>/redfish/v1/Managers/1/EthernetInterfaces/1 \
+    --method patch -U admin -P password --json_file update.json` 
+
+### 💾 Example: Save output to file
+
+`python redfishLiteApi.py --url https://<host>/redfish/v1/Systems --method get --save output.json` 
+
+### 📌 Check version
+
+`python redfishLiteApi.py --version` 
+
+----------
+
+## 🧠 Argument Summary
+
+Argument
+
+Description
+
+`--url`
+
+Redfish API endpoint URL (required)
+
+`--method`
+
+HTTP method: `get`, `post`, or `patch` (required)
+
+`-U` / `--username`
+
+Basic auth username
+
+`-P` / `--password`
+
+Basic auth password
+
+`--json_file`
+
+Path to JSON file for POST or PATCH body
+
+`--find`
+
+One or more JSON field names to recursively extract (GET only)
+
+`--save`
+
+Save the response body to a file
+
+`--header`
+
+Custom headers in `Key:Value` format (can be repeated)
+
+`--version`
+
+Show current version and exit
+
+----------
+
+## ⚠️ Notes
+
+-   SSL certificate verification is disabled (`verify=False`).
+    
+-   Timeout is hardcoded to 10 seconds.
+    
+-   HTTP error handling is basic — be sure to inspect the response if you encounter unexpected results.
+    
+
+----------
+
+## 🛠 Dependencies
+
+-   Python 3.x
+    
+-   `requests`
+    
+
+Install dependencies via:
+
+`pip install -r requirements.txt` 
+
+`requirements.txt` content:
+
+`requests` 
+
+----------
+
+## 📜 License
+
+MIT License

redfishliteapi-1.0.0/README.md

@@ -0,0 +1,141 @@
+
+# 🔧 redfishLiteApi
+
+A lightweight command-line tool to interact with Redfish APIs using `GET`, `POST`, and `PATCH` methods. Designed for quick testing, debugging, and field extraction.
+
+----------
+
+## 📦 Features
+
+-   ✅ Support for `GET`, `POST`, and `PATCH`
+    
+-   🔐 Basic Authentication (`-U` / `-P`)
+    
+-   📁 JSON body input via file (`--json_file`)
+    
+-   🔍 Recursive field value search with `--find` (supports multiple fields)
+    
+-   💾 Save response to file (`--save`)
+    
+-   🧾 Custom HTTP headers (`--header`)
+    
+-   ⏱️ 10-second request timeout to prevent hanging
+    
+-   🧯 Disable SSL verification warnings
+    
+-   📡 HTTP Status display
+    
+-   ⚠️ JSON parse error handling with fallback to raw text
+    
+-   🔢 `--version` support
+    
+
+----------
+
+## 🚀 Usage
+
+
+`python redfishLiteApi.py --url <API_URL> --method <get|post|patch> [OPTIONS]` 
+
+### ✅ Example: Basic GET request
+
+
+`python redfishLiteApi.py --url https://<host>/redfish/v1/Systems --method get` 
+
+### 🔐 Example: Authenticated GET with header and find field
+
+`python redfishLiteApi.py --url https://<host>/redfish/v1/Systems --method get \
+    -U admin -P password \
+    --header "If-Match:W/\"etag-value\"" \
+    --find Id Name PowerState` 
+
+### 📝 Example: PATCH with body file
+
+`python redfishLiteApi.py --url https://<host>/redfish/v1/Managers/1/EthernetInterfaces/1 \
+    --method patch -U admin -P password --json_file update.json` 
+
+### 💾 Example: Save output to file
+
+`python redfishLiteApi.py --url https://<host>/redfish/v1/Systems --method get --save output.json` 
+
+### 📌 Check version
+
+`python redfishLiteApi.py --version` 
+
+----------
+
+## 🧠 Argument Summary
+
+Argument
+
+Description
+
+`--url`
+
+Redfish API endpoint URL (required)
+
+`--method`
+
+HTTP method: `get`, `post`, or `patch` (required)
+
+`-U` / `--username`
+
+Basic auth username
+
+`-P` / `--password`
+
+Basic auth password
+
+`--json_file`
+
+Path to JSON file for POST or PATCH body
+
+`--find`
+
+One or more JSON field names to recursively extract (GET only)
+
+`--save`
+
+Save the response body to a file
+
+`--header`
+
+Custom headers in `Key:Value` format (can be repeated)
+
+`--version`
+
+Show current version and exit
+
+----------
+
+## ⚠️ Notes
+
+-   SSL certificate verification is disabled (`verify=False`).
+    
+-   Timeout is hardcoded to 10 seconds.
+    
+-   HTTP error handling is basic — be sure to inspect the response if you encounter unexpected results.
+    
+
+----------
+
+## 🛠 Dependencies
+
+-   Python 3.x
+    
+-   `requests`
+    
+
+Install dependencies via:
+
+`pip install -r requirements.txt` 
+
+`requirements.txt` content:
+
+`requests` 
+
+----------
+
+## 📜 License
+
+MIT License

redfishliteapi-1.0.0/redfishLiteApi.egg-info/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: redfishLiteApi
+Version: 1.0.0
+Summary: A lightweight Redfish API command-line tool
+Home-page: https://github.com/jeffery12240122/redfishLiteAPI
+Author: Jeffery Lin
+Author-email: jeffery12240122@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.25.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+
+# 🔧 redfishLiteApi
+
+A lightweight command-line tool to interact with Redfish APIs using `GET`, `POST`, and `PATCH` methods. Designed for quick testing, debugging, and field extraction.
+
+----------
+
+## 📦 Features
+
+-   ✅ Support for `GET`, `POST`, and `PATCH`
+    
+-   🔐 Basic Authentication (`-U` / `-P`)
+    
+-   📁 JSON body input via file (`--json_file`)
+    
+-   🔍 Recursive field value search with `--find` (supports multiple fields)
+    
+-   💾 Save response to file (`--save`)
+    
+-   🧾 Custom HTTP headers (`--header`)
+    
+-   ⏱️ 10-second request timeout to prevent hanging
+    
+-   🧯 Disable SSL verification warnings
+    
+-   📡 HTTP Status display
+    
+-   ⚠️ JSON parse error handling with fallback to raw text
+    
+-   🔢 `--version` support
+    
+
+----------
+
+## 🚀 Usage
+
+
+`python redfishLiteApi.py --url <API_URL> --method <get|post|patch> [OPTIONS]` 
+
+### ✅ Example: Basic GET request
+
+
+`python redfishLiteApi.py --url https://<host>/redfish/v1/Systems --method get` 
+
+### 🔐 Example: Authenticated GET with header and find field
+
+`python redfishLiteApi.py --url https://<host>/redfish/v1/Systems --method get \
+    -U admin -P password \
+    --header "If-Match:W/\"etag-value\"" \
+    --find Id Name PowerState` 
+
+### 📝 Example: PATCH with body file
+
+`python redfishLiteApi.py --url https://<host>/redfish/v1/Managers/1/EthernetInterfaces/1 \
+    --method patch -U admin -P password --json_file update.json` 
+
+### 💾 Example: Save output to file
+
+`python redfishLiteApi.py --url https://<host>/redfish/v1/Systems --method get --save output.json` 
+
+### 📌 Check version
+
+`python redfishLiteApi.py --version` 
+
+----------
+
+## 🧠 Argument Summary
+
+Argument
+
+Description
+
+`--url`
+
+Redfish API endpoint URL (required)
+
+`--method`
+
+HTTP method: `get`, `post`, or `patch` (required)
+
+`-U` / `--username`
+
+Basic auth username
+
+`-P` / `--password`
+
+Basic auth password
+
+`--json_file`
+
+Path to JSON file for POST or PATCH body
+
+`--find`
+
+One or more JSON field names to recursively extract (GET only)
+
+`--save`
+
+Save the response body to a file
+
+`--header`
+
+Custom headers in `Key:Value` format (can be repeated)
+
+`--version`
+
+Show current version and exit
+
+----------
+
+## ⚠️ Notes
+
+-   SSL certificate verification is disabled (`verify=False`).
+    
+-   Timeout is hardcoded to 10 seconds.
+    
+-   HTTP error handling is basic — be sure to inspect the response if you encounter unexpected results.
+    
+
+----------
+
+## 🛠 Dependencies
+
+-   Python 3.x
+    
+-   `requests`
+    
+
+Install dependencies via:
+
+`pip install -r requirements.txt` 
+
+`requirements.txt` content:
+
+`requests` 
+
+----------
+
+## 📜 License
+
+MIT License

redfishliteapi-1.0.0/redfishLiteApi.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+README.md
+redfishLiteApi.py
+setup.py
+redfishLiteApi.egg-info/PKG-INFO
+redfishLiteApi.egg-info/SOURCES.txt
+redfishLiteApi.egg-info/dependency_links.txt
+redfishLiteApi.egg-info/entry_points.txt
+redfishLiteApi.egg-info/requires.txt
+redfishLiteApi.egg-info/top_level.txt

redfishliteapi-1.0.0/redfishLiteApi.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

redfishliteapi-1.0.0/redfishLiteApi.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+redfishLiteApi = redfishLiteApi:main

redfishliteapi-1.0.0/redfishLiteApi.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.25.1

redfishliteapi-1.0.0/redfishLiteApi.egg-info/top_level.txt

@@ -0,0 +1 @@
+redfishLiteApi

redfishliteapi-1.0.0/redfishLiteApi.py

@@ -0,0 +1,114 @@
+import argparse
+import json
+import requests
+from requests.auth import HTTPBasicAuth
+import sys
+import urllib3
+
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+
+VERSION = "1.0.0"
+
+def parse_args():
+    parser = argparse.ArgumentParser(description='Redfish Lite API Tool')
+    parser.add_argument('--url', required=True, help='Target Redfish API endpoint')
+    parser.add_argument('--method', required=True, choices=['get', 'post', 'patch'], help='HTTP method')
+    parser.add_argument('-U', '--username', help='Username for authentication')
+    parser.add_argument('-P', '--password', help='Password for authentication')
+    parser.add_argument('--json_file', help='Path to JSON file for request body (only for POST or PATCH)')
+    parser.add_argument('--find', nargs='+', help='Find and display value(s) of specific field(s) in JSON response (only for GET)')
+    parser.add_argument('--save', help='Save response output to specified file')
+    parser.add_argument('--header', action='append', help='Custom header(s), format: Key:Value')
+    parser.add_argument('--version', action='store_true', help='Show tool version and exit')
+    return parser.parse_args()
+
+def load_json(file_path):
+    try:
+        with open(file_path, 'r') as f:
+            return json.load(f)
+    except Exception as e:
+        print(f"❌ Error loading JSON file: {e}")
+        sys.exit(1)
+
+def extract_fields(obj, field_names):
+    results = []
+    def recursive_search(o):
+        if isinstance(o, dict):
+            for k, v in o.items():
+                if k in field_names:
+                    results.append(f"{k}: {v}")
+                recursive_search(v)
+        elif isinstance(o, list):
+            for item in o:
+                recursive_search(item)
+    recursive_search(obj)
+    return results
+
+def handle_save_response(resp, save_path):
+    if save_path:
+        try:
+            content = resp.json()
+            with open(save_path, 'w', encoding='utf-8') as f:
+                json.dump(content, f, indent=4, ensure_ascii=False)
+        except ValueError:
+            with open(save_path, 'w', encoding='utf-8') as f:
+                f.write(resp.text)
+        print(f"💾 Response saved to {save_path}")
+
+def main():
+    args = parse_args()
+
+    if args.version:
+        print(f"redfishLiteApi version: {VERSION}")
+        return
+
+    headers = {
+        'Accept': 'application/json',
+        'Content-Type': 'application/json'
+    }
+    if args.header:
+        for header in args.header:
+            try:
+                key, value = header.split(':', 1)
+                headers[key.strip()] = value.strip()
+            except ValueError:
+                print(f"❌ Invalid header format: {header}. Use Key:Value")
+                sys.exit(1)
+
+    payload = load_json(args.json_file) if args.json_file else None
+    auth = HTTPBasicAuth(args.username, args.password) if args.username and args.password else None
+
+    try:
+        timeout = 10  # seconds
+
+        if args.method == 'get':
+            resp = requests.get(args.url, auth=auth, headers=headers, verify=False, timeout=timeout)
+        elif args.method == 'post':
+            resp = requests.post(args.url, auth=auth, headers=headers, json=payload, verify=False, timeout=timeout)
+        elif args.method == 'patch':
+            resp = requests.patch(args.url, auth=auth, headers=headers, json=payload, verify=False, timeout=timeout)
+
+        print(f"🔁 HTTP Status: {resp.status_code}")
+        try:
+            data = resp.json()
+            if args.method == 'get' and args.find:
+                matches = extract_fields(data, args.find)
+                if matches:
+                    for i, match in enumerate(matches, 1):
+                        print(f"[{i}] {match}")
+                else:
+                    print("⚠️  No matching fields found.")
+            else:
+                print(json.dumps(data, indent=4))
+            handle_save_response(resp, args.save)
+        except ValueError:
+            print("⚠️  Response is not JSON:")
+            print(resp.text)
+            handle_save_response(resp, args.save)
+
+    except requests.exceptions.RequestException as e:
+        print(f"❌ Request failed: {e}")
+        sys.exit(1)
+
+if __name__ == '__main__':
+    main()

redfishliteapi-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

redfishliteapi-1.0.0/setup.py

@@ -0,0 +1,31 @@
+from setuptools import setup, find_packages
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name="redfishLiteApi",
+    version="1.0.0",
+    author="Jeffery Lin",
+    author_email="jeffery12240122@gmail.com",
+    description="A lightweight Redfish API command-line tool",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/jeffery12240122/redfishLiteAPI",
+    py_modules=["redfishLiteApi"],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "Operating System :: OS Independent",
+        "Environment :: Console",
+        "License :: OSI Approved :: MIT License"
+    ],
+    python_requires='>=3.6',
+    install_requires=[
+        "requests>=2.25.1"
+    ],
+    entry_points={
+        'console_scripts': [
+            'redfishLiteApi=redfishLiteApi:main',
+        ],
+    },
+)