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

.. note::
   ``animedex`` will be published to PyPI once the v0.1.0 milestone is
   reached. Until then only an editable install from a clone is
   supported.

From source (development)
-------------------------

.. code-block:: bash

   git clone https://github.com/deepghs/animedex.git
   cd animedex
   pip install -e .

This installs the ``animedex`` console script. Smoke-test it:

.. code-block:: bash

   $ animedex --version
   animedex 0.0.1
   build info not generated
   $ animedex status
   animedex v0.0.1 - work in progress.

Optional dependency groups
--------------------------

The repository ships several ``requirements-*.txt`` files. They are
also exposed as setuptools extras:

.. code-block:: bash

   pip install -e .[test]    # pytest, coverage, flake8, ruff, mock, ...
   pip install -e .[doc]     # sphinx + sphinx_rtd_theme + extensions

Supported Python versions
-------------------------

animedex targets Python 3.7 and newer. The CI matrix is currently 3.8
through 3.13 on Linux, Windows, and macOS; older versions may still
work but are not gated.

From PyPI (future)
------------------

Once published, the standard install will be:

.. code-block:: bash

   pip install animedex

Until then, the command above will return an HTTP 404 from PyPI.