Skip to main content

Python framework for interacting with KS-BOT, without any app

Project description

KS-BOT-Client-Python

Python framework for interacting with KS-BOT, without any app

To get started simply install ks-bot-client, with the following command

python -m pip install KS-BOT-Client-Python

After Installation:

  • Simple import ks-bot-client
import ks_bot_client
  • Next create a custom Bot class by inherenting from ks_bot_client.bot class
class CustomBot(ks_bot_client.Bot):

  def __init__(self, name:str, password:str):
    """
      :param {string} name - Either Username, First Name of user or email of user
      :param {string} password - User password
    """

    super().__init__(name, password)


  def WelcomeMessage(self, data):
    """
      This event gives you, your previous messages with ks-bot.

      > Feel free to customize it
    """
    print("KS-BOT said 'welcome'")


  def BotProcessReply(self, data):
    """
      Returns bot reply to the message you sent it

      > Feel free to customize it
    """
    print("KS-BOT said: ", data)


  def TimerOver(self, data):
    """
      Handles Event Server sends when timer is over

      > Feel free to customize it
    """

    print("KS-BOT said: Timer is over, Timer: ", data)
  • Once your custom bot class is ready all that is left is for you to initialize your bot
bot = CustomBot("<your name>", "<your password>")
  • Last but not list all you have to do is run the bot, so it can get and recieve messages from Server
bot.run()
  • Now that your bot is recieving messages from server and can send message to server, Send your first message!
bot.send_command("<your message>", "<the timeZone you want to send the message from, default timeZone is your actual timeZone>")

Developer Notes:

  • But for issues and feature adding, we ask that you do that all on github

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

KS-BOT-Client-Python-1.0.2.tar.gz (4.1 kB view hashes)

Uploaded Source

Built Distribution

KS_BOT_Client_Python-1.0.2-py3-none-any.whl (4.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page