pywhatkit Documentation

You can use pywhatkit.start_server() to turn your PC into a remote-controlled device via a phone browser.

Requirements & Setup:

1. Windows Only: This feature is only supported on Windows.
2. Network: Both PC and phone must be on the same network.
3. Network Profile: On your PC, ensure the Network Profile is set to Private (Network and Internet Settings > Properties > Network Profile).
4. Execution:
   • Run pywhatkit.start_server() in your Python script.
   • Open Command Prompt on your PC and run ipconfig to find your IPv4 Address.
   • On your phone's browser, navigate to [YOUR_IPv4_ADDRESS]:8000 (e.g., 192.168.0.1:8000).

Once connected, you can move the cursor, type, and scroll using your phone.

import pywhatkit
pywhatkit.start_server()

Install PyWhatKit using pip. The library officially supports Python 3.8+.

python3 -m pip install pywhatkit

Use pywhatkit.image_to_ascii_art() to convert an image file into a string of ASCII characters.

import pywhatkit

# Converting image to ASCII Art
  ascii_art = pywhatkit.image_to_ascii_art("image path")
  print(ascii_art)

Use pywhatkit.sendwhatmsg_to_group() to schedule a message to a WhatsApp group using its Group ID. Use pywhatkit.sendwhatmsg_to_group_instantly() to send a message to a group immediately without scheduling.

import pywhatkit

# Send a WhatsApp Message to a Group at 12:00 AM
pywhatkit.sendwhatmsg_to_group("AB123CDEFGHijklmn", "Hey All!", 0, 0)

# Send a WhatsApp Message to a Group instantly
pywhatkit.sendwhatmsg_to_group_instantly("AB123CDEFGHijklmn", "Hey All!")

Use pywhatkit.playonyt() to search for and play a specific video on YouTube.

import pywhatkit

# Play a Video on YouTube
pywhatkit.playonyt("PyWhatKit")

Use pywhatkit.sendwhats_image() to send an image.

• To send to a group, provide the Group ID.
• To send to a contact, provide the phone number with +.

If a caption is provided, it will be sent with the image. If no caption is provided, the image is sent alone.

import pywhatkit

# Send an Image to a Group with the Caption as Hello
pywhatkit.sendwhats_image("AB123CDEFGHijklmn", "Images/Hello.png", "Hello")

# Send an Image to a Contact with no Caption
pywhatkit.sendwhats_image("+910123456789", "Images/Hello.png")

Use pywhatkit.sendwhatmsg() with additional parameters to automatically close the browser tab after sending the message.

Parameters:

• phone_no: Contact number with +.
• message: The text to send.
• time_hour: Hour (24h format).
• time_min: Minute.
• wait_time: Seconds to wait before sending (default is 15).
• tab_close: Boolean to close the tab after sending.
• close_time: Seconds to wait after sending before closing the tab.

import pywhatkit

# Same as above but Closes the Tab in 2 Seconds after Sending the Message
pywhatkit.sendwhatmsg("+910123456789", "Hi", 13, 30, 15, True, 2)

Use pywhatkit.sendwhatmsg() to schedule a WhatsApp message to a specific contact. You must provide the phone number in international format (including the + sign), the message string, and the hour and minute in 24-hour format.

import pywhatkit

# Send a WhatsApp Message to a Contact at 1:30 PM
pywhatkit.sendwhatmsg("+910123456789", "Hi", 13, 30)