summaryrefslogblamecommitdiffstatshomepage
path: root/docs/plugins/index.rst
blob: 2263fa2b1ebafb886af77317f86a7a0a69482f8f (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
















                                                                               
Plugins
=======

Plugins are `Python <https://www.python.org>`_ programs that use **hircine**'s
plugin architecture to customize or enhance the behaviour of certain parts of
the application.

There are two types of plugins. **Scrapers** read and report metadata from
arbitrary sources and **Transformers** may modify that metadata freely before
it is shown in the :ref:`scraper-interface`. As such, transformers cater to the
needs of a specific user (e.g. to ignore certain pieces of metadata).

.. toctree::
   :maxdepth: 1

   builtin
   writing/index