.. _guide_module:

Creating a New Module
=====================

Creation
--------

To create a new module for `Chrysalio`, you simply type the following command
and answer the questions:

.. code-block:: bash

    (virtualenv3)$ pip install cookiecutter
    (virtualenv3)$ cookiecutter http://cookiecutter.chrysal.io/cookiecutter-chrysalio-module.zip

Your freshly created module is ready for service, file handler and theme
creation.

Services
--------

In the directory ``services``, you will find an example of service. Use this
skeleton to create your own service.

File Handler
------------

In the directory ``handlers``, you will find an example of file handler. Use
this skeleton to create your own file handler.

Themes
------

`Chrysalio` supports changing the appearance of its HTML output via themes. A
theme is a collection of `Chameleon
<https://chameleon.readthedocs.io/en/latest/>`_ templates, stylesheets and
other static files as images.

Additionally, it has a configuration file, ``theme.conf`` which determines the
location of templates, in its section ``[Templates]`` and static files in its
section ``[Static]``.

To install your new theme, simply add the path of its parent directory to the
``theme.roots`` entry of your application INI file and the name of its
directory to the ``theme.patterns`` entry.