This release is a pre-release and may not be stable for production use.
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.0b4
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.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.
2 maintainers
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file highrise_bot_sdk-23.1.0b4.tar.gz.
File metadata
- Download URL: highrise_bot_sdk-23.1.0b4.tar.gz
- Upload date:
- Size: 9.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.3.1 CPython/3.10.9 Darwin/22.3.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fea8d71a0be5bbe587a4f60ac1e7488b44cdf35bdf8ded11e01e5ad6eeeeb4e3
|
|
| MD5 |
a30f1db0a6d658044597c3da33cbc52e
|
|
| BLAKE2b-256 |
ad0ce8fa4fdf5387dca776caf7ad5290af8ccce4fd8fc165c2bd5ad0b692fb4d
|
File details
Details for the file highrise_bot_sdk-23.1.0b4-py3-none-any.whl.
File metadata
- Download URL: highrise_bot_sdk-23.1.0b4-py3-none-any.whl
- Upload date:
- Size: 9.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.3.1 CPython/3.10.9 Darwin/22.3.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
020963fab8e18eae162e1b578a151460d56955440c41004210e53b6ee249a856
|
|
| MD5 |
434ba00a421eb4ad8fa9c5bd9939663e
|
|
| BLAKE2b-256 |
9ea7cf372d8894cc494a992c75ac8603dfac405e3bfa72b5a79d6ebe841b81a3
|
