x/python-redfish
Code Issues Proposed changes
Python library and client for Redfish support
43 Commits 1 Branch 8 Tags 18 MiB
HTML 88.1%
Python 9%
ApacheConf 1.8%
Shell 0.6%
RPM Spec 0.3%
2a70e6e765
Go to file
Devananda van der Veen 2a70e6e765 Refactoring and adding Types 
Some big changes here:

Rename connection.py to server.py

Refactor about half of server.py into a new types.py module which builds
classes for each resource type, and auto-builds links to fetch
sub-resources from each type.

Add examples/walk-chassis.py to demonstrate how to use the Root and
Chassis classes to walk all the objects returned from /rest/v1/chassis/

Import oslo_log and start using it (more to do here, it's not working
quite yet).
2015-04-04 08:44:22 -07:00
doc/source cookie cutter ify this repo, will clean up later 2015-03-25 13:46:58 -07:00
examples Refactoring and adding Types 2015-04-04 08:44:22 -07:00
redfish Refactoring and adding Types 2015-04-04 08:44:22 -07: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 ReSync initial commit 2015-03-23 13:11:05 -05: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 cookie cutter ify this repo, will clean up later 2015-03-25 13:46:58 -07:00
HACKING.rst cookie cutter ify this repo, will clean up later 2015-03-25 13:46:58 -07:00
LICENSE Initial commit 2015-03-23 11:34:43 -05: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 make the NOTE in readme not hidden 2015-03-31 16:22:23 -07:00
requirements.txt Refactoring and adding Types 2015-04-04 08:44:22 -07:00
setup.cfg cookie cutter ify this repo, will clean up later 2015-03-25 13:46:58 -07:00
setup.py cookie cutter ify this repo, will clean up later 2015-03-25 13:46:58 -07:00
test-requirements.txt cookie cutter ify this repo, will clean up later 2015-03-25 13:46:58 -07: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.redfishspecification.org/).

NOTE:

DRAFT - WORK IN PROGRESS

The current Redfish specification revsion is 0.91 - anything and everything
in this library is subject to change until the DMTF ratifies the Redfish API
standard v1.0.

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
examples/       # any sample code using this library, eg. for education
                # should be put here
redfish/        # the redfish library
redfish/tests/  # python unit test suite

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 sec

Python requirements are listed in requirements.txt; additional requirements for running the unit test suite are listed in test-requirements.txt.

Developer setup

To initialize a local development environment (eg, so you can run unit tests) you should run the following commands:

Further References

The data model documentation can be found here:

http://www.redfishspecification.org/redfish-data-model-and-schema/

The overall protocol documentation can be found here:

http://www.redfishspecification.org/