Skip to main content

A python package for screen recording with customizable resolution, FPS, and mouse tracking.

Project description

PyPI version Python Versions Downloads Downloads

Python Screen Recorder

Python screen recorder also pyscreenrecorder is a powerful Python package for screen recording with an optional mouse cursor overlay.
It allows high-performance screen capturing, custom resolution, and real-time mouse tracking.

✨ Features

  • 🎥 Record screen with smooth frame rates (30 FPS default).
  • 🖱 Mouse overlay customization (color, size, thickness).
  • 📺 Multi-monitor support – Choose which monitor to record.
  • 🔄 Set custom resolution (e.g., 1280x720, 1920x1080).
  • Optimized performance with mss for fast screen capture.
  • 🎨 Flexible output formats – Supports .mp4, .avi, and .mkv.
  • 🔍 Monitor detection – List available monitors and their specs.

📦 Installation

Install pyscreenrecorder using pip:

pip install pyscreenrecorder

Upgrade pyscreenrecorder using pip:

pip install pyscreenrecorder -U

🚀 Usage

Basic Screen Recording

from pyscreenrecorder import ScreenRecorder

ScreenRecorder(
    filename="screen_record.mp4",
    duration=10,
    fps=30,
    monitor_number=1,
    mouse=True,
)

📺 Listing Available Monitors

from pyscreenrecorder import pyScreenRecorder

monitors = pyScreenRecorder.list_monitors()
print("Available Monitors:", monitors)

Example Output:

[
  { "monitor": 0, "width": 1920, "height": 1080 },
  { "monitor": 1, "width": 2560, "height": 1440 }
]

🎥 Recording with Custom Settings

from pyscreenrecorder import ScreenRecorder

ScreenRecorder(
    filename="custom_record.mp4",
    duration=15,
    fps=60,
    monitor_number=2,
    resolution=(1280, 720),  # Set custom resolution
    mouse=True,
    mouse_color=(255, 0, 0),  # Red cursor
    mouse_size=10,
    mouse_thickness=3,
)

🔹 60 FPS Recording
🔹 Custom 1280x720 resolution
🔹 Red-colored mouse cursor with increased size

🛠 Advanced Example

from pyscreenrecorder import pyScreenRecorder

if __name__ == "__main__":
    # Display available monitors
    monitors = pyScreenRecorder.list_monitors()
    print("Available Monitors:", monitors)

    # Start recording with advanced settings
    pyRec = pyScreenRecorder(
        filename="high_quality_record.mp4",
        duration=30,
        fps=60,
        monitor_number=1,
        resolution=(1920, 1080),  # Full HD recording
        mouse=True,
        mouse_color=(0, 255, 0),  # Green cursor
        mouse_size=6,
        mouse_thickness=2,
    )
    pyRec.screenRecorder()

⚙ Supported File Formats

pyscreenrecorder supports the following video formats:

Format Description
MP4 High compatibility
AVI Uncompressed quality
MKV Modern, flexible

Set the format by using the appropriate file extension in filename.
Example:

ScreenRecorder(filename="recording.mkv")

🎯 Dependencies

pyscreenrecorder relies on:

  • opencv-python
  • numpy
  • mss
  • pyautogui
  • MouseInfo
  • PyGetWindow
  • PyMsgBox
  • pyperclip
  • PyRect
  • PyScreeze
  • pytweening

No additional configuration is required.


📝 License

This project is licensed under the MIT License.


📚 More Information

📌 GitHub Repository:
🔗 https://github.com/SSujitX/pyscreenrecorder

📌 Issue Tracker:
🐛 Report a Bug


🏁 Conclusion

pyscreenrecorder is an efficient, easy-to-use, and customizable screen recording tool in Python. Whether you need basic screen capturing or advanced mouse-tracked recordings, this package provides all the features.

🚀 Try it today! 🚀

Visitors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyscreenrecorder-0.0.3.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyscreenrecorder-0.0.3-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file pyscreenrecorder-0.0.3.tar.gz.

File metadata

  • Download URL: pyscreenrecorder-0.0.3.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pyscreenrecorder-0.0.3.tar.gz
Algorithm Hash digest
SHA256 41bbca546f061b6daa7f763d6643856ef3ad9fdeb2949d2965d775ca1d99c0eb
MD5 8efda054edc8a14f7e21c87d1a904f0d
BLAKE2b-256 8aa2ff4f2cf9b381a357f87a0ed35efebb5bfb7716b33941454e0b0752c4dd19

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyscreenrecorder-0.0.3.tar.gz:

Publisher: python-publish.yml on SSujitX/pyscreenrecorder

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyscreenrecorder-0.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for pyscreenrecorder-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 dfa3b238549f07c59d0b58c6bef5c1508b65bf3a4588f05e9a75ff5df812f9f3
MD5 e93180b33f8b1212d2d457252f8c72b3
BLAKE2b-256 1fad9d8658850660d63fd369b3d655bd94dee2cdfef7c540c23c56db9c84fc1d

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyscreenrecorder-0.0.3-py3-none-any.whl:

Publisher: python-publish.yml on SSujitX/pyscreenrecorder

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page