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.0b5
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.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.ResponseError
on 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.
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.0b5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83b39d549a3091a8e50d8091f289f907fbb170f9df121f2cfb264c02a7fc710c |
|
MD5 | 47badae59428d5b70b8e6c26066312ba |
|
BLAKE2b-256 | 34a51f4d6521cf6d458e417992f6321a67937bc1f56f10a8aebf4ebfd9b540cb |
Hashes for highrise_bot_sdk-23.1.0b5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25615f70702a984d64c24e42172a45a9238ef61cb960fcb64d4ef4a2057a6d57 |
|
MD5 | 466af23f99e694dbc4d13f8c9bd32815 |
|
BLAKE2b-256 | e194ebc2150cd3a07c7f23ba66d6fcce6bedb3bd49a1e669639322d3b0fd9b15 |