PyScreenGrab

A simple and efficient screen recording and streaming tool written in Python.

✨ Features

• Multiple capture modes(Full Screen/Custom Region/Window)

• Local video recording

• Preview mode

• Adjustable FPS (1-60)

• Timed recording option

• Simple command-line interface

• Reactive streaming support

• 🔴 Note: Window capture may not work properly with virtual monitors. use a physical monitor for best results

📦 Installation

pip install py-screen-grab

🚀 Usage

Command Line Interface

Simply run:

screengrab

Follow the interactive prompts to:

1. Select capture mode (Full Screen/Custom Region/Window)
2. Choose monitor or set region
3. Set FPS
4. Choose recording mode (Preview/Record)
5. Set recording duration (optional)

Python API

1. Custom Region Capture

from py_screen_grab import ScreenGrabber

# Capture a specific region
grabber = ScreenGrabber()
    .set_roi(x=100, y=100, width=800, height=600)
    .set_fps(30)

# Record with preview
grabber.record()

2. Window Capture

from py_screen_grab import ScreenGrabber

# Capture a specific window
# The ROI is automatically set based on the window's position and size
grabber = ScreenGrabber()
    .set_window("Window Title")
    .set_fps(30)

# Record with preview
grabber.record()

3. Streaming

from py_screen_grab import ScreenGrabber

grabber = ScreenGrabber()
    .set_roi(x=0, y=0, width=1920, height=1080)
    .set_fps(30)

# Start streaming
grabber.start_streaming()

📋 Requirements

• wmctrl (required for window management on Linux, especially 🐧Ubuntu)
• Python 3.6 or higher
• OpenCV
• NumPy
• MSS (screen capture library)
• aiortc (for WebRTC streaming)
• rx (for reactive streaming)

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🤝 Contributing

We welcome contributions to this project! Please see our CONTRIBUTING.md for guidelines on how to get started.