panvoy.api
==========

.. py:module:: panvoy.api

.. autoapi-nested-parse::

   The primary module in panvoy.



Attributes
----------

.. autoapisummary::

   panvoy.api.JRPN_DOMAIN
   panvoy.api.JRPN_PATH
   panvoy.api.logger


Functions
---------

.. autoapisummary::

   panvoy.api.parse_jrpn_url


Module Contents
---------------

.. py:data:: JRPN_DOMAIN
   :value: 'jrpn.jovial.com'


.. py:data:: JRPN_PATH
   :value: '/run/index.html'


.. py:data:: logger

.. py:function:: parse_jrpn_url(jrpn_url)

   Parses a JRPN state URL into JRPN’s internal state dictionary.

   :param jrpn_url:
       JRPN state URL. Must start with:
       ``https://jrpn.jovial.com/run/index.html``

   :return:
       a dictionary representing JRPN’s internal state