Skip to main content

Python Matrix library, built on the Matrix Client-Server SDK

setup

pip install scalar

Create a configuration.

mkdir -p ~/.config/scalar
touch ~/.config/scalar/config.yaml

The configuration file contents should be like the following:

{
    "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.

client

A scalar terminal client can be launched in the following way:

scalar_client

alert

An alert message can be sent on the terminal, in a way like the following:

scalar_alert --message="This is an alert message."

An alert message can be send in Python, in a way like the following:

import scalar
scalar.alert(message="alert")

megaparsex can be used with scalar to send data via messages, in ways like the following:

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

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")

Metadata

Release files for scalar 2018.9.10.2016

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scalar 2018.9.10.2016
File Size Uploaded Provenance Actions
scalar-2018.9.10.2016.tar.gz 5.1 kB Without provenance Details for scalar-2018.9.10.2016.tar.gz

Release files / scalar-2018.9.10.2016.tar.gz

Download URL scalar-2018.9.10.2016.tar.gz
Size 5.1 kB
Tags Source
SHA-256 checksum
How to use checksums
e28e4049f9f24319fbee68634196fa964cc765aaadd08ff4dc643a331817b9c7
BLAKE2b-256 checksum
How to use checksums
7b39406053165c8f72bc7499e44d97ebc15074f8c7cd9fd5644ccde0b0b79103
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/2.7

Security for scalar 2018.9.10.2016

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page