https://github.com/cair/pyvnc
VNC Client Library for Python
https://github.com/cair/pyvnc
Last synced: 14 days ago
JSON representation
VNC Client Library for Python
- Host: GitHub
- URL: https://github.com/cair/pyvnc
- Owner: cair
- Created: 2017-08-16T20:19:57.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T03:32:29.000Z (about 2 years ago)
- Last Synced: 2025-03-27T03:35:11.809Z (about 1 month ago)
- Language: Python
- Size: 58.6 KB
- Stars: 104
- Watchers: 7
- Forks: 35
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pyVNC
pyVNC Client is a client library for interacting programatically (and physically) with a VNC session.
pyVNC Client that is built with
[Twisted-Python](https://twistedmatrix.com/trac/) and
[PyGame](http://www.pygame.org/).
The client supports the following encodings: `Hextile, CoRRE, RRE, RAW, CopyRect`
pyVNC is tested for `Python >= 3.5`
#Usage
## Example 1
```py
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
- (c) 2009 techtonik
And pyVNC author:
- (c) 2017 Per-Arne Andersen
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