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.0b6
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.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.0b6.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b23f7f459ded8d867ad3d339f29f9ee47c00f49a34877fd904864041b9b15023 |
|
| MD5 | 6911a5afae1190a969c2d9e41942989c |
|
| BLAKE2b-256 | ac63f3cf8ae688463ed5228bdfbe2b53d5f9e96ba086806bde90c73aa98d394b |
Hashes for highrise_bot_sdk-23.1.0b6-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 781c2b0298e1ae51eb3900153ba1552d9a9a350b758d6ce93a217cc4ce7c6437 |
|
| MD5 | bd01ac71cf6e4b4ef3faa2d742f731cd |
|
| BLAKE2b-256 | 66236ebd16af2cf516babd1c19f44bcd1536c5c61bf2636b4a8c23230d5e9ca8 |
