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.0b8
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.0b8 (2023-04-25)
- Add support for moving users to another room (
self.highrise.move_user_to_room(user_id, room_id)). - Add handler that is triggered when user moves inside a room (
self.on_user_move(user_id, position)).) - Expand session_metadata information with information about client rates
- Expand session_metadata with information about sdk versions if client uses skd
23.1.0b6 (2023-04-17)
- Add Python 3.10 support
23.1.0b5 (2023-04-11)
- Add support for getting room permissions for users (
self.highrise.get_room_privilege(user_id)). - Add support changing room permissions for users (
self.highrise.set_room_privilege(user_id, privilege)). - Add support for moderating rooms (
self.highrise.moderate_room(user_id, moderate_action, action_length)). - Rework how keepalive is handled
23.1.0b4 (2023-04-05)
- Methods mapping to requests with empty responses (
chat,send_whisper,send_emote,react,set_indicator,send_channel,walk_to,teleport) now returnNone, and raise ahighrise.ResponseErroron an error response. - Fix the emote API.
- Internally rework request handling to improve robustness.
23.1.0b3 (2023-04-03)
- Fix the chatting API.
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.
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.0b8.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 711eb0711439dc8d8b241c804e8f6bf6b78c1a3e7eee3ddacd12484b38f2c1d8 |
|
| MD5 | dfb49bb5142ffce8b43b736b980dfbb3 |
|
| BLAKE2b-256 | 9e7a166090069cb26db15a97cf0f76551e0b46b799267bfe38724670f1d5c38b |
Hashes for highrise_bot_sdk-23.1.0b8-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9e7c5eb0cad281e4a30aff983ba383e9935eaa9a87b52b30d367f3a1933c4ef1 |
|
| MD5 | 1684157f14f9477ce0b54fa2c7c70457 |
|
| BLAKE2b-256 | f7cec773e02e7d0af3747ddc8d957d25a751df86d222f9c3ef77212f8ce57236 |
