Added files missing dev-dc
authorDamien Correia
Mon, 26 Mar 2018 17:48:15 +0200
branchdev-dc
changeset 31 d8f323bf5c7e
parent 30 5798c437f5ca
child 32 fd15bdd3192e
Added files missing
src/source/alchemy/pyams_alchemy.interfaces.rst
src/source/alchemy/pyams_alchemy.rst
src/source/alchemy/pyams_alchemy.tests.rst
src/source/alchemy/pyams_alchemy.zmi.rst
src/source/cache/pyams_cache.handler.rst
src/source/cache/pyams_cache.interfaces.rst
src/source/cache/pyams_cache.rst
src/source/cache/pyams_cache.tests.rst
src/source/catalogue/pyams_catalog.interfaces.rst
src/source/catalogue/pyams_catalog.rst
src/source/pyams_alchemy.interfaces.rst
src/source/pyams_alchemy.rst
src/source/pyams_alchemy.tests.rst
src/source/pyams_alchemy.zmi.rst
src/source/pyams_cache.handler.rst
src/source/pyams_cache.interfaces.rst
src/source/pyams_cache.rst
src/source/pyams_cache.tests.rst
src/source/pyams_catalog.interfaces.rst
src/source/pyams_catalog.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/alchemy/pyams_alchemy.interfaces.rst	Mon Mar 26 17:48:15 2018 +0200
@@ -0,0 +1,10 @@
+pyams\_alchemy\.interfaces package
+==================================
+
+Module contents
++++++++++++++++
+
+.. automodule:: pyams_alchemy.interfaces
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/alchemy/pyams_alchemy.rst	Mon Mar 26 17:48:15 2018 +0200
@@ -0,0 +1,91 @@
+.. _pyams_alchemy:
+
+PyAMS SQLAlchemy integration
+============================
+
+*pyams_alchemy* package is a small package which can be used to make SQLAlchemy integration more simple.
+
+The main goal of *pyams_alchemy* package is to define the :class:`pyams_alchemy.engine.AlchemyEngineUtility` class:
+this class can be stored persistently into PyAMS local site manager (see :ref:`site`) to store settings of an
+SQLAlchemy engine; on user request, the :func:`pyams_alchemy.engine.get_user_session` function can be used to get
+access to a new SQLAlchemy engine session matching these settings which will to be bound to current Pyramid's
+transaction.
+
+
+Dynamic schema names
+++++++++++++++++++++
+
+Some times you may have to be able to setup, for a given table, a schema name which is not static but can be dynamic
+through a configuration option.
+
+This can be done easily with the help of the :class:`pyams_alchemy.mixin.DynamicSchemaMixin` which you can inherit from
+in any SQLAlchemy table subclass.
+
+When this is done, the schema name can be defined into Pyramid's configuration file into a setting which is called
+*pyams_alchemy:{module_name}.{class_name}.schema*; for example like in
+*pyams_alchemy:pyams_content.package.TableName.schema*. If not specified, the table's schema name can be defined in a
+classic *__schema__* table's attribute.
+
+
+
+Module contents
++++++++++++++++
+
+.. automodule:: pyams_alchemy
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Submodules
+++++++++++
+
+pyams\_alchemy\.engine module
+-----------------------------
+
+.. automodule:: pyams_alchemy.engine
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyams\_alchemy\.loader module
+-----------------------------
+
+.. automodule:: pyams_alchemy.loader
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyams\_alchemy\.metaconfigure module
+------------------------------------
+
+.. automodule:: pyams_alchemy.metaconfigure
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyams\_alchemy\.metadirectives module
+-------------------------------------
+
+.. automodule:: pyams_alchemy.metadirectives
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyams\_alchemy\.mixin module
+----------------------------
+
+.. automodule:: pyams_alchemy.mixin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Subpackages
++++++++++++
+
+.. toctree::
+
+    pyams_alchemy.interfaces
+    pyams_alchemy.tests
+    pyams_alchemy.zmi
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/alchemy/pyams_alchemy.tests.rst	Mon Mar 26 17:48:15 2018 +0200
@@ -0,0 +1,30 @@
+pyams\_alchemy\.tests package
+=============================
+
+Submodules
+++++++++++
+
+pyams\_alchemy\.tests\.test\_utilsdocs module
+---------------------------------------------
+
+.. automodule:: pyams_alchemy.tests.test_utilsdocs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyams\_alchemy\.tests\.test\_utilsdocstrings module
+---------------------------------------------------
+
+.. automodule:: pyams_alchemy.tests.test_utilsdocstrings
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: pyams_alchemy.tests
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/alchemy/pyams_alchemy.zmi.rst	Mon Mar 26 17:48:15 2018 +0200
@@ -0,0 +1,22 @@
+pyams\_alchemy\.zmi package
+===========================
+
+Submodules
+++++++++++
+
+pyams\_alchemy\.zmi\.engine module
+----------------------------------
+
+.. automodule:: pyams_alchemy.zmi.engine
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: pyams_alchemy.zmi
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/cache/pyams_cache.handler.rst	Mon Mar 26 17:48:15 2018 +0200
@@ -0,0 +1,31 @@
+pyams\_cache\.handler package
+=============================
+
+
+Module contents
++++++++++++++++
+
+.. automodule:: pyams_cache.handler
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Submodules
+++++++++++
+
+pyams\_cache\.handler\.memcached module
+---------------------------------------
+
+.. automodule:: pyams_cache.handler.memcached
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyams\_cache\.handler\.redis module
+-----------------------------------
+
+.. automodule:: pyams_cache.handler.redis
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/cache/pyams_cache.interfaces.rst	Mon Mar 26 17:48:15 2018 +0200
@@ -0,0 +1,11 @@
+pyams\_cache\.interfaces package
+================================
+
+
+Module contents
++++++++++++++++
+
+.. automodule:: pyams_cache.interfaces
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/cache/pyams_cache.rst	Mon Mar 26 17:48:15 2018 +0200
@@ -0,0 +1,51 @@
+.. _pyams_cache:
+
+PyAMS cache management
+======================
+
+
+Module contents
++++++++++++++++
+
+.. automodule:: pyams_cache
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Submodules
+++++++++++
+
+pyams\_cache\.beaker module
+---------------------------
+
+.. automodule:: pyams_cache.beaker
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyams\_cache\.cache module
+--------------------------
+
+.. automodule:: pyams_cache.cache
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyams\_cache\.include module
+----------------------------
+
+.. automodule:: pyams_cache.include
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Subpackages
++++++++++++
+
+.. toctree::
+
+    pyams_cache.handler
+    pyams_cache.interfaces
+    pyams_cache.tests
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/cache/pyams_cache.tests.rst	Mon Mar 26 17:48:15 2018 +0200
@@ -0,0 +1,31 @@
+pyams\_cache\.tests package
+===========================
+
+
+Module contents
++++++++++++++++
+
+.. automodule:: pyams_cache.tests
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Submodules
+++++++++++
+
+pyams\_cache\.tests\.test\_utilsdocs module
+-------------------------------------------
+
+.. automodule:: pyams_cache.tests.test_utilsdocs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyams\_cache\.tests\.test\_utilsdocstrings module
+-------------------------------------------------
+
+.. automodule:: pyams_cache.tests.test_utilsdocstrings
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/catalogue/pyams_catalog.interfaces.rst	Mon Mar 26 17:48:15 2018 +0200
@@ -0,0 +1,10 @@
+pyams\_catalog\.interfaces package
+==================================
+
+Module contents
+---------------
+
+.. automodule:: pyams_catalog.interfaces
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/source/catalogue/pyams_catalog.rst	Mon Mar 26 17:48:15 2018 +0200
@@ -0,0 +1,75 @@
+.. _pyams_catalog:
+
+PyAMS catalog
+=============
+
+
+Module contents
++++++++++++++++
+
+.. automodule:: pyams_catalog
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Subpackages
++++++++++++
+
+.. toctree::
+
+    pyams_catalog.interfaces
+    pyams_catalog.tests
+    pyams_catalog.zmi
+
+
+Submodules
+++++++++++
+
+pyams\_catalog\.include module
+------------------------------
+
+.. automodule:: pyams_catalog.include
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyams\_catalog\.index module
+----------------------------
+
+.. automodule:: pyams_catalog.index
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyams\_catalog\.nltk module
+---------------------------
+
+.. automodule:: pyams_catalog.nltk
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyams\_catalog\.query module
+----------------------------
+
+.. automodule:: pyams_catalog.query
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyams\_catalog\.site module
+---------------------------
+
+.. automodule:: pyams_catalog.site
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyams\_catalog\.utils module
+----------------------------
+
+.. automodule:: pyams_catalog.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
--- a/src/source/pyams_alchemy.interfaces.rst	Mon Mar 26 17:29:25 2018 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,10 +0,0 @@
-pyams\_alchemy\.interfaces package
-==================================
-
-Module contents
-+++++++++++++++
-
-.. automodule:: pyams_alchemy.interfaces
-    :members:
-    :undoc-members:
-    :show-inheritance:
--- a/src/source/pyams_alchemy.rst	Mon Mar 26 17:29:25 2018 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,91 +0,0 @@
-.. _pyams_alchemy:
-
-PyAMS SQLAlchemy integration
-============================
-
-*pyams_alchemy* package is a small package which can be used to make SQLAlchemy integration more simple.
-
-The main goal of *pyams_alchemy* package is to define the :class:`pyams_alchemy.engine.AlchemyEngineUtility` class:
-this class can be stored persistently into PyAMS local site manager (see :ref:`site`) to store settings of an
-SQLAlchemy engine; on user request, the :func:`pyams_alchemy.engine.get_user_session` function can be used to get
-access to a new SQLAlchemy engine session matching these settings which will to be bound to current Pyramid's
-transaction.
-
-
-Dynamic schema names
-++++++++++++++++++++
-
-Some times you may have to be able to setup, for a given table, a schema name which is not static but can be dynamic
-through a configuration option.
-
-This can be done easily with the help of the :class:`pyams_alchemy.mixin.DynamicSchemaMixin` which you can inherit from
-in any SQLAlchemy table subclass.
-
-When this is done, the schema name can be defined into Pyramid's configuration file into a setting which is called
-*pyams_alchemy:{module_name}.{class_name}.schema*; for example like in
-*pyams_alchemy:pyams_content.package.TableName.schema*. If not specified, the table's schema name can be defined in a
-classic *__schema__* table's attribute.
-
-
-
-Module contents
-+++++++++++++++
-
-.. automodule:: pyams_alchemy
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Submodules
-++++++++++
-
-pyams\_alchemy\.engine module
------------------------------
-
-.. automodule:: pyams_alchemy.engine
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyams\_alchemy\.loader module
------------------------------
-
-.. automodule:: pyams_alchemy.loader
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyams\_alchemy\.metaconfigure module
-------------------------------------
-
-.. automodule:: pyams_alchemy.metaconfigure
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyams\_alchemy\.metadirectives module
--------------------------------------
-
-.. automodule:: pyams_alchemy.metadirectives
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyams\_alchemy\.mixin module
-----------------------------
-
-.. automodule:: pyams_alchemy.mixin
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Subpackages
-+++++++++++
-
-.. toctree::
-
-    pyams_alchemy.interfaces
-    pyams_alchemy.tests
-    pyams_alchemy.zmi
--- a/src/source/pyams_alchemy.tests.rst	Mon Mar 26 17:29:25 2018 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,30 +0,0 @@
-pyams\_alchemy\.tests package
-=============================
-
-Submodules
-++++++++++
-
-pyams\_alchemy\.tests\.test\_utilsdocs module
----------------------------------------------
-
-.. automodule:: pyams_alchemy.tests.test_utilsdocs
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyams\_alchemy\.tests\.test\_utilsdocstrings module
----------------------------------------------------
-
-.. automodule:: pyams_alchemy.tests.test_utilsdocstrings
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: pyams_alchemy.tests
-    :members:
-    :undoc-members:
-    :show-inheritance:
--- a/src/source/pyams_alchemy.zmi.rst	Mon Mar 26 17:29:25 2018 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,22 +0,0 @@
-pyams\_alchemy\.zmi package
-===========================
-
-Submodules
-++++++++++
-
-pyams\_alchemy\.zmi\.engine module
-----------------------------------
-
-.. automodule:: pyams_alchemy.zmi.engine
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: pyams_alchemy.zmi
-    :members:
-    :undoc-members:
-    :show-inheritance:
--- a/src/source/pyams_cache.handler.rst	Mon Mar 26 17:29:25 2018 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,31 +0,0 @@
-pyams\_cache\.handler package
-=============================
-
-
-Module contents
-+++++++++++++++
-
-.. automodule:: pyams_cache.handler
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Submodules
-++++++++++
-
-pyams\_cache\.handler\.memcached module
----------------------------------------
-
-.. automodule:: pyams_cache.handler.memcached
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyams\_cache\.handler\.redis module
------------------------------------
-
-.. automodule:: pyams_cache.handler.redis
-    :members:
-    :undoc-members:
-    :show-inheritance:
--- a/src/source/pyams_cache.interfaces.rst	Mon Mar 26 17:29:25 2018 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,11 +0,0 @@
-pyams\_cache\.interfaces package
-================================
-
-
-Module contents
-+++++++++++++++
-
-.. automodule:: pyams_cache.interfaces
-    :members:
-    :undoc-members:
-    :show-inheritance:
--- a/src/source/pyams_cache.rst	Mon Mar 26 17:29:25 2018 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,51 +0,0 @@
-.. _pyams_cache:
-
-PyAMS cache management
-======================
-
-
-Module contents
-+++++++++++++++
-
-.. automodule:: pyams_cache
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Submodules
-++++++++++
-
-pyams\_cache\.beaker module
----------------------------
-
-.. automodule:: pyams_cache.beaker
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyams\_cache\.cache module
---------------------------
-
-.. automodule:: pyams_cache.cache
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyams\_cache\.include module
-----------------------------
-
-.. automodule:: pyams_cache.include
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Subpackages
-+++++++++++
-
-.. toctree::
-
-    pyams_cache.handler
-    pyams_cache.interfaces
-    pyams_cache.tests
--- a/src/source/pyams_cache.tests.rst	Mon Mar 26 17:29:25 2018 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,31 +0,0 @@
-pyams\_cache\.tests package
-===========================
-
-
-Module contents
-+++++++++++++++
-
-.. automodule:: pyams_cache.tests
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Submodules
-++++++++++
-
-pyams\_cache\.tests\.test\_utilsdocs module
--------------------------------------------
-
-.. automodule:: pyams_cache.tests.test_utilsdocs
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyams\_cache\.tests\.test\_utilsdocstrings module
--------------------------------------------------
-
-.. automodule:: pyams_cache.tests.test_utilsdocstrings
-    :members:
-    :undoc-members:
-    :show-inheritance:
--- a/src/source/pyams_catalog.interfaces.rst	Mon Mar 26 17:29:25 2018 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,10 +0,0 @@
-pyams\_catalog\.interfaces package
-==================================
-
-Module contents
----------------
-
-.. automodule:: pyams_catalog.interfaces
-    :members:
-    :undoc-members:
-    :show-inheritance:
--- a/src/source/pyams_catalog.rst	Mon Mar 26 17:29:25 2018 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,75 +0,0 @@
-.. _pyams_catalog:
-
-PyAMS catalog
-=============
-
-
-Module contents
-+++++++++++++++
-
-.. automodule:: pyams_catalog
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Subpackages
-+++++++++++
-
-.. toctree::
-
-    pyams_catalog.interfaces
-    pyams_catalog.tests
-    pyams_catalog.zmi
-
-
-Submodules
-++++++++++
-
-pyams\_catalog\.include module
-------------------------------
-
-.. automodule:: pyams_catalog.include
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyams\_catalog\.index module
-----------------------------
-
-.. automodule:: pyams_catalog.index
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyams\_catalog\.nltk module
----------------------------
-
-.. automodule:: pyams_catalog.nltk
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyams\_catalog\.query module
-----------------------------
-
-.. automodule:: pyams_catalog.query
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyams\_catalog\.site module
----------------------------
-
-.. automodule:: pyams_catalog.site
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyams\_catalog\.utils module
-----------------------------
-
-.. automodule:: pyams_catalog.utils
-    :members:
-    :undoc-members:
-    :show-inheritance: