Update various utilities and documentation files.

.gitignore

@@ -9,7 +9,8 @@ MANIFEST
 *.pyc
 *.pyo
 
-Foundations.egg-info
-dist
-docs/sphinx/build
-docs/sphinx/source/resources/packages
+Foundations.egg-info/
+dist/
+docs/sphinx/build/
+docs/sphinx/source/resources/packages/
+releases/

CHANGES.rst

@@ -1,13 +1,18 @@
 Foundations - 2.0.2 - Stable
 ============================
 
+.. .changes
+
 Changes
 =======
 
 2.0.2 - Stable
 --------------
 
--  Add TCP server implementation through "foundations.tcpServer" module.
+-  Updated package directory structure to be compliant with "Python Package Index".
+-  Added documentation / Api files.
+-  Added TCP server implementation through "foundations.tcpServer" module.
+-  "foundations.walkers.FilesWalker" class has been refactored to "foundations.walkers.filesWalker" generator definition.
 
 2.0.1 - Stable
 --------------
@@ -18,13 +23,13 @@ Changes
 --------------
 
 -  Major package refactor.
--  Adde "cache", "dag", "dataStructures" modules and associated units tests module.
+-  Added "cache", "dag", "dataStructures" modules and associated units tests module.
 
 1.0.4 - Stable
 --------------
 
 -  Reorganize package directories structure.
--  Adde "rotatingBackup" module and associated "testsRotatingBackup" units tests module.
+-  Added "rotatingBackup" module and associated "testsRotatingBackup" units tests module.
 
 1.0.3 - Stable
 --------------
@@ -50,10 +55,12 @@ Changes
 
 -  Initial Release of Foundations.
 
+.. .about
+
 About
 -----
 
-| sIBL_GUI by Thomas Mansencal – 2008 - 2012
+| Foundations by Thomas Mansencal – 2008 - 2012
 | Copyright© 2008 - 2012 – Thomas Mansencal – `thomas.mansencal@gmail.com <mailto:thomas.mansencal@gmail.com>`_
 | This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/
 | `http://www.thomasmansencal.com/ <http://www.thomasmansencal.com/>`_

README.rst

@@ -11,10 +11,23 @@ Introduction
 Installation
 ------------
 
+To install **Foundations** from the `Python Package Index <http://pypi.python.org/pypi/Foundations>`_ you can issue this command in a shell::
+
+	pip install Foundations
+
+or this alternative command::
+
+	easy_install Foundations
+
+Alternatively, if you want to directly install from `Github <http://github.com/KelSolaar/Foundations>`_ source repository::
+
+	git clone git://github.com/KelSolaar/Foundations.git
+	python setup.py install
+
 Usage
 -----
 
-Given the large spectrum of the objects defined in **Foundations** package, please refer to the Api ( `Foundations - Api <index.html>`_ ) for precise usage examples about each modules. Here are listed a few non exhaustive usage examples.
+Given the large spectrum of the objects defined in **Foundations** package, please refer to `Foundations - Api <http://thomasmansencal.com/Sharing/Foundations/Support/Documentation/Api/index.html>`_ for precise usage examples about each modules. Here are listed a few non exhaustive usage examples.
 
 -  foundations.dataStructures.Structure:
 

docs/help/Foundations_Manual.html

@@ -85,10 +85,10 @@ <h1>
 						<a class="reference internal" href="#usage">Usage</a>
 					</li>
 					<li>
-						<a class="reference internal" href="#changes">Changes</a>
+						<a class="reference internal" href="#api">Api</a>
 					</li>
 					<li>
-						<a class="reference internal" href="#api">Api</a>
+						<a class="reference internal" href="#changes">Changes</a>
 					</li>
 					<li>
 						<a class="reference internal" href="#about">About</a>
@@ -101,22 +101,41 @@ <h1>
 					<span class="target" id="introduction">Introduction</span>
 				</h1>
 				<p>
-					Foundations is the core package of <a class="reference external" href="http://github.com/KelSolaar/Umbra">Umbra</a>, <a class="reference external" href="http://github.com/KelSolaar/sIBL_GUI">sIBL_GUI</a>, <a class="reference external" href="http://github.com/KelSolaar/sIBL_Reporter">sIBL_Reporter</a> and others tools.
+					<strong>Foundations</strong> is the core package of <a class="reference external" href="http://github.com/KelSolaar/Umbra">Umbra</a>, <a class="reference external" href="http://github.com/KelSolaar/sIBL_GUI">sIBL_GUI</a>, <a class="reference external" href="http://github.com/KelSolaar/sIBL_Reporter">sIBL_Reporter</a>. It provides modules defining various utilities classes and definitions used in those packages.
 				</p><br />
 				<!-- .installation -->
 			</div>
 			<div class="section" id="id2">
 				<h1>
 					<span class="target" id="installation">Installation</span>
