From c96a3639948f61e7b0613bd694dca63a37ccc60a Mon Sep 17 00:00:00 2001 From: Devananda van der Veen Date: Fri, 27 Mar 2015 05:37:45 -0700 Subject: [PATCH] some cleanup of the readme --- README.rst | 23 +++++++++++++++++++-- docs/Redfish_API_Data_Model.md | 2 -- docs/Redfish_Specification_Documentation.md | 2 -- examples/__init__.py | 1 + examples/simple.py | 3 +++ 5 files changed, 25 insertions(+), 6 deletions(-) delete mode 100644 docs/Redfish_API_Data_Model.md delete mode 100644 docs/Redfish_Specification_Documentation.md create mode 100644 examples/__init__.py create mode 100644 examples/simple.py diff --git a/README.rst b/README.rst index cc74d0c..944ffe7 100644 --- a/README.rst +++ b/README.rst @@ -1,16 +1,26 @@ python-redfish ============== -This repository will be used to house the Redfish python library. This library -will be used to help Python developers communicate with the Redfish API +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: + + 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 ------------------- This project follows the same convention as OpenStack projects, eg. using pbr for build and test automation. + examples/ + tests/ + + 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 relax the requirements are available in the library, but these configurations 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/ \ No newline at end of file diff --git a/docs/Redfish_API_Data_Model.md b/docs/Redfish_API_Data_Model.md deleted file mode 100644 index e414e60..0000000 --- a/docs/Redfish_API_Data_Model.md +++ /dev/null @@ -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"). \ No newline at end of file diff --git a/docs/Redfish_Specification_Documentation.md b/docs/Redfish_Specification_Documentation.md deleted file mode 100644 index 60e24be..0000000 --- a/docs/Redfish_Specification_Documentation.md +++ /dev/null @@ -1,2 +0,0 @@ -# Redfish Specification -The overall protocol documentation can be found [here](http://www.redfishspecification.org/ "Redfish Specification"). \ No newline at end of file diff --git a/examples/__init__.py b/examples/__init__.py new file mode 100644 index 0000000..acef755 --- /dev/null +++ b/examples/__init__.py @@ -0,0 +1 @@ +__author__ = 'deva' diff --git a/examples/simple.py b/examples/simple.py new file mode 100644 index 0000000..3d1efa3 --- /dev/null +++ b/examples/simple.py @@ -0,0 +1,3 @@ +from redfish import connection + +server = connection \ No newline at end of file