Metadata-Version: 2.1
Name: BotAmino
Version: 1.8.4.2
Summary: A library to create Amino bots.
Home-page: https://github.com/ThePhoenix78/AminoBot
Author: ThePhoenix78
Author-email: thephoenix788@gmail.com
License: MIT
Description: # 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
        
        print("wait...")
        client = BotAmino()
        client.prefix = "/"  # set the prefix to /
        client.wait = 10  # wait 10 sec before doing a new command
        
        
        def test(data):
            return data.authorId == ["your_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):
            data.subClient.send_message(data.chatId, message="pong!")
        
        
        @client.command("pong") # "pong" the command, the test function is not necessary
        def ping(data):
            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):
            data.subClient.send_message(data.chatId, message="Hey! Hey!")
        
        
        @client.on_member_join_chat()
        def say_hello(data):
            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):
            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)
        
Keywords: aminoapps,amino-py,amino,amino-bot,narvii,api,python,python3,python3.x,ThePhoenix78,AminoBot,BotAmino,botamino,aminobot
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
