The Highrise Bot SDK, for running Highrise bots written in Python.
Project description
The Highrise Python Bot SDK
The Highrise Python Bot SDK is a python library for writing and running Highrise bots.
First, install the library (preferably in a virtual environment):
$ pip install highrise-bot-sdk==23.1.0.b0
In the Settings section of the Highrise website, create a bot and generate the API token. You'll need the token to start your bot later.
You will also need a room ID for your bot to connect to; the room needs to be owned by you or your bot user needs to have designer rights to enter it.
Open a new file, and paste the following to get started (into mybot.py for example):
from highrise import BaseBot
class Bot(BaseBot):
pass
Override methods from BaseBot as needed.
When you're ready, run the bot from the terminal using the SDK, giving it the Python path to the Bot class:
$ highrise mybot:Bot <room ID> <API token>
Changelog
23.1.0.b1 (2023-03-28)
- Add support for emotes and hidden channel messages.
23.1.0.b0 (2023-03-10)
- Initial beta release.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for highrise_bot_sdk-23.1.0b1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 78110337e77ec32168ced75f223251c010b1f743f6197e4a38f7e059f2c77bde |
|
| MD5 | ed4871821840dbc0197a8a8d9253e1c5 |
|
| BLAKE2b-256 | f061db0307f34d14d98985c55f304421e96bf6b186c6de29b9e12f627284a155 |
Hashes for highrise_bot_sdk-23.1.0b1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6831c97deb49e94ae34e356dbc3a63cad9784676023f14d847ab45c2a7274285 |
|
| MD5 | 69951e979ea8cef4ed7f2f9494f488bc |
|
| BLAKE2b-256 | f9f4b589c857a2e4ed3561ec2fb24c2983785bb0cdf8fe320edcf958b89585aa |
