Python library and client for Redfish support
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OpenDev Sysadmins 4ae087f94b OpenDev Migration Patch 1 month ago
dmtf Add spec 1.6.1 2 months ago
doc Fix a link in doc and update develsetup 2 years ago
examples Fix example for simulator to work with the HPE ilorestfulapiexplorer 2 months ago
pbconf Add debian/ubuntu packages built with project-builder.org - tested with Ubuntu 18.04 1 month ago
redfish Add a getserial command to redfish-client 1 month ago
redfish-client Add a getserial command to redfish-client 1 month ago
.coveragerc Fix #49, tox can be used by user 3 years ago
.gitattributes Added Attributes 4 years ago
.gitignore Fix rpm build 3 years ago
.gitreview OpenDev Migration Patch 1 month ago
.mailmap cookie cutter ify this repo, will clean up later 4 years ago
.testr.conf cookie cutter ify this repo, will clean up later 4 years ago
CONTRIBUTING.rst Adapt contributions descritptions 2 years ago
HACKING.rst Update the URL in HACKING.rst 8 months ago
LICENSE Add LICENCE file. 3 years ago
MANIFEST.in cookie cutter ify this repo, will clean up later 4 years ago
README.rst Adapt contributions descritptions 2 years ago
babel.cfg cookie cutter ify this repo, will clean up later 4 years ago
install.sh Adds the bash completion script to install proc 2 years ago
requirements.txt New version of PR #38 3 years ago
setup.cfg Remove support for py34 5 months ago
setup.py Closes-Bug: #1670722 2 years ago
test-requirements.txt Re enable redfish-client tests 2 years ago
tox.ini add python 3.6 unit test job 2 months ago

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.