Metadata-Version: 2.1
Name: smdb-api
Version: 0.3.0
Summary: API package for Server Monitoring Discord Bot
Home-page: https://github.com/NightKey/Server-monitoring-discord-bot
Author: Janthó Dávid
Author-email: davidjantho@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/NightKey/Server-monitoring-discord-bot/issues
Description: # Server monitoring Discord bot API
        
        This API can be used to interface with the server monitoring Discord bot only if the API is enabled on it. For this, the bot needs to run on the same PC, or the API needs to be set up to allow outside connections.
        
        ## Usage
        
        To create an api, import the package, and use the required arguments.
        ```
        import smdb_api
        API = smdb_api.API("Test", "80716cbfd9f90428cd308acc193b4b58519a4f10a7440b97aaffecf75e63ecec")
        ```
        
        Avaleable arguments:
         - name:            string              | Used to identify the application to the api server.
         - key:             string              | Used to verify identity with the api server.
         - ip:              string (optional)   | Used to set the api server's IP address.
         - port:            integer (optional)  | Used to set the api server's listening port.
         - update_function: function (optional) | Sets a callback function to call, when the api server updates.
        
        To initiate the connection, use the validate command. The validate function can get a timeout limit, so it won't hault the program, if the api server won't ansvear within a set time.
        
        ```
        API.validate()
        server_status = API.get_status()
        ```
        
        To add a command to the bot, use the 'create_function' command, like shown here:
        
        ```
        [...]
        def my_callback(message):
            #Does something
        
        API.create_function("MyScript", "Shome text to help\nUsage: &MyCommand <User input>\nCategory: SERVER", my_callback)
        ```
        To send a message to someone, use the 'send_message' command:
        
        ```
        [...]
        discordId="##################"
        API.send_message("Test message to a channel", discordId)
        print(f"I sent a message to {API.get_username(discordId)}!")
        ```
        
        Closing the connection safely is easy with the 'close' command.
        
        ```
        [...]
        API.close("Some reason for the bot logger.")
        ```
        
        ## Available commands
        
        ### validate
        
        This function connects to the API server and validates itself with it. If the validation was successful, it starts a listener thread.
        
        ### get_status
        
        This function retrieves the bot's status and returns it in a dictionary.
        
        ### get_username
        
        This command returns the given Discord ID's username.
        
        ### is_admin
        
        Determines if a user is admin in the bot's database.
        
        ### send_message
        
        This command allows you to send messages in the bot's name to selected users/channels or the default channel.
        
        ### create_function
        
        This command creates a function in the bot that can be called by a user.
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: License :: Freeware
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
