RDPpy
RDPpy is a Python-based toolkit (or library) designed to work with Remote Desktop Protocol (RDP) sessions. It aims to provide functionality such as connecting to RDP servers, automating certain tasks, capturing or replaying sessions — depending on the module implementations.
- Introduction
- Features
- Installation
- Usage
- Dependencies
- Configuration
- Examples
- Troubleshooting
- Contributors
- Connect to an RDP server (host, port, username/password)
- Automate login or session tasks
- Capture RDP session output or screenshots
- Replay or log session data for auditing or debugging
- (Add any other specific features from the code)
-
Clone the repository:
git clone https://github.com/FiePaw/RDPpy.git cd RDPpy -
(Optional) Create and activate a virtual environment:
python3 -m venv venv source venv/bin/activate -
Install via pip (if a
setup.pyorpyproject.tomlexists):pip install .Or install dependencies manually:
pip install -r requirements.txt
Here are example commands and code snippets:
from rdp_py import RDPClient
client = RDPClient(host='10.0.0.1', port=3389, username='user', password='pass')
client.connect()
# … perform actions …
client.disconnect()Or via CLI (if implemented):
rdppy --host 10.0.0.1 --user user --pass pass(Replace with actual usage details from the project.)
- Python 3.x (minimum version to be specified)
- Additional libraries (list them, e.g.
pywin32,rdp, etc.) - Platform notes (works on Windows/Linux/macOS?)
If there are configuration files or environment variables, outline them here. For example:
RDPPY_HOST— host addressRDPPY_PORT— port (default 3389)RDPPY_LOG_LEVEL— debug/info
More detailed walkthroughs:
- Basic connection – Steps and expected output
- Session capture – How to capture and replay a session
- Automation – Running commands after login
- If the connection fails: check firewall/port 3389 is open
- Authentication errors: verify credentials, domain, and NLA settings
- On Linux/macOS: ensure any required native libraries or dependencies are installed