redfish-utilities

Name	redfish-utilities JSON
Version	3.3.7 JSON
	download
home_page	https://github.com/DMTF/Redfish-Tacklebox
Summary	Redfish Utilities
upload_time	2025-01-17 21:21:51
maintainer	None
docs_url	None
author	DMTF, https://www.dmtf.org/standards/feedback
requires_python	None
license	BSD 3-clause "New" or "Revised License"
keywords	redfish
VCS
bugtrack_url
requirements	redfish XlsxWriter requests
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Redfish Tacklebox

Copyright 2019-2025 DMTF.  All rights reserved.

[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/LICENSE.md)
[![PyPI](https://img.shields.io/pypi/v/redfish-utilities)](https://pypi.org/project/redfish-utilities/)
[![Pulls](https://img.shields.io/docker/pulls/dmtf/redfish-tacklebox?style=flat&logo=docker&label=Pulls)](https://hub.docker.com/r/dmtf/redfish-tacklebox)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat)](https://github.com/psf/black)
[![Linters](https://github.com/DMTF/Redfish-Tacklebox/actions/workflows/linters.yml/badge.svg)](https://github.com/DMTF/Redfish-Tacklebox/actions/workflows/linters.yml)
[![Docker](https://github.com/DMTF/Redfish-Tacklebox/actions/workflows/docker.yml/badge.svg)](https://github.com/DMTF/Redfish-Tacklebox/actions/workflows/docker.yml)
[![GitHub stars](https://img.shields.io/github/stars/DMTF/Redfish-Tacklebox.svg?style=flat-square&label=github%20stars)](https://github.com/DMTF/Redfish-Tacklebox)
[![GitHub Contributors](https://img.shields.io/github/contributors/DMTF/Redfish-Tacklebox.svg?style=flat-square)](https://github.com/DMTF/Redfish-Tacklebox/graphs/contributors)

## About

Redfish Tacklebox contains a set of Python3 utilities to perform common management operations with a Redfish service.
The utilities can be used as part of larger management applications, or be used as standalone command line tools.

## Installation

`pip install redfish_utilities`

### Building from Source

```
python setup.py sdist
pip install dist/redfish_utilities-x.x.x.tar.gz
```

### Building Docker

* Pull the container from Docker Hub:

    ```bash
    docker pull dmtf/redfish-tacklebox:latest
    ```
* Build a container from local source:

    ```bash
    docker build -t dmtf/redfish-tacklebox:latest .
    ```
* Build a container from GitHub:

    ```bash
    docker build -t dmtf/redfish-tacklebox:latest https://github.com/DMTF/Redfish-Tacklebox.git
    ```

## Requirements

External modules:
* redfish: https://pypi.python.org/pypi/redfish
* XlsxWriter: https://pypi.org/project/XlsxWriter

You may install the external modules by running:

`pip install -r requirements.txt`

## Utilities

* [Discover (rf_discover.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_discover.md)
* [Sensor List (rf_sensor_list.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_sensor_list.md)
* [System Inventory (rf_sys_inventory.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_sys_inventory.md)
* [Logs (rf_logs.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_logs.md)
* [Power/Reset (rf_power_reset.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_power_reset.md)
* [Boot Override (rf_boot_override.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_boot_override.md)
* [Virtual Media (rf_virtual_media.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_virtual_media.md)
* [BIOS Settings (rf_bios_settings.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_bios_settings.md)
* [Manager Configuration (rf_manager_config.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_manager_config.md)
* [Accounts (rf_accounts.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_accounts.md)
* [Update (rf_update.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_update.md)
* [Event Service (rf_event_service.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_event_service.md)
* [Licenses (rf_licenses.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_licenses.md)
* [Certificates (rf_certificates.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_certificates.md)
* [Diagnostic Data (rf_diagnostic_data.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_diagnostic_data.md)
* [Assembly (rf_assembly.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_assembly.md)
* [Power Equipment (rf_power_equipment.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_power_equipment.md)
* [Thermal Equipment (rf_thermal_equipment.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_thermal_equipment.md)
* [Raw Request (rf_raw_request.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_raw_request.md)
* [Test Event Listener (rf_test_event_listener.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_test_event_listener.md)

## Release Process

1. Go to the "Actions" page
2. Select the "Release and Publish" workflow
3. Click "Run workflow"
4. Fill out the form
5. Click "Run workflow"

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/DMTF/Redfish-Tacklebox",
    "name": "redfish-utilities",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "Redfish",
    "author": "DMTF, https://www.dmtf.org/standards/feedback",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/ff/d4/71331412f65f3dba76854e40313a10f8e8ba138e544a5312943a151a3427/redfish_utilities-3.3.7.tar.gz",
    "platform": null,
    "description": "# Redfish Tacklebox\n\nCopyright 2019-2025 DMTF.  All rights reserved.\n\n[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/LICENSE.md)\n[![PyPI](https://img.shields.io/pypi/v/redfish-utilities)](https://pypi.org/project/redfish-utilities/)\n[![Pulls](https://img.shields.io/docker/pulls/dmtf/redfish-tacklebox?style=flat&logo=docker&label=Pulls)](https://hub.docker.com/r/dmtf/redfish-tacklebox)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat)](https://github.com/psf/black)\n[![Linters](https://github.com/DMTF/Redfish-Tacklebox/actions/workflows/linters.yml/badge.svg)](https://github.com/DMTF/Redfish-Tacklebox/actions/workflows/linters.yml)\n[![Docker](https://github.com/DMTF/Redfish-Tacklebox/actions/workflows/docker.yml/badge.svg)](https://github.com/DMTF/Redfish-Tacklebox/actions/workflows/docker.yml)\n[![GitHub stars](https://img.shields.io/github/stars/DMTF/Redfish-Tacklebox.svg?style=flat-square&label=github%20stars)](https://github.com/DMTF/Redfish-Tacklebox)\n[![GitHub Contributors](https://img.shields.io/github/contributors/DMTF/Redfish-Tacklebox.svg?style=flat-square)](https://github.com/DMTF/Redfish-Tacklebox/graphs/contributors)\n\n## About\n\nRedfish Tacklebox contains a set of Python3 utilities to perform common management operations with a Redfish service.\nThe utilities can be used as part of larger management applications, or be used as standalone command line tools.\n\n## Installation\n\n`pip install redfish_utilities`\n\n### Building from Source\n\n```\npython setup.py sdist\npip install dist/redfish_utilities-x.x.x.tar.gz\n```\n\n### Building Docker\n\n* Pull the container from Docker Hub:\n\n    ```bash\n    docker pull dmtf/redfish-tacklebox:latest\n    ```\n* Build a container from local source:\n\n    ```bash\n    docker build -t dmtf/redfish-tacklebox:latest .\n    ```\n* Build a container from GitHub:\n\n    ```bash\n    docker build -t dmtf/redfish-tacklebox:latest https://github.com/DMTF/Redfish-Tacklebox.git\n    ```\n\n## Requirements\n\nExternal modules:\n* redfish: https://pypi.python.org/pypi/redfish\n* XlsxWriter: https://pypi.org/project/XlsxWriter\n\nYou may install the external modules by running:\n\n`pip install -r requirements.txt`\n\n## Utilities\n\n* [Discover (rf_discover.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_discover.md)\n* [Sensor List (rf_sensor_list.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_sensor_list.md)\n* [System Inventory (rf_sys_inventory.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_sys_inventory.md)\n* [Logs (rf_logs.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_logs.md)\n* [Power/Reset (rf_power_reset.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_power_reset.md)\n* [Boot Override (rf_boot_override.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_boot_override.md)\n* [Virtual Media (rf_virtual_media.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_virtual_media.md)\n* [BIOS Settings (rf_bios_settings.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_bios_settings.md)\n* [Manager Configuration (rf_manager_config.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_manager_config.md)\n* [Accounts (rf_accounts.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_accounts.md)\n* [Update (rf_update.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_update.md)\n* [Event Service (rf_event_service.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_event_service.md)\n* [Licenses (rf_licenses.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_licenses.md)\n* [Certificates (rf_certificates.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_certificates.md)\n* [Diagnostic Data (rf_diagnostic_data.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_diagnostic_data.md)\n* [Assembly (rf_assembly.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_assembly.md)\n* [Power Equipment (rf_power_equipment.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_power_equipment.md)\n* [Thermal Equipment (rf_thermal_equipment.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_thermal_equipment.md)\n* [Raw Request (rf_raw_request.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_raw_request.md)\n* [Test Event Listener (rf_test_event_listener.py)](https://github.com/DMTF/Redfish-Tacklebox/blob/main/docs/rf_test_event_listener.md)\n\n## Release Process\n\n1. Go to the \"Actions\" page\n2. Select the \"Release and Publish\" workflow\n3. Click \"Run workflow\"\n4. Fill out the form\n5. Click \"Run workflow\"\n",
    "bugtrack_url": null,
    "license": "BSD 3-clause \"New\" or \"Revised License\"",
    "summary": "Redfish Utilities",
    "version": "3.3.7",
    "project_urls": {
        "Homepage": "https://github.com/DMTF/Redfish-Tacklebox"
    },
    "split_keywords": [
        "redfish"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b1ac201dcc093e81dba8fc84228f49db8d079e1c9c0c9465d71a478930c8caa5",
                "md5": "e09e64ed42584c13b7125031c273d072",
                "sha256": "98bf5f2a3bf72b8039e596630ed5f12e41769c3758473a0c083aa5c7041af485"
            },
            "downloads": -1,
            "filename": "redfish_utilities-3.3.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e09e64ed42584c13b7125031c273d072",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 95887,
            "upload_time": "2025-01-17T21:21:49",
            "upload_time_iso_8601": "2025-01-17T21:21:49.261676Z",
            "url": "https://files.pythonhosted.org/packages/b1/ac/201dcc093e81dba8fc84228f49db8d079e1c9c0c9465d71a478930c8caa5/redfish_utilities-3.3.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ffd471331412f65f3dba76854e40313a10f8e8ba138e544a5312943a151a3427",
                "md5": "9ecf0adad142e0ec88caa7a2a17dfdb0",
                "sha256": "3b766be32f4981a2841223b0a040e64d0b2b1d70178630861aa6474165c365db"
            },
            "downloads": -1,
            "filename": "redfish_utilities-3.3.7.tar.gz",
            "has_sig": false,
            "md5_digest": "9ecf0adad142e0ec88caa7a2a17dfdb0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 63120,
            "upload_time": "2025-01-17T21:21:51",
            "upload_time_iso_8601": "2025-01-17T21:21:51.469389Z",
            "url": "https://files.pythonhosted.org/packages/ff/d4/71331412f65f3dba76854e40313a10f8e8ba138e544a5312943a151a3427/redfish_utilities-3.3.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-17 21:21:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "DMTF",
    "github_project": "Redfish-Tacklebox",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "redfish",
            "specs": [
                [
                    ">=",
                    "3.2.1"
                ]
            ]
        },
        {
            "name": "XlsxWriter",
            "specs": [
                [
                    ">=",
                    "1.2.7"
                ]
            ]
        },
        {
            "name": "requests",
            "specs": []
        }
    ],
    "lcname": "redfish-utilities"
}