API Documentation
=================
.. note::
    For quicker navigation of this page, you can use the Table of Contents on the right sidebar.

Module Constants
----------------
.. py:data:: pyspl.__version__
    :type: str

    Returns a string with the format ``{major}.{minor}.{patch}``, for example: ``0.1.1``.

Plays
-----
.. autoclass:: pyspl.Play
    :members:

Acts and Scenes
---------------
.. autoclass:: pyspl.Act
    :members:

.. autoclass:: pyspl.Scene
    :members:

Characters
----------
.. autoclass:: pyspl.Character
    :members:

Operations on Numbers
---------------------
.. autoclass:: pyspl.Int
    :members:

.. autoclass:: pyspl.Operation
    :members:

.. autoclass:: pyspl.sum
    :members:

.. autoclass:: pyspl.difference
    :members:

.. autoclass:: pyspl.product
    :members:

.. autoclass:: pyspl.quotient
    :members:

.. autoclass:: pyspl.remainder
    :members:

.. autoclass:: pyspl.square
    :members:

.. autoclass:: pyspl.cube
    :members:

.. autoclass:: pyspl.squareroot
    :members:

.. autoclass:: pyspl.factorial
    :members:



Errors
------
.. autoclass:: pyspl.StageLimitExceeded
    :members:

.. autoclass:: pyspl.InvalidNumberError
    :members:

.. autoclass:: pyspl.CharacterNotOnstage
    :members:

.. autoclass:: pyspl.NotEnoughCharacters
    :members:
