# [🐍 Speedybot-python](https://pypi.org/project/speedybot)
For the impatient, just go here: **[quickstart.md](https://github.com/valgaze/speedybot-python/blob/deploy/quickstart.md)**
```md
╔═╗ ╔═╗ ╔═╗ ╔═╗ ╔╦╗ ╦ ╦ ╔╗ ╔═╗ ╔╦╗
╚═╗ ╠═╝ ║╣ ║╣ ║║ ╚╦╝ ╠╩╗ ║ ║ ║
╚═╝ ╩ ╚═╝ ╚═╝ ═╩╝ ╩ ╚═╝ ╚═╝ ╩
```
## What is SpeedyBot?
SpeedyBot is a library that makes it speedy and easy to build high-quality, user-valuable bots with rich interaction + conversation design.
Keep your eyes here for updates: https://speedybot.js.org
## SpeedyCards
SpeedyBot abstracts over a lot of API details for you, but perhaps its most immediately useful feature is that it makes creating visually complex + rich Adpative Cards speedy and easy.
It's all the power of adaptive cards with none of the hassle or wrangling-- and you even get type'ing assistance
## Getting Started
```
pip install -U speedybot
```
## Quickstart
```python
from speedybot import SpeedyBot
## Setup/import your bot
## Get a bot token here: https://developer.webex.com/my-apps/new/bot
bot = SpeedyBot("__REPLACE__ME__")
## Send Messages
messsage = bot.send_to("valgaze@cisco.com", "here is **my message**")
## Reply to Messages
roomId = messsage['roomId']
messageId = messsage['id']
bot.reply(roomId, messageId, 'This is a reply')
## Cards + fun
## Unleash the power of cards!
# More info at our Buttons & Cards guide: https://developer.webex.com/docs/buttons-and-cards
card = bot.card() \
.add_title('Earnest Shackleton Expedition') \
.add_subtitle('Survival in the Antarctic Wilderness') \
.add_text("As we embarked on the Earnest Shackleton Expedition, our success hinged on the equipment we carried. "
"Our inventory was meticulously chosen to ensure our survival in the harsh Antarctic wilderness and guide us through "
"uncharted territories. Here's what we packed:",
horizontalAlignment="Center", color="Accent") \
.add_table([
['Equipment', 'Quantity'],
['Maps', '2'],
['Compasses', '2'],
['Torches', '4'],
['Provisions', '10 months'],
['Rope', '50 meters'],
['First Aid Kit', '1'],
]) \
.add_text("With these supplies, we were well-prepared to face the challenges that lay ahead") \
.add_link('https://en.wikipedia.org/wiki/Ernest_Shackleton', 'Explore Earnest Shackleton Expedition') \
# Embed a card within the card
sub_card = bot.card() \
.add_subtitle('The Harsh Antarctic Wilderness') \
.add_text("The Earnest Shackleton Expedition took us to the unforgiving Antarctic wilderness, filled with extreme cold, isolation, and constant danger. "
"Our survival equipment was our lifeline in these remote landscapes, ensuring our safety and "
"enabling us to explore the unknown with confidence")
card.add_subcard(sub_card)
bot.send_to('valgaze@cisco.com', card)
```
## Tests
```
python3 -m unittest tests/test.py
```
## Publishing
```
poetry build
poetry publish
```
## Visual Studio Code issue
If you can't get auto-complete on visual studio you may need to select a Python interpeter
Select ⇧⌘P and search for `Python: Select Interpreter` and pick the interpeter that matches the version with your project (`python --version`), **[🔗 more details here](https://code.visualstudio.com/docs/python/environments)**
Raw data
{
"_id": null,
"home_page": "https://github.com/valgaze/speedybot-python",
"name": "speedybot",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "bot,speedybot,adaptive cards",
"author": "Victor Algaze",
"author_email": "valgaze@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0f/5e/05533d0a3ddbe29acc1c5d47df70df8b2b2eae3ca5c0146997280344ef30/speedybot-0.6.2.tar.gz",
"platform": null,
"description": "# [\ud83d\udc0d Speedybot-python](https://pypi.org/project/speedybot)\n\nFor the impatient, just go here: **[quickstart.md](https://github.com/valgaze/speedybot-python/blob/deploy/quickstart.md)**\n\n```md\n\u2554\u2550\u2557 \u2554\u2550\u2557 \u2554\u2550\u2557 \u2554\u2550\u2557 \u2554\u2566\u2557 \u2566 \u2566 \u2554\u2557 \u2554\u2550\u2557 \u2554\u2566\u2557 \n\u255a\u2550\u2557 \u2560\u2550\u255d \u2551\u2563 \u2551\u2563 \u2551\u2551 \u255a\u2566\u255d \u2560\u2569\u2557 \u2551 \u2551 \u2551 \n\u255a\u2550\u255d \u2569 \u255a\u2550\u255d \u255a\u2550\u255d \u2550\u2569\u255d \u2569 \u255a\u2550\u255d \u255a\u2550\u255d \u2569\n```\n\n## What is SpeedyBot?\n\nSpeedyBot is a library that makes it speedy and easy to build high-quality, user-valuable bots with rich interaction + conversation design.\n\nKeep your eyes here for updates: https://speedybot.js.org\n\n## SpeedyCards\n\nSpeedyBot abstracts over a lot of API details for you, but perhaps its most immediately useful feature is that it makes creating visually complex + rich Adpative Cards speedy and easy.\n\nIt's all the power of adaptive cards with none of the hassle or wrangling-- and you even get type'ing assistance\n\n\n\n## Getting Started\n\n```\npip install -U speedybot\n```\n\n## Quickstart\n\n```python\nfrom speedybot import SpeedyBot\n\n## Setup/import your bot\n## Get a bot token here: https://developer.webex.com/my-apps/new/bot\nbot = SpeedyBot(\"__REPLACE__ME__\")\n\n## Send Messages\nmesssage = bot.send_to(\"valgaze@cisco.com\", \"here is **my message**\")\n\n## Reply to Messages\nroomId = messsage['roomId']\nmessageId = messsage['id']\n\nbot.reply(roomId, messageId, 'This is a reply')\n\n## Cards + fun\n\n## Unleash the power of cards!\n# More info at our Buttons & Cards guide: https://developer.webex.com/docs/buttons-and-cards\n\ncard = bot.card() \\\n .add_title('Earnest Shackleton Expedition') \\\n .add_subtitle('Survival in the Antarctic Wilderness') \\\n .add_text(\"As we embarked on the Earnest Shackleton Expedition, our success hinged on the equipment we carried. \"\n \"Our inventory was meticulously chosen to ensure our survival in the harsh Antarctic wilderness and guide us through \"\n \"uncharted territories. Here's what we packed:\",\n horizontalAlignment=\"Center\", color=\"Accent\") \\\n .add_table([\n ['Equipment', 'Quantity'],\n ['Maps', '2'],\n ['Compasses', '2'],\n ['Torches', '4'],\n ['Provisions', '10 months'],\n ['Rope', '50 meters'],\n ['First Aid Kit', '1'],\n ]) \\\n .add_text(\"With these supplies, we were well-prepared to face the challenges that lay ahead\") \\\n .add_link('https://en.wikipedia.org/wiki/Ernest_Shackleton', 'Explore Earnest Shackleton Expedition') \\\n\n# Embed a card within the card\nsub_card = bot.card() \\\n .add_subtitle('The Harsh Antarctic Wilderness') \\\n .add_text(\"The Earnest Shackleton Expedition took us to the unforgiving Antarctic wilderness, filled with extreme cold, isolation, and constant danger. \"\n \"Our survival equipment was our lifeline in these remote landscapes, ensuring our safety and \"\n \"enabling us to explore the unknown with confidence\")\n\ncard.add_subcard(sub_card)\nbot.send_to('valgaze@cisco.com', card)\n\n```\n\n\n\n## Tests\n\n```\npython3 -m unittest tests/test.py\n```\n\n## Publishing\n\n```\npoetry build\npoetry publish\n```\n\n## Visual Studio Code issue\n\nIf you can't get auto-complete on visual studio you may need to select a Python interpeter\n\nSelect \u21e7\u2318P and search for `Python: Select Interpreter` and pick the interpeter that matches the version with your project (`python --version`), **[\ud83d\udd17 more details here](https://code.visualstudio.com/docs/python/environments)**\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Next-gen conversation design tooling, makes it speedy and easy to send messages",
"version": "0.6.2",
"project_urls": {
"Homepage": "https://github.com/valgaze/speedybot-python",
"Repository": "https://github.com/valgaze/speedybot-python"
},
"split_keywords": [
"bot",
"speedybot",
"adaptive cards"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ccf60d708a2a3c121dd9e28d7d739af28426d6bd507ca7aabf70db5f69fc920b",
"md5": "f0af7e7e66ec353481f125150ac10907",
"sha256": "ba54642b88b8c52fd7d004d8607f435f2f83f7f79ad7055a20486e0797942719"
},
"downloads": -1,
"filename": "speedybot-0.6.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f0af7e7e66ec353481f125150ac10907",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 5900,
"upload_time": "2023-11-06T07:39:18",
"upload_time_iso_8601": "2023-11-06T07:39:18.230647Z",
"url": "https://files.pythonhosted.org/packages/cc/f6/0d708a2a3c121dd9e28d7d739af28426d6bd507ca7aabf70db5f69fc920b/speedybot-0.6.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f5e05533d0a3ddbe29acc1c5d47df70df8b2b2eae3ca5c0146997280344ef30",
"md5": "56650379ce7f4db510bc59e7ff8e3c7c",
"sha256": "fe3298b6c3e4ccfd90c37e4000a3cd4e0a647fbacb024d5840774edf878a8709"
},
"downloads": -1,
"filename": "speedybot-0.6.2.tar.gz",
"has_sig": false,
"md5_digest": "56650379ce7f4db510bc59e7ff8e3c7c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 5130,
"upload_time": "2023-11-06T07:39:19",
"upload_time_iso_8601": "2023-11-06T07:39:19.424016Z",
"url": "https://files.pythonhosted.org/packages/0f/5e/05533d0a3ddbe29acc1c5d47df70df8b2b2eae3ca5c0146997280344ef30/speedybot-0.6.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-06 07:39:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "valgaze",
"github_project": "speedybot-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "speedybot"
}
JSON
