rh314 / pyVNC

VNC Client Library for Python

fork notes:

This was forked from https://github.com/cair/pyVNC.
To make it work on macOS Mojave and Python 3.7.3, the following changes were needed:

• Mac doesn't allow canvas updates from non-main threads. I solved this by not subclassing class Client from Thread (in pyVNC/Client.py ) and by starting it with .run instead of .start.
• pyVNC/pyDes.py:__String_to_BitList: Python 2 vs 3 handling of bytes vs str is always a mess. Dropped python 2 support and handled the case where the input was a list of bytes instead of just bytes.
• pyVNC/rfb.py:RFBDes:setKey: More Python 2 vs 3 bytes issues. Forced characters to bytes by encoding them as latin-1.
• You need to install and reinstall some libraries as well as per:
  pygame/pygame#555 (comment)

pyVNC

pyVNC Client is a client library for interacting programatically (and physically) with a VNC session. pyVNC Client that is built with Twisted-Python and PyGame.

The client supports the following encodings: Hextile, CoRRE, RRE, RAW, CopyRect

pyVNC is tested for Python >= 3.5

Usage

Example 1

 vnc = VNCClient(host="127.0.0.1",
                 password=None, 
                 port=5902,
                 depth=32,
                 fast=False,
                 shared=True) # Default parameters
                 
 vnc.start()    # Starts the vnc client (Threaded)
 
 vnc.send_key("a") # Sends the key "a"
 vnc.send_mouse("Left", (200, 200)) # Left Clicks at x=200, y=200
 vnc.send_mouse("Right", (200, 200)) # Right Clicks at x=200, y=200
 vnc.get_screen() # Get a array representation of the screen shape: (?, ?, 3)
 vnc.join() # Exit

Parameters

pyVNC.py --host=127.0.0.1 --password=None --depth=32 --fast=False, shared=False

What is it good for?

pyVNC is excellent for automating tasks inside a VNC session.

References:

• http://homepage.hispeed.ch/py430/python/
• http://code.google.com/p/vnc2flv/
• http://arkaitzj.wordpress.com/2011/11/12/vnc-in-your-browser-through-websockets-handled-by-gevent/
• http://sibson.github.io/vncdotool/
• http://www.python.org
• http://twistedmatrix.com/
• http://www.pygame.org
• http://www.realvnc.org

Copyright Notice

Thanks to the original authors for providing an excellent implemenation of the VNC protocol in python. This project would not have been possible with their work:

• (c) 2003 chris [e-mail]
• (c) 2009 techtonik [e-mail]

And pyVNC author:

• (c) 2017 Per-Arne Andersen [e-mail]

Released under the MIT License.

You're free to use it for commercial and noncommercial application, modify and redistribute it as long as the copyright notices are intact. There are no warranties, not even that it does what it says to do ;-)

Changes

16.08.17 - Forked and reworked as a client library