## For EDUCATIONAL PURPOSE only
# AminoBot
An API for bot amino based on Slimakoi's work
Discord server https://discord.gg/KZgKktQ6Rt
This API has been made for people who aren't very good at programming or people who want to do easy stuff!
## How does this API works?
It works like the Amino.py's API but with added features like commands or answer
for example:
```python3
from BotAmino import BotAmino, Parameters
print("wait...")
client = BotAmino("email", "password")
client.prefix = "/" # set the prefix to /
client.wait = 10 # wait 10 sec before doing a new command
def test(data: Parameters):
return data.authorId in ["your_user_id", "friend_user_id"]
@client.command("ping", test) # "ping" the command and test the function, if test is True the command will be executed, else it will not
def ping(data: Parameters):
data.subClient.send_message(data.chatId, message="pong!")
@client.command("pong") # "pong" the command, the test function is not necessary
def pong(data: Parameters):
if data.subClient.is_in_staff(data.authorId): # will execute the command if the user is in the amino's staff (learder/curator)
data.subClient.send_message(data.chatId, message="ping!")
@client.answer("hey")
def hello(data: Parameters):
data.subClient.send_message(data.chatId, message="Hey! Hey!")
@client.on_member_join_chat()
def say_hello(data: Parameters):
data.subClient.send_message(data.chatId, f"welcome here {data.author}!")
@client.on_member_leave_chat(["chatId"]) # the chatId is not necessary, put one if you want a specified chat only
def say_goodbye(data: Parameters):
data.subClient.send_message(data.chatId, f"See you soon {data.author}!")
client.launch()
print("ready")
```
## There is also built-in functions that might be useful:
- add_title(userId, title, color) : add a title to an user
- remove_title(userId, title) : remove the title given to the user
- follow_user(userId) : follow the user in parameters
- unfollow_user(userId) : unfollow the user in parameters
- leave_all_chats() : leave all the chats for a given community
- join_all_chat() : join all the publics chat of an Amino
- get_chats() : return a list of the publics chatrooms
- join_chatroom(chat_name_or_link) : join the chat for the given link/name
- pay(nb_of_coins, blogId, chatId, objectId, transactionId) : give coins in balance, transactionId not necessary (automatically generated if not put)
- get_wallet_amount() : return the number of coin of the bot
- get_member_title(userId) : return the titles of the member
- get_member_level(userId) : return the level of the member [1-20]
- leave_community() : leave the current community
- get_chat_id(chat) : return the id of the chat (link supported)
- ask_amino_staff(message) : send the message to all the curators/leader of the amino
- get_user_id(name_or_id) : return a tuple with the name and the userId (name, uid)
- get_staff(community) : return the staff of the given community (communityId or aminoId)
- accept_role(noticeId, chatId) : accept a promotion or a chat transfert
- generate_transaction_id() : create a transactionId
- ask_all_members(message) : will send a message in pv to all member by group of 100
- is_it_bot(userId) : check if the user is the bot account
- add_community("aminoId") : add manually a community to the bot (nice for join amino command)
Raw data
{
"_id": null,
"home_page": "https://github.com/ThePhoenix78/AminoBot",
"name": "BotAmino",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "aminoapps,amino-py,amino,amino-bot,narvii,api,python,python3,python3.x,ThePhoenix78,AminoBot,BotAmino,botamino,aminobot",
"author": "ThePhoenix78, Vedansh",
"author_email": "thephoenix788@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f1/44/82426ade0c8f6f257dddfc5d9b797176a05027d19317e94a958c5cf4d57d/BotAmino-1.28.1.tar.gz",
"platform": null,
"description": "## For EDUCATIONAL PURPOSE only\r\n\r\n# AminoBot\r\nAn API for bot amino based on Slimakoi's work\r\n\r\nDiscord server https://discord.gg/KZgKktQ6Rt\r\n\r\nThis API has been made for people who aren't very good at programming or people who want to do easy stuff!\r\n\r\n## How does this API works?\r\n\r\nIt works like the Amino.py's API but with added features like commands or answer\r\nfor example:\r\n\r\n```python3\r\nfrom BotAmino import BotAmino, Parameters\r\n\r\nprint(\"wait...\")\r\nclient = BotAmino(\"email\", \"password\")\r\nclient.prefix = \"/\" # set the prefix to /\r\nclient.wait = 10 # wait 10 sec before doing a new command\r\n\r\n\r\ndef test(data: Parameters):\r\n return data.authorId in [\"your_user_id\", \"friend_user_id\"]\r\n\r\n\r\n@client.command(\"ping\", test) # \"ping\" the command and test the function, if test is True the command will be executed, else it will not\r\ndef ping(data: Parameters):\r\n data.subClient.send_message(data.chatId, message=\"pong!\")\r\n\r\n\r\n@client.command(\"pong\") # \"pong\" the command, the test function is not necessary\r\ndef pong(data: Parameters):\r\n if data.subClient.is_in_staff(data.authorId): # will execute the command if the user is in the amino's staff (learder/curator)\r\n data.subClient.send_message(data.chatId, message=\"ping!\")\r\n\r\n\r\n@client.answer(\"hey\")\r\ndef hello(data: Parameters):\r\n data.subClient.send_message(data.chatId, message=\"Hey! Hey!\")\r\n\r\n\r\n@client.on_member_join_chat()\r\ndef say_hello(data: Parameters):\r\n data.subClient.send_message(data.chatId, f\"welcome here {data.author}!\")\r\n\r\n\r\n@client.on_member_leave_chat([\"chatId\"]) # the chatId is not necessary, put one if you want a specified chat only\r\ndef say_goodbye(data: Parameters):\r\n data.subClient.send_message(data.chatId, f\"See you soon {data.author}!\")\r\n\r\n\r\nclient.launch()\r\nprint(\"ready\")\r\n```\r\n\r\n## There is also built-in functions that might be useful:\r\n\r\n- add_title(userId, title, color) : add a title to an user\r\n\r\n- remove_title(userId, title) : remove the title given to the user\r\n\r\n- follow_user(userId) : follow the user in parameters\r\n\r\n- unfollow_user(userId) : unfollow the user in parameters\r\n\r\n- leave_all_chats() : leave all the chats for a given community\r\n\r\n- join_all_chat() : join all the publics chat of an Amino\r\n\r\n- get_chats() : return a list of the publics chatrooms\r\n\r\n- join_chatroom(chat_name_or_link) : join the chat for the given link/name\r\n\r\n- pay(nb_of_coins, blogId, chatId, objectId, transactionId) : give coins in balance, transactionId not necessary (automatically generated if not put)\r\n\r\n- get_wallet_amount() : return the number of coin of the bot\r\n\r\n- get_member_title(userId) : return the titles of the member\r\n\r\n- get_member_level(userId) : return the level of the member [1-20]\r\n\r\n- leave_community() : leave the current community\r\n\r\n- get_chat_id(chat) : return the id of the chat (link supported)\r\n\r\n- ask_amino_staff(message) : send the message to all the curators/leader of the amino\r\n\r\n- get_user_id(name_or_id) : return a tuple with the name and the userId (name, uid)\r\n\r\n- get_staff(community) : return the staff of the given community (communityId or aminoId)\r\n\r\n- accept_role(noticeId, chatId) : accept a promotion or a chat transfert\r\n\r\n- generate_transaction_id() : create a transactionId\r\n\r\n- ask_all_members(message) : will send a message in pv to all member by group of 100\r\n\r\n- is_it_bot(userId) : check if the user is the bot account\r\n\r\n- add_community(\"aminoId\") : add manually a community to the bot (nice for join amino command)\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A library to create Amino bots.",
"version": "1.28.1",
"split_keywords": [
"aminoapps",
"amino-py",
"amino",
"amino-bot",
"narvii",
"api",
"python",
"python3",
"python3.x",
"thephoenix78",
"aminobot",
"botamino",
"botamino",
"aminobot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "512d1d0b1f3542142ac9cc3525423de95e3722e195e42d3bf7c67d2af542a216",
"md5": "85cfbae6285235e8276d062964040ae8",
"sha256": "2f3b0a5362aace88e39a07939fc64c47b8c725c9ecffbb6f498be5be5533204d"
},
"downloads": -1,
"filename": "BotAmino-1.28.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "85cfbae6285235e8276d062964040ae8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 94901,
"upload_time": "2023-03-10T09:17:17",
"upload_time_iso_8601": "2023-03-10T09:17:17.909829Z",
"url": "https://files.pythonhosted.org/packages/51/2d/1d0b1f3542142ac9cc3525423de95e3722e195e42d3bf7c67d2af542a216/BotAmino-1.28.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f14482426ade0c8f6f257dddfc5d9b797176a05027d19317e94a958c5cf4d57d",
"md5": "7bc6e4716f2b6102bc3058e341a7ae82",
"sha256": "9a683d80fd44cd17130376beb4ee9b75f4083b8abb7a014d93083d8a9d54c792"
},
"downloads": -1,
"filename": "BotAmino-1.28.1.tar.gz",
"has_sig": false,
"md5_digest": "7bc6e4716f2b6102bc3058e341a7ae82",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 88411,
"upload_time": "2023-03-10T09:17:20",
"upload_time_iso_8601": "2023-03-10T09:17:20.604563Z",
"url": "https://files.pythonhosted.org/packages/f1/44/82426ade0c8f6f257dddfc5d9b797176a05027d19317e94a958c5cf4d57d/BotAmino-1.28.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-10 09:17:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ThePhoenix78",
"github_project": "AminoBot",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "botamino"
}
JSON
