mgorny / python-mss

An ultra fast cross-platform multiple screenshots module in pure Python using ctypes.

Python MSS

from mss import mss

# The simplest use, save a screen shot of the 1st monitor
with mss() as sct:
    sct.shot()

An ultra fast cross-platform multiple screenshots module in pure python using ctypes.

• Python 3.8+, PEP8 compliant, no dependency, thread-safe;
• very basic, it will grab one screen shot by monitor or a screen shot of all monitors and save it to a PNG file;
• but you can use PIL and benefit from all its formats (or add yours directly);
• integrate well with Numpy and OpenCV;
• it could be easily embedded into games and other software which require fast and platform optimized methods to grab screen shots (like AI, Computer Vision);
• get the source code on GitHub;
• learn with a bunch of examples;
• you can report a bug;
• need some help? Use the tag python-mss on StackOverflow;
• and there is a complete, and beautiful, documentation :)
• MSS stands for Multiple Screen Shots;

Installation

You can install it with pip:

python -m pip install -U --user mss

Or you can install it with conda:

conda install -c conda-forge python-mss

Maintenance

For the maintainers, here are commands to upload a new release:

rm -rf build dist
python -m build
twine check dist/*
twine upload dist/*