Main Reference

The ciowarehouse Module

CioWarehouse module: a Chrysalio add-on to manage digital warehouses.

ciowarehouse.includeme(configurator)

Function to include CioWarehouse module.

Parameters:

configurator (pyramid.config.Configurator) – Object used to do configuration declaration within the application.

class ciowarehouse.ModuleCioWarehouse(config_ini)

Class for CioWarehouse module.

Parameters:

config_ini (str) – Absolute path to the configuration file (e.g. development.ini).

This module has the following attributes:

• locations: a dictionary of absolute paths of root directories

• restful: a dictionary defining the RESTful parameters

populate(args, registry, dbsession)

Method called by populate script to complete the operation.

See: chrysalio.modules.Module.populate()

activate(registry, dbsession)

Method to activate the module.

See: chrysalio.modules.Module.activate()

deactivate(registry, dbsession)

Method to deactivate the module.

See: chrysalio.modules.Module.deactivate()

configuration_route(request)

Return the route to configure this module.

Parameters:

request (pyramid.request.Request) – Current request.

warehouse_access(request, item, *args, **kwargs)

Use of user cache.

warehouse(request, item_id, *args, **kwargs)

Use of global cache.

warehouse_admin(request, warehouse, access=None)

Return True if the user administrates the warehouse.

Parameters:

• request (pyramid.request.Request) – Current request.

• warehouse (lib.warehouse.Warehouse) – Current warehouse object..

• access (tuple) – (optional) Already retrieved access tuple.

Return type:

bool

warehouse_file_writer(request, warehouse, access=None)

Return True if the user can write files in this warehouse.

Parameters:

• request (pyramid.request.Request) – Current request.

• warehouse (lib.warehouse.Warehouse) – Current warehouse object.

• access (tuple) – (optional) Already retrieved access tuple.

Return type:

bool

warehouse_meta_writer(request, warehouse, access=None)

Return True if the user can write metadata in this warehouse.

Parameters:

• request (pyramid.request.Request) – Current request.

• warehouse (lib.warehouse.Warehouse) – Current warehouse object.

• access (tuple) – (optional) Already retrieved access tuple.

Return type:

bool

warehouse_root(request, warehouse_id)

Return the root directory of the warehouse with ID warehouse_id or None.

Parameters:

• request (pyramid.request.Request) – Current request.

• warehouse_id (str) – ID of the warehouse to return.

Return type:

str

warehouse_forget(request, warehouse_id=None)

Remove warehouse from list.

Parameters:

• request (pyramid.request.Request) – Current request.

• warehouse_id (str) – (optional) ID of the warehouse to forget.

classmethod cache_clear(request, warehouse_id)

Clear file and metadata cache for a warehouse.

Parameters:

• request (pyramid.request.Request) – Current request.

• warehouse_id (str) – ID of the warehouse.

classmethod metafields(registry, dbsession)

Return a dictionary where each key is a metadata field ID and each entry a dictionary with keys 'label', 'type' and possibly 'choices'.

Parameters:

• registry (pyramid.registry.Registry) – Application registry.

• dbsession (sqlalchemy.orm.session.Session) – SQLAlchemy session.

Return type:

dict

classmethod indexfields(registry, dbsession)

Return a dictionary where each key is an index field ID and each entry a dictionary with keys 'label', 'field_type', 'whoosh_type', 'in_condition' and 'in_result'.

Parameters:

• registry (pyramid.registry.Registry) – Application registry.

• dbsession (sqlalchemy.orm.session.Session) – SQLAlchemy session.

Return type:

dict

The ciowarehouse.routes Module

CioWarehouse route definitions.

ciowarehouse.routes.includeme(configurator)

Function to include routes.

Parameters:

configurator (pyramid.config.Configurator) – Object used to do configuration declaration within the application.

The ciowarehouse.security Module

CioWarehouses secutity functionalities.

ciowarehouse.security.includeme(configurator)

Function to include security.

Parameters:

configurator (pyramid.config.Configurator) – Object used to do configuration declaration within the application.