Metadata-Version: 1.2
Name: scalar
Version: 2018.8.26.2157
Summary: Python Matrix library
Home-page: https://github.com/wdbm/scalar
Author: Will Breaden Madden
Author-email: wbm@protonmail.ch
License: GPLv3
Description: .. figure:: https://raw.githubusercontent.com/wdbm/scalar/master/media/scalar.png
           :alt: 
        
        Python Matrix library, built on the `Matrix Client-Server
        SDK <https://github.com/matrix-org/matrix-python-sdk>`__
        
        setup
        =====
        
        .. code:: bash
        
            pip install scalar
        
        Create a configuration.
        
        .. code:: bash
        
            mkdir -p ~/.config/scalar
            touch ~/.config/scalar/config.yaml
        
        The configuration file contents should be like the following:
        
        .. code:: yaml
        
            {
                "configurations": {
                    "scriptwire": {
                        "default"   : True,
                        "homeserver": "https://matrix.example.pro:8448",
                        "username"  : "scriptwire",
                        "passcode"  : "qo3i4tbc35wgtt4gbwikgvtib3ctgt7bgi3rgw",
                        "room_alias": "!cgOnMzaBWCLjBnhGiB:matrix.example.org"
                    }
                },
                "version_config": "2018-08-23T1930Z"
            }
        
        There can be multiple configurations, such as for separate accounts. One
        configuration must be set as the default if a configuration is not
        specified on setup. A room must be one to which the account has been
        invited.
        
        alert
        =====
        
        An alert message can be sent on the terminal, in a way like the
        following:
        
        .. code:: bash
        
            scalar_alert --message="This is an alert message."
        
        An alert message can be send in Python, in a way like the following:
        
        .. code:: python
        
            import scalar
            scalar.alert(message="alert")
        
        `megaparsex <https://github.com/wdbm/megaparsex>`__ can be used with
        scalar to send data via messages, in ways like the following:
        
        .. code:: python
        
            import megaparsex
            import scalar
            scalar.alert(message=megaparsex.report_IP())
            scalar.alert(message=megaparsex.report_system_status())
            scalar.alert(message=megaparsex.report_METAR("EGPF"))
        
        upload and send text, files, audio, images and video
        ====================================================
        
        .. code:: python
        
            import scalar
            scalar.send_text("test")
            scalar.send_file("test.csv")
            scalar.send_audio("test.ogg")
            scalar.send_image("test.gif")
            scalar.send_video("test.mp4")
        
Platform: UNKNOWN
Requires-Python: >=3
