Writing plugins
===============

Before writing plugins, please familiarize yourself with the basics of the
:ref:`Python programming language <python:tutorial-index>`. It is also
recommended to read the :doc:`packaging:overview`. **hircine** discovers
plugins via :ref:`package metadata <packaging:plugin-entry-points>`, so it is
also useful to have a basic understanding of the :ref:`packaging:entry-points`.

The plugin examples on the following pages are a good place to start once you
are ready. You may also have a look at the `source code
<https://git.oriole.systems/hircine/tree/src/hircine/plugins/scrapers>`_ for
the built-in scrapers.

.. toctree::
   :maxdepth: 1

   scrapers
   transformers
   reference