From 351547b0517484a8cb50d27dee8d7c5a1fa1ea25 Mon Sep 17 00:00:00 2001 From: Uggla Date: Mon, 15 Feb 2016 17:16:16 +0100 Subject: [PATCH] Update documentation - Add python3 release. - Add a FAQ. - Various minor updates. --- README.rst | 14 +++++++++++--- doc/source/faq.rst | 11 +++++++++++ doc/source/index.rst | 1 + doc/source/testing.rst | 4 ++++ 4 files changed, 27 insertions(+), 3 deletions(-) create mode 100644 doc/source/faq.rst diff --git a/README.rst b/README.rst index 4b4cf50..cb69f58 100644 --- a/README.rst +++ b/README.rst @@ -9,10 +9,15 @@ NOTE:: DRAFT - WORK IN PROGRESS - 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 + 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 ------------------- @@ -35,7 +40,7 @@ for build and test automation:: Requirements ------------ -To use the enclosed examples, you will need Python 2.7 +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 @@ -44,6 +49,9 @@ 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: 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 sources --------------- diff --git a/doc/source/faq.rst b/doc/source/faq.rst new file mode 100644 index 0000000..8e53b2a --- /dev/null +++ b/doc/source/faq.rst @@ -0,0 +1,11 @@ +=== +FAQ +=== + +- Q1 : error in setup command: Invalid environment marker: (python_version < '3') + + This error is caused by old setuptools revisions that do not understant "python_version < '3'". + Upgrade setuptools using:: + + pip install --upgrade setuptools + diff --git a/doc/source/index.rst b/doc/source/index.rst index 15abfa7..2de689e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -18,6 +18,7 @@ Contents: testing classesdoc contributing + faq help Indices and tables diff --git a/doc/source/testing.rst b/doc/source/testing.rst index ac94b45..dd0d90c 100644 --- a/doc/source/testing.rst +++ b/doc/source/testing.rst @@ -15,6 +15,10 @@ refish-client tests #. Install docker using the `procedure `_. #. Ensure you can use docker with your current user. #. Jump into redfish-python directory containing the sources. +#. Depending of your distribution, you may have to upgrade setuptools:: + + pip install --upgrade setuptools + #. Install required modules for testings:: pip install -t test-requirements.txt