redfish-python-sdk 1.0.0__py3-none-any.whl

redfish_python_sdk-1.0.0.dist-info/METADATA

@@ -0,0 +1,164 @@
+Metadata-Version: 2.4
+Name: redfish-python-sdk
+Version: 1.0.0
+Summary: A Python SDK for interacting with Redfish-compliant BMC endpoints
+Author: RedNote Infrastructure
+License: BSD 3-Clause License
+        
+        Copyright (c) 2025-present, Xingyin Information Technology Co., Ltd.
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Homepage, https://github.com/rednote-infra/redfish-python-sdk
+Project-URL: Repository, https://github.com/rednote-infra/redfish-python-sdk
+Project-URL: Issues, https://github.com/rednote-infra/redfish-python-sdk/issues
+Project-URL: Changelog, https://github.com/rednote-infra/redfish-python-sdk/blob/main/CHANGELOG.md
+Keywords: redfish,bmc,ipmi,server,oob
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Hardware
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Systems Administration
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31.0
+Requires-Dist: pydantic>=2.5.0
+Requires-Dist: urllib3>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: ruff>=0.4.0; extra == "dev"
+Dynamic: license-file
+
+# Redfish Python SDK
+
+[English](README.md) | [中文](README_zh.md)
+
+> A lightweight Python SDK for managing server BMCs (Baseboard Management Controllers) via the [DMTF Redfish](https://www.dmtf.org/standards/redfish) protocol. Covers system inventory, hardware inspection, power control, boot management, event subscriptions, and more.
+
+## Features
+
+- **Comprehensive hardware queries** — CPU, memory, drives, GPU, NIC, PCIe, PSU, fans — one line of code each
+- **Power & boot management** — power on/off, restart, PXE/HDD/BIOS boot source switching
+- **Multi-vendor compatible** — auto-adapts to OEM extensions from Huawei, xFusion, Lenovo, HPE, Dell, and others
+- **Pydantic v2 models** — all return values are strongly-typed objects with full IDE autocompletion
+- **Context manager** — `with` statement support for automatic connection cleanup
+- **Minimal dependencies** — only `requests`, `pydantic`, and `urllib3`
+
+## Requirements
+
+- Python >= 3.9
+- A network-reachable Redfish-compliant BMC endpoint
+
+## Installation
+
+```bash
+# Install from PyPI
+pip install redfish-python-sdk
+
+# Or install from GitHub
+pip install git+https://github.com/rednote-infra/redfish-python-sdk.git
+
+# Install a specific version
+pip install redfish-python-sdk==1.0.0
+pip install git+https://github.com/rednote-infra/redfish-python-sdk.git@v1.0.0
+
+# In requirements.txt
+# redfish-python-sdk>=1.0.0
+```
+
+## Quick Start
+
+> **Credential management**: All BMC credentials should be injected via environment variables. **Never** hardcode them in your source code.
+> Before running examples or tests, set `export BMC_IP=...`, `export BMC_USER=...`, `export BMC_PASSWORD=...`.
+
+```python
+import os
+from redfish_sdk import RedfishClient
+
+# Connect to BMC (credentials from environment variables)
+client = RedfishClient(
+    host=os.environ["BMC_IP"],
+    username=os.environ["BMC_USER"],
+    password=os.environ["BMC_PASSWORD"],
+)
+
+# Get system info
+system = client.systems.get()
+print(f"Server: {system.manufacturer} {system.model}")
+print(f"SN:     {system.serial_number}")
+print(f"Power:  {system.power_state}")
+
+# Get CPU info
+for cpu in client.get_processors():
+    print(f"CPU: {cpu.model}, {cpu.total_cores} cores / {cpu.total_threads} threads")
+
+# Get memory info
+for mem in client.get_memory():
+    print(f"DIMM: {mem.manufacturer} {(mem.capacity_mib or 0) // 1024} GB")
+
+# Get drive info
+for drive in client.get_drives():
+    print(f"Drive: {drive.model} {(drive.capacity_bytes or 0) / 1e12:.1f} TB")
+
+# Don't forget to close
+client.close()
+```
+
+## Testing
+
+```bash
+# Run unit tests (no BMC or env vars required)
+pytest tests/test_models_mock.py tests/test_client_mock.py -v
+
+# Run offline tests (using pre-collected JSON data)
+export REDFISH_JSON_DIR="./testdata"
+pytest tests/test_offline_json.py -v
+
+# Run integration tests (requires a real BMC)
+export BMC_IP="<your-bmc-ip>"
+export BMC_USER="<your-bmc-user>"
+export BMC_PASSWORD="<your-bmc-password>"
+pytest tests/test_real_bmc.py -v
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the [BSD 3-Clause License](LICENSE).

redfish_python_sdk-1.0.0.dist-info/RECORD

@@ -0,0 +1,56 @@
+redfish_python_sdk-1.0.0.dist-info/licenses/LICENSE,sha256=c-oS85b6_bshaoIKznGzDhL7xHsBmGmrGIQW9uzdNow,1556
+redfish_sdk/__init__.py,sha256=QArSavbes18UneMc6kPr6sRTB-1nd47UeAlH5ZYeMlc,1600
+redfish_sdk/client.py,sha256=ngT7omv9xN_XMB-fUKcXG471psg7pduFSXwL7tLhFII,65890
+redfish_sdk/exceptions.py,sha256=DstyiXCMiDJIDXZbZX-RRGVcMurC2ALzyuwP8MW79xM,1712
+redfish_sdk/http_client.py,sha256=DDfS1x8pFyhpvEc7dcigrxqfzma7pWkyG_fpeDAcppw,15754
+redfish_sdk/managers/__init__.py,sha256=T4p9mhvN7boaeTY2OF_i3aVkLAk5z5kMP8J2ldk6VYY,601
+redfish_sdk/managers/_log_helpers.py,sha256=iZezsU5lRoH2NSG7onBOWfjTbhjid9eHrSIKMMi4b-k,5592
+redfish_sdk/managers/account.py,sha256=0P1OiRfgMJ67njBpdBCCA8OC-Bj_RiUVihCFc2cMa0k,2423
+redfish_sdk/managers/chassis.py,sha256=g6ILMsApw-XdqkQQnRJvcymu8AQEooFV-PhvvZMVv_s,11145
+redfish_sdk/managers/event.py,sha256=v_dHN3AcwlxKVaxQLR8pSAydnJIzuaU6x0NuY6nfteg,10765
+redfish_sdk/managers/managers.py,sha256=asQYQzKoAtCdr0PBZhYt4danXxlLGrTbQX5IWYxpl2Y,3330
+redfish_sdk/managers/registries.py,sha256=DP_0s3deTJMELklOM_SVbOuzZfGtpuC_igOOdFwdD48,1074
+redfish_sdk/managers/session.py,sha256=6D6UAn2fl_u3ETqe-6Y6NxWxHPyqmlcM5RBHMo6cLW8,3691
+redfish_sdk/managers/systems.py,sha256=6Q1lbptyT5Y-TQ-m2ktzNjyMzvltZu3cRxFtrdVg80E,22475
+redfish_sdk/managers/task.py,sha256=jLPIOZ8BzAov1JIROrFob88ZYgI6CJr_u0-UFWsG7gc,2212
+redfish_sdk/managers/update.py,sha256=eIcLc0ySjT_Z2NLAo95nlouoJVWodtpt3OGx0H1SwXw,3420
+redfish_sdk/managers/update_strategies/__init__.py,sha256=9IiK0OunND6kDJkE2hQ03xczPft8iX12zGd-wgLVwkM,1994
+redfish_sdk/managers/update_strategies/base.py,sha256=JDubTxr4ZdeDGX9wCZvd2V-1MrCJOcudhui_WzRuUA4,3144
+redfish_sdk/managers/update_strategies/h3c.py,sha256=_h9v8hJ-iuMoyZmsLflPiLe1P_oCEQUXBxLnpeC6jps,4698
+redfish_sdk/managers/update_strategies/inspur.py,sha256=Q6dSyb50ff4yHFfJtxtFoolKV5PX0nmD1tjbTSyYvOc,3220
+redfish_sdk/managers/update_strategies/lenovo.py,sha256=7fbkn_s-UckFWpTtnU_CVnb01TvYplt6-_LDQ3xnRAs,1694
+redfish_sdk/managers/update_strategies/nettrix.py,sha256=LG0KIj8PEfDMPhkFZ0mw7VkHSMAloD9lWHY3OBtHmwg,1562
+redfish_sdk/managers/update_strategies/registry.py,sha256=q7GShrZpIwCqAfro559uErQGGALDW7Cp6ep7EAZwGWc,2162
+redfish_sdk/managers/update_strategies/vendor_detect.py,sha256=7j6c9AaBCcH0boqGJcOglLANbRMmpXThkczoSaxTRVk,3661
+redfish_sdk/managers/update_strategies/xfusion.py,sha256=ySVA7Zmf69N0Rse1wjO9jc3HsNMtlLxDC6NQSsZ9Iw8,1873
+redfish_sdk/managers/update_strategies/zte.py,sha256=E_GHv0_5Y9JOMU8VyqXjdkCZi5Ga8WrM1gDrzjIbDEU,2092
+redfish_sdk/models/__init__.py,sha256=-8wGiEGvxSPHsowUxqZCF5ehuboqAmIPtERzQKkuxgM,2575
+redfish_sdk/models/account.py,sha256=GW7O1_fM4h-O6i54sySklZodQK6d5GvcKEAtq5AgO9Q,2410
+redfish_sdk/models/chassis.py,sha256=BmSH0Ce8-BQKp78ZOE8RJhidtMeeTMollYfo4rDRuek,3320
+redfish_sdk/models/check.py,sha256=MiIDLQbwDrTNNSdmWCgq3qHbOKUy2IwB7BqEKS4q-RY,8610
+redfish_sdk/models/common.py,sha256=4klrDi8AqFleLpCoORIhMqxYp5oGjFa6JvyuGXCTRrs,3442
+redfish_sdk/models/drive.py,sha256=tCfGE5AoSo9m7RpBaJ67FFksvnYe-oZBrMFaHgCKNnE,2482
+redfish_sdk/models/event.py,sha256=r1XK0st4qTdgQR2Tspg9hVvUelTOBsUlX8VGKNSclfQ,2893
+redfish_sdk/models/fru.py,sha256=14FUO370IUeGQWK1-_sl07t9wr5jTUdgoPjo5TlnqH4,2087
+redfish_sdk/models/gpu.py,sha256=lms5IhjMVp53FR6XPNFb5DMUvyBkNNDS7vrpyJBNawA,1029
+redfish_sdk/models/logs.py,sha256=rjqZ_TvSl-wTqqgdSLOdmP3qL8_YLQj-AXvVV6Si9ow,2327
+redfish_sdk/models/managers.py,sha256=q52_f4I6tgvl31hV11T-ZJ_ox2NxzOrIHetF_jWlVJc,7112
+redfish_sdk/models/memory.py,sha256=etR_8E7GR8qKMdy5uToZyoXWkM227belCNX5As57ETo,2264
+redfish_sdk/models/network_adapter.py,sha256=QQncK23c7R176jAjnrrnDnZEUllvAwXRrmPwFUZ1B9c,3047
+redfish_sdk/models/oem.py,sha256=4HSSj29XmCbo_oue4RAFIZS0031pWNNF_I-sllnBKoI,7314
+redfish_sdk/models/pcie_device.py,sha256=d28UK1QFKpR-5rdPZF5Oxx_gjm_4P4mYTrjs8sO6MqI,4221
+redfish_sdk/models/power.py,sha256=-IYTb9zkpx9MFZoG_ILzq2mMniHpSD5o8Y1m17MAG10,4380
+redfish_sdk/models/processor.py,sha256=2K-Xpb0W5T9MDklI0LjztvKeRaqMx47mCcQ6kTE0sB4,2333
+redfish_sdk/models/registry.py,sha256=P8N680qfhPYqUNU07AE651y25TAq4tgTX0VA1qGYz5I,1137
+redfish_sdk/models/resource_key.py,sha256=_BW1ddJkPzk4xAIW_0ffESw88ocJ_Afa5-hYfIIhbrg,2196
+redfish_sdk/models/root.py,sha256=KYKHA3iAP1MD56wJOk_dT1-z0tiaa5yDI1qGESn7VHs,1919
+redfish_sdk/models/session.py,sha256=jDOzrlbPFowEibcSHLpzTzmSvh-gww3OT5E2jACNluU,1402
+redfish_sdk/models/storage.py,sha256=20PXb_9cGkOXZtMxujJ70iq0hvovbhxrjh5Afcvm2LM,2982
+redfish_sdk/models/systems.py,sha256=qsvY2j9SreEpBKxULieCHIJ8on4-L-BWtwH6rkK8uwY,8372
+redfish_sdk/models/task.py,sha256=OcFEg2QCa76BVx2-8pJ56qi86snp3X5GcLbXMUCReRU,1911
+redfish_sdk/models/thermal.py,sha256=bYE2QPYnV8PJ5TZYkenL_vHUPSigO_-5gqSdSCXqgPk,5246
+redfish_sdk/models/update.py,sha256=pvhqD1YaKdSr6skKk6TZL8Ooyw-Xc8K5NfM5K_phHTQ,2249
+redfish_python_sdk-1.0.0.dist-info/METADATA,sha256=VkbwlbUPFwDj1kHQMDQUIM0yc0rrqZ4zkfRZBhAGv1w,6463
+redfish_python_sdk-1.0.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+redfish_python_sdk-1.0.0.dist-info/top_level.txt,sha256=FrQ9nZEfApAL5bgzTmKBMWKBxFjr3-R7Zcvga0D_RdY,12
+redfish_python_sdk-1.0.0.dist-info/RECORD,,

redfish_python_sdk-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

redfish_python_sdk-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025-present, Xingyin Information Technology Co., Ltd.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

redfish_python_sdk-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+redfish_sdk

redfish_sdk/__init__.py

@@ -0,0 +1,63 @@
+"""
+Redfish Python SDK
+
+A Python SDK for interacting with Redfish-compliant BMC (Baseboard Management Controller)
+endpoints.
+
+Quick start:
+    import os
+    from redfish_sdk import RedfishClient
+
+    # Credentials are read from environment variables:
+    #   export BMC_IP="<bmc-ip>"
+    #   export BMC_USER="<bmc-user>"
+    #   export BMC_PASSWORD="<bmc-password>"
+    client = RedfishClient(
+        host=os.environ["BMC_IP"],
+        username=os.environ["BMC_USER"],
+        password=os.environ["BMC_PASSWORD"],
+    )
+
+    # Get system information
+    system = client.get_system()
+    print(f"System: {system.manufacturer} {system.model}")
+    print(f"Power: {system.power_state}")
+    print(f"SN: {system.serial_number}")
+
+    client.close()
+"""
+from .client import RedfishClient
+from .exceptions import (
+    RedfishAuthError,
+    RedfishConnectionError,
+    RedfishException,
+    RedfishNotFoundError,
+    RedfishTimeoutError,
+    RedfishValidationError,
+)
+from .models.drive import Drive
+from .models.event import EventService, Subscription
+from .models.logs import Log, LogEntry
+from .models.resource_key import RedfishResource
+from .models.systems import BootOption
+
+__version__ = "1.0.0"
+__author__ = "RedNote Infrastructure"
+
+__all__ = [
+    "RedfishClient",
+    "RedfishResource",
+    "RedfishException",
+    "RedfishNotFoundError",
+    "RedfishAuthError",
+    "RedfishConnectionError",
+    "RedfishTimeoutError",
+    "RedfishValidationError",
+    # Models commonly used at API boundary.
+    "BootOption",
+    "Drive",
+    "EventService",
+    "Log",
+    "LogEntry",
+    "Subscription",
+]