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.0b2
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.0b2 (2023-04-03)
- Add support for receiving and sending reactions.
- Fix support for hidden channels.
- Migrate to the new message for avatars leaving.
- Improve concurrency when awaiting bot methods.
- Fix issues with teleporting users.
- Fix issues with user coordinates.
- Add support for fetching the bot wallet (
self.highrise.get_wallet()
).
23.1.0b1 (2023-03-28)
- Add support for emotes and hidden channel messages.
23.1.0b0 (2023-03-10)
- Initial beta release.
Project details
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.0b2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | de6ab4f3da4ae61d37218f2e3ce949ade55873a78c5273630682c6f62005a178 |
|
MD5 | 54090505b5e135e2db90cec407bcca58 |
|
BLAKE2b-256 | 5d9fecb90b1b300b3a0990530acdec39d9eac19389e85d99d178a2f42f5d21a3 |
Hashes for highrise_bot_sdk-23.1.0b2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 893efc5c13202f259af33373aeecbc69e6e71e01c6dd44c1cb36dc5d051b49bf |
|
MD5 | 078726a7933839134ce38d68ece60583 |
|
BLAKE2b-256 | a2ebcaf74831063244ee9c244420d245c0254ff905709a000243541ba49f9064 |