x/python-redfish
Code Issues Proposed changes
Python library and client for Redfish support
311 Commits 1 Branch 8 Tags 18 MiB
HTML 88.1%
Python 9%
ApacheConf 1.8%
Shell 0.6%
RPM Spec 0.3%
b0ff208138
Go to file
Bruno Cornec b0ff208138 Add the monitor command 
- monitor command role is to print on a regular base the values of
variable constants (Temperature, power, Fans, ...)
- new monitor_loop parameter (wait time between queries)
- new monitor_info.template
- get_power has been renamed to get_powerstate to avoid confusion with
Power measures and moved to the Device class as well as get_description
- More genericity for the Power and Thermal classes (moved into types.py)
- Build process amended (0.4.3 is the next version, repo are generic and
in line with pb 0.15

Change-Id: I05016b2557b2f7638e1ea22a89dcf91ebae1066f
2019-10-14 12:32:22 +02:00
dmtf Add spec 1.6.1 2019-03-09 18:44:40 +01:00
doc doc generation improvements 2019-08-29 01:54:33 +02:00
examples Add the monitor command 2019-10-14 12:32:22 +02:00
pbconf Add the monitor command 2019-10-14 12:32:22 +02:00
redfish Add the monitor command 2019-10-14 12:32:22 +02:00
redfish-client Add the monitor command 2019-10-14 12:32:22 +02:00
.coveragerc Fix #49, tox can be used by user 2016-04-05 17:51:23 +02:00
.gitattributes Added Attributes 2015-03-23 12:05:45 -05:00
.gitignore Fix rpm build 2016-04-30 01:02:52 +02:00
.gitreview OpenDev Migration Patch 2019-04-19 19:50:23 +00:00
.mailmap cookie cutter ify this repo, will clean up later 2015-03-25 13:46:58 -07:00
.testr.conf cookie cutter ify this repo, will clean up later 2015-03-25 13:46:58 -07:00
.zuul.yaml Remove redundant tests 2019-09-06 12:14:01 +02:00
babel.cfg cookie cutter ify this repo, will clean up later 2015-03-25 13:46:58 -07:00
CONTRIBUTING.rst Adapt contributions descritptions 2017-02-07 01:40:37 +01:00
HACKING.rst Update the URL in HACKING.rst 2018-09-25 00:33:14 +08:00
install.sh Adds the bash completion script to install proc 2017-03-28 23:45:39 +02:00
LICENSE Add LICENCE file. 2015-12-02 20:54:51 +01:00
MANIFEST.in cookie cutter ify this repo, will clean up later 2015-03-25 13:46:58 -07:00
README.rst Adapt contributions descritptions 2017-02-07 01:40:37 +01:00
requirements.txt doc generation improvements 2019-08-29 01:54:33 +02:00
setup.cfg Remove support for py34 2018-12-19 11:22:52 -05:00
setup.py Closes-Bug: #1670722 2017-03-07 19:22:06 +01:00
test-requirements.txt Re enable redfish-client tests 2017-02-23 10:25:13 +01:00
tox.ini doc generation improvements 2019-08-29 01:54:33 +02:00

README.rst

The python-redfish project

This repository will be used to house the python-redfish library, a reference implementation to enable Python developers to communicate with the Redfish API (http://www.dmtf.org/standards/redfish).

NOTE:

STATUS: Work in progress, ready for proof of concept.

The current Redfish specification revision is 1.0.0 - Note that the mockup
is still at version 0.99.0a and may not reflect what the standard provides
fully

Documentation

The full documentation is available at http://pythonhosted.org/python-redfish/installation.html

Project Structure

This project follows the same convention as OpenStack projects, eg. using pbr for build and test automation:

doc/            # Documentation
doc/source      # The doc source files live here
doc/build/html  # Output of building any docs will go here
dmtf            # Reference documents and mockup provided by the DMTF
examples/       # Any sample code using this library, eg. for education
                # should be put here
pbconf          # Project builder file to build rpm/deb packages for
                # distributions
redfish/        # The redfish library itself
redfish/tests/  # python-redfish unit test suite
redfish-client  # Client tool to manage redfish devices

Requirements

To use the enclosed examples, you will need Python 2.7 or Python 3.4 (https://www.python.org/downloads/). Note that Python 2.7.9 enforces greater SSL verification requiring server certificates be installed. Parameters to relax the requirements are available in the library, but these configurations are discouraged due to security.

Python requirements are listed in requirements.txt; additional requirements for running the unit test suite are listed in test-requirements.txt.

Note: Running tests requires Docker engine.

Note: The program was tested with Python 2.7.10 and 3.4.2 however it might work as well with all Python 3 releases.

Get the source code

The source code is available on github and can be retrieved using:

git clone https://github.com/openstack/python-redfish.git

Installation

Please refer to the following link.

http://pythonhosted.org/python-redfish/installation.html

Contacts

Distribution list: python-redfish@mondorescue.org

Further References

Please look at dmtf/README.rst file.