Quickstart
==========

.. note::

   This is a quick guide for beginners to start using **PySPL**. For the full API documentation, see the section :doc:`api`.

Installation
------------
To use **PySPL**, first install it using ``pip``:

.. code-block:: console

   (.venv) $ pip install py2spl


Getting Started
---------------
.. code-block:: python

   import pyspl

First enter this piece of code shown above. You import the module using this.

.. note:: 

   If your type checker does not like that, you can instead use the following to import PySPL:

   .. code-block:: python

      from py2spl import pyspl

Then enter:

.. code-block:: python

    play = pyspl.Play('Hi? Hi.')

    hamlet = play.character('Hamlet', 'a male.')
    juliet = play.character('Juliet', 'a female.')

    class ActI(pyspl.Act):
        def __init__(self, *args, **kwargs):
            super().__init__(*args, **kwargs)
            self.add_scene(self.sceneI, 'I', 'The Only Scene.')

    def sceneI(self):
        self.enter(hamlet, juliet)
        self.set(juliet, pyspl.sum(64, 8))
        self.print(juliet, str)
        self.set(hamlet, pyspl.sum(juliet, pyspl.sum(32, 1)))
        self.print(hamlet, str)
        self.exit()
         
We added two characters to the program, then written a program to print Hi using the 
ASCII codes.

Then add:

.. code-block:: python

   play.save('./play.spl')

You should then install the latest version of `zmbc's SPL interpreter <https://github.com/zmbc/shakespearelang>`_, which is written 
in Python (if you haven't yet):

.. tabs::

   .. group-tab:: Mac / Linux

      .. code-block:: console

         $ git clone https://github.com/zmbc/shakespearelang && pip install ./shakespearelang

   .. group-tab:: Windows

      .. code-block:: console

         > git clone https://github.com/zmbc/shakespearelang && pip install .\shakespearelang

You can then run your SPL play by using the following command in your console:

.. tabs::

   .. group-tab:: Mac / Linux

      .. code-block:: console

         $ shakespeare run ./play.spl

   .. group-tab:: Windows

      .. code-block:: console

         > shakespeare run .\play.spl


If it doesn't work, using the following command might work:

.. tabs::

   .. group-tab:: Mac / Linux

      .. code-block:: console

         $ python -m shakespeare run ./play.spl

   .. group-tab:: Windows

      .. code-block:: console

         > py -m shakespeare run .\play.spl