Python library and client for Redfish support

Go to file

Uggla bf69f3b642 Ignore files produced by tests		2016-03-04 12:02:13 +01:00
dmtf	Fix most of the comments reported in #22	2016-02-15 18:12:28 +01:00
doc	Update documentation	2016-03-04 12:02:13 +01:00
examples	Major documentation update	2016-02-13 19:59:17 +01:00
pbconf	Improve package build system	2016-02-19 20:12:44 +01:00
redfish	Fix installation of data_files	2016-03-04 12:02:13 +01:00
redfish-client	Introduce client testing	2016-03-04 12:02:13 +01:00
.coveragerc	cookie cutter ify this repo, will clean up later	2015-03-25 13:46:58 -07:00
.gitattributes	Added Attributes	2015-03-23 12:05:45 -05:00
.gitignore	Ignore files produced by tests	2016-03-04 12:02:13 +01:00
.gitreview	cookie cutter ify this repo, will clean up later	2015-03-25 13:46:58 -07: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	Fix most of the comments reported in #22	2016-02-15 18:12:28 +01:00
HACKING.rst	cookie cutter ify this repo, will clean up later	2015-03-25 13:46:58 -07: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
openstack-common.conf	cookie cutter ify this repo, will clean up later	2015-03-25 13:46:58 -07:00
README.rst	Fix most of the comments reported in #22	2016-02-15 18:12:28 +01:00
requirements.txt	Fix installation of data_files	2016-03-04 12:02:13 +01:00
setup.cfg	Fix installation of data_files	2016-03-04 12:02:13 +01:00
setup.py	Fix installation of data_files	2016-03-04 12:02:13 +01:00
test-requirements.txt	Introduce client testing	2016-03-04 12:02:13 +01:00
tox.ini	improve tox.ini with OS conventions	2015-03-28 21:54:23 -07:00

README.rst

python-redfish

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

NOTE:

DRAFT - WORK IN PROGRESS

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

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 (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.

Get the sources

The sources are available on github and can be retrieved using:

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

As python redefish is currently in heavy development we recommend to checkout the devel branch using:

cd python-redfish
git checkout devel

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.