*******************************************************************************
Python interface
*******************************************************************************

:mod:`emblematic` has a Python interface that can be called from other Python scripts to programmatically generate emblems.

============
Installation
============

:mod:`emblematic` is distributed both via `PyPI`_ and `Steffo's Forge`_.

Use your favorite package manager to install it in your project.

For example, with `Poetry`_ via `PyPI`_:

.. code-block:: console

    $ poetry add emblematic

Or, with `pip`_ via `Steffo's Forge`_:

    $ pip install --index-url 'https://forge.steffo.eu/api/packages/steffo/pypi/simple/' emblematic

.. _PyPI: https://pypi.org/project/emblematic/
.. _Steffo's Forge: https://forge.steffo.eu/steffo/-/packages/pypi/emblematic/
.. _Poetry: https://python-poetry.org/
.. _pip: https://pip.pypa.io/en/stable/

=====
Usage
=====

.. todo:: Describe how the package can be used in other Python scripts.

=============
API reference
=============

------------------
Emblem composition
------------------

.. automodule:: emblematic.composition

----------------
SVG modification
----------------

.. automodule:: emblematic.svg

---------------------------------
Command-line interface definition
---------------------------------

.. automodule:: emblematic.cli

Arguments and options
^^^^^^^^^^^^^^^^^^^^^

.. automodule:: emblematic.cli.argopts

Commands
^^^^^^^^

.. automodule:: emblematic.cli.commands

File detection
^^^^^^^^^^^^^^

.. automodule:: emblematic.cli.files