Metadata-Version: 2.1
Name: arena-py
Version: 0.0.5
Summary: Draw objects in the ARENA using Python!
Home-page: https://github.com/conix-center/ARENA-py
Author: Conix Research Center
Author-email: info@conix.io
License: BSD 3-clause "New" or "Revised License"
Description: # ARENA Py - Python Examples
        Draw objects in the ARENA using Python.
        
        ## Documentation
        The ARENA Python library user guide and tutorials: [ARENA Documentation: Python](https://conix-center.github.io/ARENA/content/python/).
        
        ## Setup
        Install package using pip:
        ```shell
        pip3 install arena-py
        ```
        
        ## Hello ARENA
        1. View the ARENA at [https://arena.andrew.cmu.edu?scene=hello](https://arena.andrew.cmu.edu?scene=hello)
        1. Run the `hello.py` example:
        ```shell
        cd examples
        python hello.py
        ```
        
        `hello.py`
        ```python
        import arena
        arena.init("arena.andrew.cmu.edu", "realm", "hello")
        arena.Object(objType=arena.Shape.cube)
        arena.handle_events()
        ```
        
        ## arena.py Library
        The above is the simplest example of an ARENA Python program. This library sits above the ARENA pub/sub MQTT
        message protocol: JSON messages described in more detail at https://github.com/conix-center/ARENA-core which runs in a browser. That forms a layer, in turn, on top of [A-Frame](https://aframe.io/) and [THREE.js](http://threejs.org/) javascript libraries.
        
        ## Authentication
        We are adding protection to the ARENA MQTT broker, eventually to host an ACL list to limit access to change your scenes. As a first step, we are requiring Python programs to supply authentication through a Google account.
        ### Sign-In Desktop OS
        If you have a web browser available, the ARENA library `arena.init(broker="myhost.com")` will launch a web browser the first time and ask you for an account to authenticate you with, before opening a client MQTT connection.
        ### Sign-In Server/Headless OS
        For headless environments, the ARENA library `arena.init(broker="myhost.com")` will provide you with a url to cut and paste in a browser anywhere, ask you for an account to authenticate you with, and show you a code you can enter on the command line, before opening a client MQTT connection.
        ### Sign-Out
        ```bash
        python3 arena/auth.py signout
        ```
        
        ## ARENA-py Repository Files
        - [arena/](arena/): The ARENA Python library
        - [demos/](demos/): Demos of cool ARENA applications
        - [demos/raw-prototypes/](demos/raw-prototypes/): Older ARENA non-library demos
        - [digital-twins/](digital-twins/): Digital twins of physical spaces
        - [examples/](examples/): Canonical examples of ARENA functions from the [documentation](https://conix-center.github.io/ARENA/content/python/))
        - [system-tests/](system-tests/): Workouts for the ARENA
        - [tools/](tools/): Reusable tools for any ARENA scene
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
