some cleanup of the readme

This commit is contained in:
Devananda van der Veen 2015-03-27 05:37:45 -07:00
parent 81c68cad24
commit c96a363994
5 changed files with 25 additions and 6 deletions

View File

@ -1,16 +1,26 @@
python-redfish python-redfish
============== ==============
This repository will be used to house the Redfish python library. This library This repository will be used to house the Redfish python library, a reference
will be used to help Python developers communicate with the Redfish API implementation to enable Python developers to communicate with the Redfish API
(http://www.redfishspecification.org/). (http://www.redfishspecification.org/).
.. note:
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.
Directory Structure Directory Structure
------------------- -------------------
This project follows the same convention as OpenStack projects, eg. using pbr This project follows the same convention as OpenStack projects, eg. using pbr
for build and test automation. for build and test automation.
examples/
tests/
Requirements Requirements
------------ ------------
@ -19,3 +29,12 @@ To use the enclosed examples, you will need Python 2.7
SSL verification requiring server certificates be installed. Parameters to SSL verification requiring server certificates be installed. Parameters to
relax the requirements are available in the library, but these configurations relax the requirements are available in the library, but these configurations
are discouraged due to security concerns. are discouraged due to security concerns.
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/

View File

@ -1,2 +0,0 @@
# Redfish: Data Model and Schema
The data model documentation can be found [here](http://www.redfishspecification.org/redfish-data-model-and-schema/ "Redfish: Data Model and Schema").

View File

@ -1,2 +0,0 @@
# Redfish Specification
The overall protocol documentation can be found [here](http://www.redfishspecification.org/ "Redfish Specification").

1
examples/__init__.py Normal file
View File

@ -0,0 +1 @@
__author__ = 'deva'

3
examples/simple.py Normal file
View File

@ -0,0 +1,3 @@
from redfish import connection
server = connection