diff --git a/.gitignore b/.gitignore index 862a102..02aaed2 100644 --- a/.gitignore +++ b/.gitignore @@ -9,7 +9,8 @@ MANIFEST *.pyc *.pyo -Foundations.egg-info -dist -docs/sphinx/build -docs/sphinx/source/resources/packages \ No newline at end of file +Foundations.egg-info/ +dist/ +docs/sphinx/build/ +docs/sphinx/source/resources/packages/ +releases/ \ No newline at end of file diff --git a/CHANGES.rst b/CHANGES.rst index ea1a5ef..0a9b5f4 100644 --- a/CHANGES.rst +++ b/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 `_ | This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/ | `http://www.thomasmansencal.com/ `_ \ No newline at end of file diff --git a/README.rst b/README.rst index 7e88df5..0e1cc46 100644 --- a/README.rst +++ b/README.rst @@ -11,10 +11,23 @@ Introduction Installation ------------ +To install **Foundations** from the `Python Package Index `_ 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 `_ 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 `_ ) 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 `_ for precise usage examples about each modules. Here are listed a few non exhaustive usage examples. - foundations.dataStructures.Structure: diff --git a/docs/help/Foundations_Manual.html b/docs/help/Foundations_Manual.html index 9fcc9e2..cc07ceb 100644 --- a/docs/help/Foundations_Manual.html +++ b/docs/help/Foundations_Manual.html @@ -85,10 +85,10 @@

Usage
  • - Changes + Api
  • - Api + Changes
  • About @@ -101,14 +101,33 @@

    Introduction

    - Foundations is the core package of Umbra, sIBL_GUI, sIBL_Reporter and others tools. + Foundations is the core package of Umbra, sIBL_GUI, sIBL_Reporter. It provides modules defining various utilities classes and definitions used in those packages.


    Installation -


    +

    • +

    + To install Foundations from the Python Package Index 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 source repository: +

    + 
    +git clone git://github.com/KelSolaar/Foundations.git