-				</h1><br />
+				</h1>
+				<p>
+					To install <strong>Foundations</strong> from the <a class="reference external" href="http://pypi.python.org/pypi/Foundations">Python Package Index</a> you can issue this command in a shell:
+				</p>
+				<pre class="literal-block">
+pip install Foundations
+</pre>
+				<p>
+					or this alternative command:
+				</p>
+				<pre class="literal-block">
+easy_install Foundations
+</pre>
+				<p>
+					Alternatively, if you want to directly install from <a class="reference external" href="http://github.com/KelSolaar/Foundations">Github</a> source repository:
+				</p>
+				<pre class="literal-block">
+git clone git://github.com/KelSolaar/Foundations.git
+python setup.py install
+</pre><br />
 				<!-- .usage -->
 			</div>
 			<div class="section" id="id3">
 				<h1>
 					<span class="target" id="usage">Usage</span>
 				</h1>
 				<p>
-					Given the large spectrum of the objects defined in <strong>Foundations</strong> package, please refer to the Api ( <a class="reference external" href="index.html">Foundations - Api</a> ) for precise usage examples about each modules. Here are listed a few non exhaustive usage examples.
+					Given the large spectrum of the objects defined in <strong>Foundations</strong> package, please refer to <a class="reference external" href="http://thomasmansencal.com/Sharing/Foundations/Support/Documentation/Api/index.html">Foundations - Api</a> for precise usage examples about each modules. Here are listed a few non exhaustive usage examples.
 				</p>
 				<ul class="simple">
 					<li>foundations.dataStructures.Structure:
@@ -216,17 +235,14 @@ <h1>
 					<span class="target" id="api">Api</span>
 				</h1>
 				<p>
-					<em>Foundations</em> Api documentation is available here: <a class="reference external" href="index.html">Foundations - Api</a>
+					<em>Foundations</em> Api documentation is available here: <a class="reference external" href="http://thomasmansencal.com/Sharing/Foundations/Support/Documentation/Api/index.html">Foundations - Api</a>
 				</p><br />
 				<!-- .changes -->
 			</div>
 			<div class="section" id="id6">
 				<h1>
 					<span class="target" id="changes">Changes</span>
-				</h1>
-				<p>
-					<strong>Foundations - Changes</strong>: Change_Log.html
-				</p><br />
+				</h1><br />
 				<!-- .about -->
 			</div>
 			<div class="section" id="id7">

docs/help/Foundations_Manual.rst

@@ -13,8 +13,8 @@ Table Of Content
 -  `Introduction`_
 -  `Installation`_
 -  `Usage`_
--  `Changes`_
 -  `Api`_
+-  `Changes`_
 -  `About`_
 
 .. raw:: html
@@ -26,7 +26,7 @@ Table Of Content
 _`Introduction`
 ===============
 
-Foundations is the core package of `Umbra <http://github.com/KelSolaar/Umbra>`_, `sIBL_GUI <http://github.com/KelSolaar/sIBL_GUI>`_, `sIBL_Reporter <http://github.com/KelSolaar/sIBL_Reporter>`_ and others tools.
+**Foundations** is the core package of `Umbra <http://github.com/KelSolaar/Umbra>`_, `sIBL_GUI <http://github.com/KelSolaar/sIBL_GUI>`_, `sIBL_Reporter <http://github.com/KelSolaar/sIBL_Reporter>`_. It provides modules defining various utilities classes and definitions used in those packages.
 
 .. raw:: html
 
@@ -37,6 +37,19 @@ Foundations is the core package of `Umbra <http://github.com/KelSolaar/Umbra>`_,
 _`Installation`
 ===============
 
+To install **Foundations** from the `Python Package Index <http://pypi.python.org/pypi/Foundations>`_ you can issue this command in a shell::
+
+	pip install Foundations
+
+or this alternative command::
+
+	easy_install Foundations
+
+Alternatively, if you want to directly install from `Github <http://github.com/KelSolaar/Foundations>`_ source repository::
+
+	git clone git://github.com/KelSolaar/Foundations.git
+	python setup.py install
+
 .. raw:: html
 
     <br/>
@@ -46,7 +59,7 @@ _`Installation`
 _`Usage`
 ========
 
-Given the large spectrum of the objects defined in **Foundations** package, please refer to the Api ( `Foundations - Api <index.html>`_ ) for precise usage examples about each modules. Here are listed a few non exhaustive usage examples.
+Given the large spectrum of the objects defined in **Foundations** package, please refer to `Foundations - Api <http://thomasmansencal.com/Sharing/Foundations/Support/Documentation/Api/index.html>`_ for precise usage examples about each modules. Here are listed a few non exhaustive usage examples.
 
 -  foundations.dataStructures.Structure:
 
@@ -141,7 +154,7 @@ Given the large spectrum of the objects defined in **Foundations** package, plea
 _`Api`
 ======
 
