x/python-redfish
Code Issues Proposed changes
Python library and client for Redfish support
229 Commits 1 Branch 8 Tags 18 MiB
HTML 88.1%
Python 9%
ApacheConf 1.8%
Shell 0.6%
RPM Spec 0.3%
9a7c65d942
Go to file
Bruno Cornec 9a7c65d942 Update docs for Redfish 
- Added 1.0.2
- Added 1.0.3 (2016-07-14)
- Added 1.0.4 (2016-08-30)
- Add the new mockup v1.0.0
- Add the new API schema 2016.2
- Add Moonshot Data Model ref in dmtf directory

Change-Id: I0a7cb127d5fb9324e50164eff786e54411c0e7aa
2017-01-25 13:36:20 +01:00
dmtf Update docs for Redfish 2017-01-25 13:36:20 +01:00
doc Fix rpm build 2016-04-30 01:02:52 +02:00
examples PEP8 fixes 2016-04-06 18:32:22 +02:00
pbconf Adds the announces DB for pb 2016-04-30 02:11:22 +02:00
redfish Fix jenkins tests to allow commits 2017-01-23 17:37:22 +01:00
redfish-client Fix jenkins tests to allow commits 2017-01-23 17:37:22 +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 Update doc again 2016-04-07 15:26:35 +02:00
HACKING.rst cookie cutter ify this repo, will clean up later 2015-03-25 13:46:58 -07:00
install.sh Fix rpm build 2016-04-30 01:02:52 +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 Update doc again 2016-04-07 15:26:35 +02:00
requirements.txt New version of PR #38 2016-04-04 19:35:03 +02:00
setup.cfg Fix jenkins tests to allow commits 2017-01-23 17:37:22 +01:00
setup.py Fix jenkins tests to allow commits 2017-01-23 17:37:22 +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/bcornec/python-redfish

As python-redfish 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.