Metadata-Version: 2.1
Name: balladeer
Version: 0.23.0
Summary: Web-enabled interactive fiction in Python.
Home-page: https://github.com/tundish/balladeer
Author: D E Haynes
Author-email: tundish@gigeconomy.org.uk
License: UNKNOWN
Platform: UNKNOWN
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Description-Content-Type: text/x-rst
Provides-Extra: dev
License-File: LICENSE

Balladeer
:::::::::

This is a Python package for creating web-enabled interactive screenplay.
For documentation, please visit the `development blog site
<https://tundish.github.io/balladeer/>`_.

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

Here are the install instructions for Linux. You need Python version 3.8 or higher.

Virtual Environment
-------------------

#. First make a fresh Python virtual environment::

    python3 -m venv ~/balladeer-app

Packages
--------

#. Update the package manager within it::

    ~/balladeer-app/bin/pip install -U pip wheel

#. Install (or update) Balladeer::

    ~/balladeer-app/bin/pip install -U balladeer

Examples
========

Downloads and Dependencies
--------------------------

#. Install dependencies::

    ~/balladeer-app/bin/pip install aiohttp

#. Download the `repository as a zip file <https://github.com/tundish/balladeer/archive/master.zip>`_.
   Unzip it to a local directory.

Operation
---------

#. `cd` to one of the directories under `examples`::

    cd examples/00_hello_world

#. Run the example like this::

    ~/balladeer-app/bin/python hello.py

    Hello, World!



