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.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.0b3.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 63994ac84eddf380de719898df74f88a588eff95188f9c42804c8b14a704afec |
|
| MD5 | 77406543f4b857c3284b22cf6b0fafd5 |
|
| BLAKE2b-256 | 10230e92a502e0a5598f46ec954d43549786abc13db9ed97835be39cb45113ce |
Hashes for highrise_bot_sdk-23.1.0b3-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1b7f2fa2d1e541f579bcc318654f4de7f721af3144a589653c69c1ac7d89ab39 |
|
| MD5 | 3eed72ed1b498411634d7e208810560f |
|
| BLAKE2b-256 | 2ce2dd708458406dcad1a55516b891ed51a16deacb17bb103500cebb60b0d16a |
