Python library and client for Redfish support

Go to file

Bruno Cornec 9d6ec64daf Improve package build - Packages can now be built with Docker containers and project-builder.org for Mageia 5, Fedora 25, OpenSUSE 42.2 & CentOS 7 - Fix a bug in conf file path management in setup.py - A script pbconf/mkctn is also availble to ease package building - Status is documented in pbconf/README.rst - Update install script to have a variable for doc installation path which is different between Mageia/Fedora and OpenSUSE Change-Id: Id34e885c5cba7b650adf1638147ffb089ad3c7c3		2017-02-21 00:53:08 +01:00
dmtf	Merge "Updates to DMTF docs"	2017-01-31 14:03:32 +00:00
doc	Improve package build	2017-02-21 00:53:08 +01:00
examples	PEP8 fixes	2016-04-06 18:32:22 +02:00
pbconf	Improve package build	2017-02-21 00:53:08 +01:00
redfish	Fix urllib import that prevent clients to run with python2	2017-02-04 20:11:11 +01:00
redfish-client	Fix wrong delivery for usage files	2017-02-15 18:52:07 +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
.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	cookie cutter ify this repo, will clean up later	2015-03-25 13:46:58 -07:00
install.sh	Improve package build	2017-02-21 00:53:08 +01: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	Fix wrong delivery for usage files	2017-02-15 18:52:07 +01:00
setup.py	Fix wrong delivery for usage files	2017-02-15 18:52:07 +01:00
test-requirements.txt	Fix jenkins tests to allow commits	2017-01-23 17:37:22 +01:00
tox.ini	Fix jenkins tests to allow commits	2017-01-23 17:37:22 +01: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.