Permalink
Browse files

Update various utilities and documentation files.

  • Loading branch information...
1 parent 33d2f03 commit ad94d99bd20c0d70fcbf2c6dd9566cf592c9990c @KelSolaar committed Sep 14, 2012
Showing with 202 additions and 602 deletions.
  1. +5 −4 .gitignore
  2. +11 −4 CHANGES.rst
  3. +14 −1 README.rst
  4. +26 −10 docs/help/Foundations_Manual.html
  5. +17 −6 docs/help/Foundations_Manual.rst
  6. +1 −1 docs/sphinx/source/index.rst
  7. +5 −5 docs/sphinx/source/resources/pages/about.rst
  8. +0 −21 docs/sphinx/source/resources/pages/api.rst
  9. +2 −0 docs/sphinx/source/resources/pages/api/foundations.common.rst
  10. +4 −0 docs/sphinx/source/resources/pages/api/foundations.namespace.rst
  11. +0 −10 docs/sphinx/source/resources/pages/api/foundations.tests.tests.rst
  12. +0 −12 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsCache.rst
  13. +0 −41 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsCommon.rst
  14. +0 −32 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsCore.rst
  15. +0 −24 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsDataStructures.rst
  16. +0 −20 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsEnvironment.rst
  17. +0 −21 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsExceptions.rst
  18. +0 −12 ...inx/source/resources/pages/api/foundations.tests.testsFoundations.testsGlobals.testsConstants.rst
  19. +0 −33 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsIo.rst
  20. +0 −25 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsLibrary.rst
  21. +0 −20 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsNamespace.rst
  22. +0 −20 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsNodes.rst
  23. +0 −61 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsParsers.rst
  24. +0 −21 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsPkzip.rst
  25. +0 −21 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsRotatingBackup.rst
  26. +0 −12 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsStreamObject.rst
  27. +0 −72 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsStrings.rst
  28. +0 −16 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsTcpServer.rst
  29. +0 −19 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsUi.testsCommon.rst
  30. +0 −35 docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsWalkers.rst
  31. +0 −12 docs/sphinx/source/resources/pages/api/foundations.tests.utilities.rst
  32. +48 −5 docs/sphinx/source/resources/pages/changes.rst
  33. +13 −0 docs/sphinx/source/resources/pages/installation.rst
  34. +1 −1 docs/sphinx/source/resources/pages/introduction.rst
  35. +1 −1 docs/sphinx/source/resources/pages/usage.rst
  36. +27 −3 setup.py
  37. +25 −0 utilities/gatherFiles.sh
  38. +1 −0 utilities/getDocumentation.sh
  39. +1 −1 utilities/getSphinxDocumentationApi.py
View
@@ -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/
View
@@ -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/>`_
View
@@ -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:
@@ -85,10 +85,10 @@
<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 @@
<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 @@
<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">
@@ -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/>
@@ -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:
@@ -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/>`_
@@ -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>
@@ -19,6 +19,8 @@ Functions
.. autofunction:: getFirstItem
+.. autofunction:: getLastItem
+
.. autofunction:: isBinaryFile
.. autofunction:: repeat
@@ -19,3 +19,7 @@ Functions
.. autofunction:: removeNamespace
+.. autofunction:: getRoot
+
+.. autofunction:: getLeaf
+
@@ -1,10 +0,0 @@
-_`foundations.tests.tests`
-==========================
-
-.. automodule:: foundations.tests.tests
-
-Functions
----------
-
-.. autofunction:: testsSuite
-
@@ -1,12 +0,0 @@
-_`foundations.tests.testsFoundations.testsCache`
-================================================
-
-.. automodule:: foundations.tests.testsFoundations.testsCache
-
-Classes
--------
-
-.. autoclass:: CacheTestCase
- :show-inheritance:
- :members:
-
@@ -1,41 +0,0 @@
-_`foundations.tests.testsFoundations.testsCommon`
-=================================================
-
-.. automodule:: foundations.tests.testsFoundations.testsCommon
-
-Module Attributes
------------------
-
-.. attribute:: foundations.tests.testsFoundations.testsCommon.RESOURCES_DIRECTORY
-
-.. attribute:: foundations.tests.testsFoundations.testsCommon.LIBRARIES_DIRECTORY
-
-.. attribute:: foundations.tests.testsFoundations.testsCommon.TEXT_FILE
-
-Classes
--------
-
-.. autoclass:: UniqifyTestCase
- :show-inheritance:
- :members:
-
-.. autoclass:: OrderedUniqifyTestCase
- :show-inheritance:
- :members:
-
-.. autoclass:: PathExistsTestCase
- :show-inheritance:
- :members:
-
-.. autoclass:: getFirstItemTestCase
- :show-inheritance:
- :members:
-
-.. autoclass:: IsBinaryFileTestCase
- :show-inheritance:
- :members:
-
-.. autoclass:: RepeatTestCase
- :show-inheritance:
- :members:
-
Oops, something went wrong.

0 comments on commit ad94d99

Please sign in to comment.