Python library and client for Redfish support

Go to file

Valentin Boucher fe5391b2d9 Fix Apache MPM issue The new httpd docker image required MPM module in the httpd.conf https://stackoverflow.com/questions/48525092/docker-httpd-configuration-error-no-mpm-loaded Change-Id: I1ef1500ff2446f82fd084e4a9d6ab43ee3657271 Signed-off-by: Valentin Boucher <valentin.boucher@kontron.com>		2018-11-14 15:23:24 -05:00
dmtf	Fix Apache MPM issue	2018-11-14 15:23:24 -05:00
doc	Fix a link in doc and update develsetup	2017-03-17 09:08:43 +00:00
examples	Fix pep8 issues	2017-03-07 20:04:13 +01:00
pbconf	Improve docs files for deb	2017-04-20 22:00:31 +02:00
redfish	delete useless globe variables	2018-02-28 09:30:40 +00:00
redfish-client	Fix auto completion for erdfish-client	2017-03-23 00:09:16 +01: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	add gitreview file	2018-02-23 11:04:58 +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
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	New version of PR #38	2016-04-04 19:35:03 +02:00
setup.cfg	Cleanup setup.cfg	2017-04-20 21:47:53 +02: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	fix tox python3 overrides	2018-06-09 21:20:03 +08: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.