Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/satheesh1997/iabot
A mini framework for building bots using python and can be served using different ways.
https://github.com/satheesh1997/iabot
bot bot-framework pkg python
Last synced: 2 days ago
JSON representation
A mini framework for building bots using python and can be served using different ways.
- Host: GitHub
- URL: https://github.com/satheesh1997/iabot
- Owner: satheesh1997
- License: mit
- Created: 2020-04-04T11:59:43.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-02T19:11:58.000Z (over 1 year ago)
- Last Synced: 2024-09-17T05:19:50.656Z (16 days ago)
- Topics: bot, bot-framework, pkg, python
- Language: Python
- Homepage: https://pypi.org/project/iaBot/
- Size: 28.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# iaBot
iaBot is a Python library for creating simple bots and serving it with the different ways available.
[](https://badge.fury.io/py/iaBot) 
## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install iaBot.
```bash
pip install iaBot
```
## A simple bot
```python
from iabot import CreateBot
from iabot.handlers import SystemInformationHandler
from iabot.servers import HttpServer
handlers = [
SystemInformationHandler
]
bot = CreateBot(
handlers=handlers
)
bot_server = HttpServer(bot)
bot_server.run()
```
This creates a simple bot that will be listening to HttpRequests on the port 8000. Using any tool available send a post request to http://:8000/ with the following data.
```json
{
"handler": "system",
"action": "time"
}
```
On successfull request you will get time in the response as json.
### Handlers
These are used to group a set of similar actions. You can create your own handlers by inheriting the base handler.
```python
from iabot.handlers import BaseHandler
class StockHandler(BaseHandler):
handle = 'stock'
def get_stocks(self, *args, **kwargs):
.....
....
```
Once you create a handler with the actions you can register it to a bot by adding the handler to the list of handlers.
### Actions
These are functions that a bot can execute to do the job when asked for. In the above StockHandler, get_stocks is an action. The response of all the actions should be a dictionary.
When a request reaches the server it will execute the particular action inside the handler. You can also send some additional data to your actions by passing it as a dict using data key in the request data. Remember a handler should always return a dict.
```json
{
"handler": "stock",
"action": "get_stocks",
"data": {
"date": "04-5-2010"
}
}
```
Will be updating more and adding more type of servers to serve the bot.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## -
