.. SPDX-FileCopyrightText: 2025 Adrian Chaves <adrian@chaves.gal>
..
.. SPDX-License-Identifier: AGPL-3.0-or-later

===================
pyeu5 documentation
===================

.. toctree::
    :hidden:
    :maxdepth: 2

    api
    contributing

.. include:: ../README.rst
    :start-after: intro-start
    :end-before: intro-end

Install
=======

Install from PyPI_:

.. code-block::

    pip install eu5

.. _PyPI: https://pypi.org/project/eu5/

Use
===

Load a save with :class:`~.Save`:

.. code-block:: python

    from eu5 import Save

    specific_save = Save("path/to/save.eu5")
    latest_save = Save.latest()

Then use its API to access whatever information you want.