-*Foundations* Api documentation is available here: `Foundations - Api <index.html>`_
+*Foundations* Api documentation is available here: `Foundations - Api <http://thomasmansencal.com/Sharing/Foundations/Support/Documentation/Api/index.html>`_
 
 .. raw:: html
 
@@ -152,8 +165,6 @@ _`Api`
 _`Changes`
 ==========
 
-**Foundations - Changes**: Change_Log.html
-
 .. raw:: html
 
     <br/>

docs/sphinx/source/index.rst

@@ -10,8 +10,8 @@ Contents:
  Introduction <resources/pages/introduction>
  Installation <resources/pages/installation>
  Usage <resources/pages/usage>
- Changes <resources/pages/changes>
  Api <resources/pages/api>
+ Changes <resources/pages/changes>
  About <resources/pages/about>
 
 Search:

docs/sphinx/source/resources/pages/about.rst

@@ -1,7 +1,7 @@
-_`About`
-========
+About
+-----
 
-| *Foundations* by Thomas Mansencal - 2008 - 2012
-| Copyright© 2008 - 2012 - Thomas Mansencal - `thomas.mansencal@gmail.com <mailto:thomas.mansencal@gmail.com>`_
+| Foundations by Thomas Mansencal – 2008 - 2012
+| Copyright© 2008 - 2012 – Thomas Mansencal – `thomas.mansencal@gmail.com <mailto:thomas.mansencal@gmail.com>`_
 | This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/
-| http://www.thomasmansencal.com/
+| `http://www.thomasmansencal.com/ <http://www.thomasmansencal.com/>`_

docs/sphinx/source/resources/pages/api.rst

@@ -25,24 +25,3 @@ Modules Summary:
    foundations.tcpServer <api/foundations.tcpServer>
    foundations.ui.common <api/foundations.ui.common>
    foundations.walkers <api/foundations.walkers>
-   foundations.tests.tests <api/foundations.tests.tests>
-   foundations.tests.testsFoundations.testsCache <api/foundations.tests.testsFoundations.testsCache>
-   foundations.tests.testsFoundations.testsCommon <api/foundations.tests.testsFoundations.testsCommon>
-   foundations.tests.testsFoundations.testsCore <api/foundations.tests.testsFoundations.testsCore>
-   foundations.tests.testsFoundations.testsDataStructures <api/foundations.tests.testsFoundations.testsDataStructures>
-   foundations.tests.testsFoundations.testsEnvironment <api/foundations.tests.testsFoundations.testsEnvironment>
-   foundations.tests.testsFoundations.testsExceptions <api/foundations.tests.testsFoundations.testsExceptions>
-   foundations.tests.testsFoundations.testsGlobals.testsConstants <api/foundations.tests.testsFoundations.testsGlobals.testsConstants>
-   foundations.tests.testsFoundations.testsIo <api/foundations.tests.testsFoundations.testsIo>
-   foundations.tests.testsFoundations.testsLibrary <api/foundations.tests.testsFoundations.testsLibrary>
-   foundations.tests.testsFoundations.testsNamespace <api/foundations.tests.testsFoundations.testsNamespace>
-   foundations.tests.testsFoundations.testsNodes <api/foundations.tests.testsFoundations.testsNodes>
-   foundations.tests.testsFoundations.testsParsers <api/foundations.tests.testsFoundations.testsParsers>
-   foundations.tests.testsFoundations.testsPkzip <api/foundations.tests.testsFoundations.testsPkzip>
-   foundations.tests.testsFoundations.testsRotatingBackup <api/foundations.tests.testsFoundations.testsRotatingBackup>
-   foundations.tests.testsFoundations.testsStreamObject <api/foundations.tests.testsFoundations.testsStreamObject>
-   foundations.tests.testsFoundations.testsStrings <api/foundations.tests.testsFoundations.testsStrings>
-   foundations.tests.testsFoundations.testsTcpServer <api/foundations.tests.testsFoundations.testsTcpServer>
-   foundations.tests.testsFoundations.testsUi.testsCommon <api/foundations.tests.testsFoundations.testsUi.testsCommon>
-   foundations.tests.testsFoundations.testsWalkers <api/foundations.tests.testsFoundations.testsWalkers>
-   foundations.tests.utilities <api/foundations.tests.utilities>

docs/sphinx/source/resources/pages/api/foundations.common.rst

@@ -19,6 +19,8 @@ Functions
 
 .. autofunction:: getFirstItem
 
+.. autofunction:: getLastItem
+
 .. autofunction:: isBinaryFile
 
 .. autofunction:: repeat

docs/sphinx/source/resources/pages/api/foundations.namespace.rst

@@ -19,3 +19,7 @@ Functions
 
 .. autofunction:: removeNamespace
 
+.. autofunction:: getRoot
+
+.. autofunction:: getLeaf
+