+python setup.py install
+

    @@ -116,7 +135,7 @@

    Usage

    - Given the large spectrum of the objects defined in Foundations package, please refer to the Api ( Foundations - Api ) 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 for precise usage examples about each modules. Here are listed a few non exhaustive usage examples.

    • foundations.dataStructures.Structure: @@ -216,17 +235,14 @@

      Api

      - Foundations Api documentation is available here: Foundations - Api + Foundations Api documentation is available here: Foundations - Api


    Changes -

    -

    - Foundations - Changes: Change_Log.html -


    +
    diff --git a/docs/help/Foundations_Manual.rst b/docs/help/Foundations_Manual.rst index dc340cb..9a12359 100644 --- a/docs/help/Foundations_Manual.rst +++ b/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 `_, `sIBL_GUI `_, `sIBL_Reporter `_ and others tools. +**Foundations** is the core package of `Umbra `_, `sIBL_GUI `_, `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 `_, _`Installation` =============== +To install **Foundations** from the `Python Package Index `_ 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 `_ source repository:: + + git clone git://github.com/KelSolaar/Foundations.git + python setup.py install + .. raw:: html
    @@ -46,7 +59,7 @@ _`Installation` _`Usage` ======== -Given the large spectrum of the objects defined in **Foundations** package, please refer to the Api ( `Foundations - Api `_ ) 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 `_ 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 `_ +*Foundations* Api documentation is available here: `Foundations - Api `_ .. raw:: html @@ -152,8 +165,6 @@ _`Api` _`Changes` ========== -**Foundations - Changes**: Change_Log.html - .. raw:: html
    diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 6dfd71f..84fa7f3 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -10,8 +10,8 @@ Contents: Introduction Installation Usage - Changes Api + Changes About Search: diff --git a/docs/sphinx/source/resources/pages/about.rst b/docs/sphinx/source/resources/pages/about.rst index 85a472a..dc77dc0 100644 --- a/docs/sphinx/source/resources/pages/about.rst +++ b/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 `_ +| Foundations by Thomas Mansencal – 2008 - 2012 +| Copyright© 2008 - 2012 – Thomas Mansencal – `thomas.mansencal@gmail.com `_ | This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/ -| http://www.thomasmansencal.com/ \ No newline at end of file +| `http://www.thomasmansencal.com/ `_ \ No newline at end of file diff --git a/docs/sphinx/source/resources/pages/api.rst b/docs/sphinx/source/resources/pages/api.rst index cd4bfe4..df4d719 100644 --- a/docs/sphinx/source/resources/pages/api.rst +++ b/docs/sphinx/source/resources/pages/api.rst @@ -25,24 +25,3 @@ Modules Summary: foundations.tcpServer foundations.ui.common foundations.walkers - foundations.tests.tests - foundations.tests.testsFoundations.testsCache - foundations.tests.testsFoundations.testsCommon - foundations.tests.testsFoundations.testsCore - foundations.tests.testsFoundations.testsDataStructures - foundations.tests.testsFoundations.testsEnvironment - foundations.tests.testsFoundations.testsExceptions - foundations.tests.testsFoundations.testsGlobals.testsConstants - foundations.tests.testsFoundations.testsIo - foundations.tests.testsFoundations.testsLibrary - foundations.tests.testsFoundations.testsNamespace - foundations.tests.testsFoundations.testsNodes - foundations.tests.testsFoundations.testsParsers - foundations.tests.testsFoundations.testsPkzip - foundations.tests.testsFoundations.testsRotatingBackup - foundations.tests.testsFoundations.testsStreamObject - foundations.tests.testsFoundations.testsStrings - foundations.tests.testsFoundations.testsTcpServer - foundations.tests.testsFoundations.testsUi.testsCommon - foundations.tests.testsFoundations.testsWalkers - foundations.tests.utilities diff --git a/docs/sphinx/source/resources/pages/api/foundations.common.rst b/docs/sphinx/source/resources/pages/api/foundations.common.rst index 183e3c8..7fa57d7 100644 --- a/docs/sphinx/source/resources/pages/api/foundations.common.rst +++ b/docs/sphinx/source/resources/pages/api/foundations.common.rst @@ -19,6 +19,8 @@ Functions .. autofunction:: getFirstItem +.. autofunction:: getLastItem + .. autofunction:: isBinaryFile .. autofunction:: repeat diff --git a/docs/sphinx/source/resources/pages/api/foundations.namespace.rst b/docs/sphinx/source/resources/pages/api/foundations.namespace.rst index 45349b7..35b2aa1 100644 --- a/docs/sphinx/source/resources/pages/api/foundations.namespace.rst +++ b/docs/sphinx/source/resources/pages/api/foundations.namespace.rst @@ -19,3 +19,7 @@ Functions .. autofunction:: removeNamespace +.. autofunction:: getRoot + +.. autofunction:: getLeaf + diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.tests.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.tests.rst deleted file mode 100644 index f4cd4b7..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.tests.rst +++ /dev/null @@ -1,10 +0,0 @@ -_`foundations.tests.tests` -========================== - -.. automodule:: foundations.tests.tests - -Functions ---------- - -.. autofunction:: testsSuite - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsCache.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsCache.rst deleted file mode 100644 index 191cf87..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsCache.rst +++ /dev/null @@ -1,12 +0,0 @@ -_`foundations.tests.testsFoundations.testsCache` -================================================ - -.. automodule:: foundations.tests.testsFoundations.testsCache - -Classes -------- - -.. autoclass:: CacheTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsCommon.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsCommon.rst deleted file mode 100644 index 0cc3b9e..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsCommon.rst +++ /dev/null @@ -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: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsCore.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsCore.rst deleted file mode 100644 index e03549c..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsCore.rst +++ /dev/null @@ -1,32 +0,0 @@ -_`foundations.tests.testsFoundations.testsCore` -=============================================== - -.. automodule:: foundations.tests.testsFoundations.testsCore - -Classes -------- - -.. autoclass:: StandardMessageHookTestCase - :show-inheritance: - :members: - -.. autoclass:: SetVerbosityLevelTestCase - :show-inheritance: - :members: - -.. autoclass:: GetFrameTestCase - :show-inheritance: - :members: - -.. autoclass:: GetCodeLayerNameTestCase - :show-inheritance: - :members: - -.. autoclass:: GetModuleTestCase - :show-inheritance: - :members: - -.. autoclass:: GetTraceNameTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsDataStructures.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsDataStructures.rst deleted file mode 100644 index 5e0ec8f..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsDataStructures.rst +++ /dev/null @@ -1,24 +0,0 @@ -_`foundations.tests.testsFoundations.testsDataStructures` -========================================================= - -.. automodule:: foundations.tests.testsFoundations.testsDataStructures - -Classes -------- - -.. autoclass:: NestedAttributeTestCase - :show-inheritance: - :members: - -.. autoclass:: StructureTestCase - :show-inheritance: - :members: - -.. autoclass:: OrderedStructureTestCase - :show-inheritance: - :members: - -.. autoclass:: LookupTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsEnvironment.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsEnvironment.rst deleted file mode 100644 index 7095e61..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsEnvironment.rst +++ /dev/null @@ -1,20 +0,0 @@ -_`foundations.tests.testsFoundations.testsEnvironment` -====================================================== - -.. automodule:: foundations.tests.testsFoundations.testsEnvironment - -Classes -------- - -.. autoclass:: EnvironmentTestCase - :show-inheritance: - :members: - -.. autoclass:: GetSystemApplicationDataDirectoryTestCase - :show-inheritance: - :members: - -.. autoclass:: GetUserApplicationDataDirectoryTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsExceptions.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsExceptions.rst deleted file mode 100644 index 96184e9..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsExceptions.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`foundations.tests.testsFoundations.testsExceptions` -===================================================== - -.. automodule:: foundations.tests.testsFoundations.testsExceptions - -Module Attributes ------------------ - -.. attribute:: foundations.tests.testsFoundations.testsExceptions.EXCEPTIONS - -Classes -------- - -.. autoclass:: ExceptionsTestCase - :show-inheritance: - :members: - -.. autoclass:: AttributeStructureParsingErrorTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsGlobals.testsConstants.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsGlobals.testsConstants.rst deleted file mode 100644 index 0a1e517..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsGlobals.testsConstants.rst +++ /dev/null @@ -1,12 +0,0 @@ -_`foundations.tests.testsFoundations.testsGlobals.testsConstants` -================================================================= - -.. automodule:: foundations.tests.testsFoundations.testsGlobals.testsConstants - -Classes -------- - -.. autoclass:: ConstantsTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsIo.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsIo.rst deleted file mode 100644 index f7d889e..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsIo.rst +++ /dev/null @@ -1,33 +0,0 @@ -_`foundations.tests.testsFoundations.testsIo` -============================================= - -.. automodule:: foundations.tests.testsFoundations.testsIo - -Module Attributes ------------------ - -.. attribute:: foundations.tests.testsFoundations.testsIo.RESOURCES_DIRECTORY - -.. attribute:: foundations.tests.testsFoundations.testsIo.TEST_FILE - -.. attribute:: foundations.tests.testsFoundations.testsIo.FILE_CONTENT - -Classes -------- - -.. autoclass:: FileTestCase - :show-inheritance: - :members: - -.. autoclass:: SetDirectoryTestCase - :show-inheritance: - :members: - -.. autoclass:: CopyTestCase - :show-inheritance: - :members: - -.. autoclass:: RemoveTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsLibrary.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsLibrary.rst deleted file mode 100644 index ae157e9..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsLibrary.rst +++ /dev/null @@ -1,25 +0,0 @@ -_`foundations.tests.testsFoundations.testsLibrary` -================================================== - -.. automodule:: foundations.tests.testsFoundations.testsLibrary - -Module Attributes ------------------ - -.. attribute:: foundations.tests.testsFoundations.testsLibrary.RESOURCES_DIRECTORY - -.. attribute:: foundations.tests.testsFoundations.testsLibrary.LIBRARIES_DIRECTORY - -.. attribute:: foundations.tests.testsFoundations.testsLibrary.LIBRARIES - -.. attribute:: foundations.tests.testsFoundations.testsLibrary.LIBRARIES_FUNCTIONS - -.. attribute:: foundations.tests.testsFoundations.testsLibrary.LIBRARIES_TESTS_CASES - -Classes -------- - -.. autoclass:: LibraryTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsNamespace.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsNamespace.rst deleted file mode 100644 index 963d0fe..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsNamespace.rst +++ /dev/null @@ -1,20 +0,0 @@ -_`foundations.tests.testsFoundations.testsNamespace` -==================================================== - -.. automodule:: foundations.tests.testsFoundations.testsNamespace - -Classes -------- - -.. autoclass:: SetNamespaceTestCase - :show-inheritance: - :members: - -.. autoclass:: GetNamespaceTestCase - :show-inheritance: - :members: - -.. autoclass:: RemoveNamespaceTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsNodes.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsNodes.rst deleted file mode 100644 index 81927d2..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsNodes.rst +++ /dev/null @@ -1,20 +0,0 @@ -_`foundations.tests.testsFoundations.testsNodes` -================================================ - -.. automodule:: foundations.tests.testsFoundations.testsNodes - -Classes -------- - -.. autoclass:: AttributeTestCase - :show-inheritance: - :members: - -.. autoclass:: AbstractNodeTestCase - :show-inheritance: - :members: - -.. autoclass:: AbstractCompositeNodeTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsParsers.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsParsers.rst deleted file mode 100644 index cacea44..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsParsers.rst +++ /dev/null @@ -1,61 +0,0 @@ -_`foundations.tests.testsFoundations.testsParsers` -================================================== - -.. automodule:: foundations.tests.testsFoundations.testsParsers - -Module Attributes ------------------ - -.. attribute:: foundations.tests.testsFoundations.testsParsers.RESOURCES_DIRECTORY - -.. attribute:: foundations.tests.testsFoundations.testsParsers.COMPONENT_FILE - -.. attribute:: foundations.tests.testsFoundations.testsParsers.IBL_SET_FILE - -.. attribute:: foundations.tests.testsFoundations.testsParsers.TEMPLATE_FILE - -.. attribute:: foundations.tests.testsFoundations.testsParsers.DEFAULTS_FILE - -.. attribute:: foundations.tests.testsFoundations.testsParsers.STRIPPING_FILE - -.. attribute:: foundations.tests.testsFoundations.testsParsers.PARSING_ERRORS_FILE - -.. attribute:: foundations.tests.testsFoundations.testsParsers.PLIST_FILE - -.. attribute:: foundations.tests.testsFoundations.testsParsers.STANDARD_FILES - -.. attribute:: foundations.tests.testsFoundations.testsParsers.STANDARD_FILES_RAW_SECTIONS - -.. attribute:: foundations.tests.testsFoundations.testsParsers.STANDARD_FILES_SECTIONS_AND_ATTRIBUTES - -.. attribute:: foundations.tests.testsFoundations.testsParsers.DEFAULTS_FILE_SECTIONS_AND_ATTRIBUTES - -.. attribute:: foundations.tests.testsFoundations.testsParsers.STRIPPING_FILE_SECTIONS_AND_ATTRIBUTES_STRIPPED - -.. attribute:: foundations.tests.testsFoundations.testsParsers.STRIPPING_FILE_SECTIONS_AND_ATTRIBUTES_NON_STRIPPED - -.. attribute:: foundations.tests.testsFoundations.testsParsers.PARSING_ERRORS_LINES_AND_VALUES - -.. attribute:: foundations.tests.testsFoundations.testsParsers.RANDOM_ATTRIBUTES - -.. attribute:: foundations.tests.testsFoundations.testsParsers.RANDOM_COMMENTS - -.. attribute:: foundations.tests.testsFoundations.testsParsers.SCRIPT_RAW_SECTION - -.. attribute:: foundations.tests.testsFoundations.testsParsers.PLIST_FILE_CONTENT - -Classes -------- - -.. autoclass:: SectionsFileParserTestCase - :show-inheritance: - :members: - -.. autoclass:: PlistFileParserTestCase - :show-inheritance: - :members: - -.. autoclass:: GetAttributeCompoundTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsPkzip.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsPkzip.rst deleted file mode 100644 index 4bdfb2a..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsPkzip.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`foundations.tests.testsFoundations.testsPkzip` -================================================ - -.. automodule:: foundations.tests.testsFoundations.testsPkzip - -Module Attributes ------------------ - -.. attribute:: foundations.tests.testsFoundations.testsPkzip.RESOURCES_DIRECTORY - -.. attribute:: foundations.tests.testsFoundations.testsPkzip.TEST_FILE - -.. attribute:: foundations.tests.testsFoundations.testsPkzip.TREE_HIERARCHY - -Classes -------- - -.. autoclass:: PkzipTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsRotatingBackup.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsRotatingBackup.rst deleted file mode 100644 index 080657a..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsRotatingBackup.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`foundations.tests.testsFoundations.testsRotatingBackup` -========================================================= - -.. automodule:: foundations.tests.testsFoundations.testsRotatingBackup - -Module Attributes ------------------ - -.. attribute:: foundations.tests.testsFoundations.testsRotatingBackup.RESOURCES_DIRECTORY - -.. attribute:: foundations.tests.testsFoundations.testsRotatingBackup.TEST_FILE - -.. attribute:: foundations.tests.testsFoundations.testsRotatingBackup.TEST_DIRECTORY - -Classes -------- - -.. autoclass:: RotatingBackupTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsStreamObject.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsStreamObject.rst deleted file mode 100644 index 2ea4976..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsStreamObject.rst +++ /dev/null @@ -1,12 +0,0 @@ -_`foundations.tests.testsFoundations.testsStreamObject` -======================================================= - -.. automodule:: foundations.tests.testsFoundations.testsStreamObject - -Classes -------- - -.. autoclass:: StreamObjectTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsStrings.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsStrings.rst deleted file mode 100644 index 6f5bde3..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsStrings.rst +++ /dev/null @@ -1,72 +0,0 @@ -_`foundations.tests.testsFoundations.testsStrings` -================================================== - -.. automodule:: foundations.tests.testsFoundations.testsStrings - -Classes -------- - -.. autoclass:: EncodeTestCase - :show-inheritance: - :members: - -.. autoclass:: GetNiceNameTestCase - :show-inheritance: - :members: - -.. autoclass:: GetVersionRankTestCase - :show-inheritance: - :members: - -.. autoclass:: GetSplitextBasenameTestCase - :show-inheritance: - :members: - -.. autoclass:: GetCommonAncestorTestCase - :show-inheritance: - :members: - -.. autoclass:: GetCommonPathsAncestorTestCase - :show-inheritance: - :members: - -.. autoclass:: GetWordsTestCase - :show-inheritance: - :members: - -.. autoclass:: FilterWordsTestCase - :show-inheritance: - :members: - -.. autoclass:: ReplaceTestCase - :show-inheritance: - :members: - -.. autoclass:: RemoveStripTestCase - :show-inheritance: - :members: - -.. autoclass:: ToForwardSlashesTestCase - :show-inheritance: - :members: - -.. autoclass:: ToBackwardSlashesTestCase - :show-inheritance: - :members: - -.. autoclass:: ToPosixPathTestCase - :show-inheritance: - :members: - -.. autoclass:: GetNormalizedPathTestCase - :show-inheritance: - :members: - -.. autoclass:: IsEmailTestCase - :show-inheritance: - :members: - -.. autoclass:: IsWebsiteTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsTcpServer.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsTcpServer.rst deleted file mode 100644 index dc1d117..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsTcpServer.rst +++ /dev/null @@ -1,16 +0,0 @@ -_`foundations.tests.testsFoundations.testsTcpServer` -==================================================== - -.. automodule:: foundations.tests.testsFoundations.testsTcpServer - -Classes -------- - -.. autoclass:: TCPServerTestCase - :show-inheritance: - :members: - -.. autoclass:: EchoRequestsHandlerTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsUi.testsCommon.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsUi.testsCommon.rst deleted file mode 100644 index e293526..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsUi.testsCommon.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`foundations.tests.testsFoundations.testsUi.testsCommon` -========================================================= - -.. automodule:: foundations.tests.testsFoundations.testsUi.testsCommon - -Module Attributes ------------------ - -.. attribute:: foundations.tests.testsFoundations.testsUi.testsCommon.RESOURCES_DIRECTORY - -.. attribute:: foundations.tests.testsFoundations.testsUi.testsCommon.UI_TESTS_FILE - -Classes -------- - -.. autoclass:: QWidgetFactoryTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsWalkers.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsWalkers.rst deleted file mode 100644 index 2ac8225..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsWalkers.rst +++ /dev/null @@ -1,35 +0,0 @@ -_`foundations.tests.testsFoundations.testsWalkers` -================================================== - -.. automodule:: foundations.tests.testsFoundations.testsWalkers - -Module Attributes ------------------ - -.. attribute:: foundations.tests.testsFoundations.testsWalkers.RESOURCES_DIRECTORY - -.. attribute:: foundations.tests.testsFoundations.testsWalkers.ROOT_DIRECTORY - -.. attribute:: foundations.tests.testsFoundations.testsWalkers.FILES_TREE_HIERARCHY - -.. attribute:: foundations.tests.testsFoundations.testsWalkers.TREE_HIERARCHY - -Classes -------- - -.. autoclass:: FilesWalkerTestCase - :show-inheritance: - :members: - -.. autoclass:: DepthWalkerTestCase - :show-inheritance: - :members: - -.. autoclass:: DictionariesWalkerTestCase - :show-inheritance: - :members: - -.. autoclass:: NodesWalkerTestCase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tests.utilities.rst b/docs/sphinx/source/resources/pages/api/foundations.tests.utilities.rst deleted file mode 100644 index a776ac5..0000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tests.utilities.rst +++ /dev/null @@ -1,12 +0,0 @@ -_`foundations.tests.utilities` -============================== - -.. automodule:: foundations.tests.utilities - -Module Attributes ------------------ - -.. attribute:: foundations.tests.utilities.LOGGER - -.. attribute:: foundations.tests.utilities.LOGGING_CONSOLE_HANDLER - diff --git a/docs/sphinx/source/resources/pages/changes.rst b/docs/sphinx/source/resources/pages/changes.rst index 61b51bb..daea3af 100644 --- a/docs/sphinx/source/resources/pages/changes.rst +++ b/docs/sphinx/source/resources/pages/changes.rst @@ -1,9 +1,52 @@ -_`Changes` -========== +Changes +======= -**Foundations - Changes**: Change_Log.html +2.0.2 - Stable +-------------- -.. raw:: html +- 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 +-------------- + +- Prevented memory leak in "foundations.dataStuctures.Structure" class. + +2.0.0 - Stable +-------------- + +- Major package refactor. +- Added "cache", "dag", "dataStructures" modules and associated units tests module. + +1.0.4 - Stable +-------------- + +- Reorganize package directories structure. +- Added "rotatingBackup" module and associated "testsRotatingBackup" units tests module. + +1.0.3 - Stable +-------------- + +- Ensured that the parser will split attributes only one time. +- Added "toPosixPath" method to "strings" module and associated units tests. + +1.0.2 - Stable +-------------- + +- Added "getWords" and "filterWords" methods to "strings" module and associated units tests. +- Implemented "filterWords" in "walkers" module. +- Added "getSplitextBasename" definition to "strings" module and associated units tests to "testsStrings" module. +- Replaced list comprehension expressions by generators. + +1.0.1 - Stable +-------------- + +- Added "namespace" module and associated "testsGlobals" units tests module. + +1.0.0 - Stable +-------------- + +- Initial Release of Foundations. diff --git a/docs/sphinx/source/resources/pages/installation.rst b/docs/sphinx/source/resources/pages/installation.rst index 8753aa7..f882323 100644 --- a/docs/sphinx/source/resources/pages/installation.rst +++ b/docs/sphinx/source/resources/pages/installation.rst @@ -1,6 +1,19 @@ _`Installation` =============== +To install **Foundations** from the `Python Package Index `_ 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 `_ source repository:: + + git clone git://github.com/KelSolaar/Foundations.git + python setup.py install + .. raw:: html
    diff --git a/docs/sphinx/source/resources/pages/introduction.rst b/docs/sphinx/source/resources/pages/introduction.rst index 81fdcd4..7b84953 100644 --- a/docs/sphinx/source/resources/pages/introduction.rst +++ b/docs/sphinx/source/resources/pages/introduction.rst @@ -1,7 +1,7 @@ _`Introduction` =============== -Foundations is the core package of `Umbra `_, `sIBL_GUI `_, `sIBL_Reporter `_ and others tools. +**Foundations** is the core package of `Umbra `_, `sIBL_GUI `_, `sIBL_Reporter `_. It provides modules defining various utilities classes and definitions used in those packages. .. raw:: html diff --git a/docs/sphinx/source/resources/pages/usage.rst b/docs/sphinx/source/resources/pages/usage.rst index c49816c..6e09e48 100644 --- a/docs/sphinx/source/resources/pages/usage.rst +++ b/docs/sphinx/source/resources/pages/usage.rst @@ -1,7 +1,7 @@ _`Usage` ======== -Given the large spectrum of the objects defined in **Foundations** package, please refer to the Api ( `Foundations - Api `_ ) 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 `_ for precise usage examples about each modules. Here are listed a few non exhaustive usage examples. - foundations.dataStructures.Structure: diff --git a/setup.py b/setup.py index 51c5f68..632a71f 100644 --- a/setup.py +++ b/setup.py @@ -3,15 +3,39 @@ from setuptools import setup from setuptools import find_packages +def getLongDescription(): + """ + This definition returns the Package long description. + + :return: Package long description. ( String ) + """ + + description = str() + with open("README.rst") as file: + for line in file: + if ".. code:: python" in line: + continue + + description += line + return description + setup(name=foundations.globals.constants.Constants.applicationName, version=foundations.globals.constants.Constants.releaseVersion, author=foundations.globals.constants.__author__, author_email=foundations.globals.constants.__email__, + include_package_data=True, packages=find_packages(), scripts=[], url="https://github.com/KelSolaar/Foundations", - license="GPL v3", + license="GPLv3", description="Foundations is the core package of Umbra, sIBL_GUI, sIBL_Reporter.", - long_description=open("README.rst").read(), + long_description=getLongDescription(), install_requires=[], - include_package_data=True) + classifiers=["Development Status :: 5 - Production/Stable", + "Environment :: Console", + "Intended Audience :: Developers", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Natural Language :: English", + "Operating System :: OS Independent", + "Programming Language :: Python :: 2.7", + "Topic :: Utilities"]) diff --git a/utilities/gatherFiles.sh b/utilities/gatherFiles.sh new file mode 100755 index 0000000..58be4b0 --- /dev/null +++ b/utilities/gatherFiles.sh @@ -0,0 +1,25 @@ +#/bin/bash +echo ------------------------------------------------------------------------------- +echo Foundations - Files Gathering +echo ------------------------------------------------------------------------------- + +export PROJECT=$( dirname "${BASH_SOURCE[0]}" )/.. + +export DOCUMENTATION=$PROJECT/docs/ +export RELEASES=$PROJECT/releases/ +export REPOSITORY=$RELEASES/repository/ +export UTILITIES=$PROJECT/utilities + +#! Gathering folder cleanup. +rm -rf $REPOSITORY +mkdir -p $REPOSITORY/Foundations + +#! Foundations Changes gathering. +cp -rf $RELEASES/Changes.html $REPOSITORY/Foundations/ + +#! Foundations Manual / Help files. +cp -rf $DOCUMENTATION/help $REPOSITORY/Foundations/Help +rm $REPOSITORY/Foundations/help/Foundations_Manual.rst + +#! Foundations Api files. +cp -rf $DOCUMENTATION/sphinx/build/html $REPOSITORY/Foundations/Api \ No newline at end of file diff --git a/utilities/getDocumentation.sh b/utilities/getDocumentation.sh index 7e8de02..bfdaebf 100755 --- a/utilities/getDocumentation.sh +++ b/utilities/getDocumentation.sh @@ -24,6 +24,7 @@ echo --------------------------------------------------------------------------- echo Sphinx Documentation Build - Begin echo ------------------------------------------------------------------------------- python $UTILITIES/sliceDocumentation.py "$HELP/Foundations_Manual.rst" "$SPHINX/source/resources/pages" +python $UTILITIES/sliceDocumentation.py "$PROJECT/CHANGES.rst" "$SPHINX/source/resources/pages" python $UTILITIES/getSphinxDocumentationTocTree.py "Foundations" "$SPHINX/source/resources/pages/tocTree.rst" "$SPHINX/source/index.rst" "$SPHINX/source/resources/pages" rm -rf $SPHINX/build rm -rf $SPHINX/source/resources/packages diff --git a/utilities/getSphinxDocumentationApi.py b/utilities/getSphinxDocumentationApi.py index 92a2fb3..a2c040f 100644 --- a/utilities/getSphinxDocumentationApi.py +++ b/utilities/getSphinxDocumentationApi.py @@ -81,7 +81,7 @@ TOCTREE_TEMPLATE_END = [] -EXCLUDED_PYTHON_MODULES = () +EXCLUDED_PYTHON_MODULES = ("tests",) STATEMENTS_UPDATE_MESSAGGE = "#**********************************************************************************************************************\n" \ "#***\tSphinx: Statements updated for auto-documentation purpose.\n" \