Metadata-Version: 2.1
Name: monome-druid
Version: 1.0.0
Summary: Terminal interface for crow
Home-page: https://github.com/monome/druid
Author: monome
Author-email: bcrabtree@monome.org
License: UNKNOWN
Description: # druid
        
        A basic REPL for crow with some utilities
        
        ## Setup
        
        Requirements:
        - Python 3.6+
          - Windows & OS X: https://www.python.org/downloads/
          - Linux: `sudo apt-get install python3 python3-pip` or equivalent
        - `pip` and `setuptools`
        - `pyserial` and `prompt_toolkit`
        
        Note: you might need to use `python` and `pip` instead of `python3` and `pip3` depending on your platform. If `python3` is not found, check that you have python >= 3.6 with `python --version`.
        
        Install and run:
        ```bash
        # Install druid
        pip3 install monome-druid
        # Run druid :)
        druid
        ```
        
        ## Druid
        
        Start by running `druid`
        
        - type q (enter) to quit.
        - type h (enter) for a list of special commands.
        
        - input values are printed on the top line
        - will reconnect to crow after a disconnect / restart
        - scrollable console history
        
        Example:
        
        ```
        druid
        //// druid. q to quit. h for help
        
        > x=6
        
        > print(x)
        6
        
        > output[1].volts = 0
        
        > q
        ```
        
        Diagnostic logs are written to `druid.log`.
        
        ## Command Line Interface
        
        Sometimes you don't need the repl, but just want to upload/download scripts to/from crow. You can do so directly from the command line with the `upload` and `download` commands.
        
        ### Upload
        
        ```
        druid upload cool_script.lua
        ```
        
        Uploads the provided lua file, `cool_script.lua`, to crow & stores it in flash to be executed on boot.
        
        ### Download
        
        ```
        druid download > feathers.lua
        ```
        
        Grabs the script currently stored on crow, and pastes the result into a new file `feathers.lua`.
        
        ## Bowery
        
        For a collection of `druid` scripts, see the community-contributed collection ['bowery'](https://github.com/monome/bowery). They're a great place to start if you're looking to customize or build your own scripts.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: test
