https://github.com/bobotig/python-mss

An ultra fast cross-platform multiple screenshots module in pure Python using ctypes.
https://github.com/bobotig/python-mss

cli cross-platform ctypes efficiency gnu-linux macos monitor mss python python-library python-mss screenshot windows

Last synced: 3 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/bobotig/python-mss
• Owner: BoboTiG
• License: mit
• Created: 2013-07-01T16:14:08.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2024-10-21T12:49:21.000Z (3 months ago)
• Last Synced: 2024-10-21T19:48:44.502Z (3 months ago)
• Topics: cli, cross-platform, ctypes, efficiency, gnu-linux, macos, monitor, mss, python, python-library, python-mss, screenshot, windows
• Language: Python
• Homepage: https://pypi.org/project/mss/
• Size: 1.17 MB
• Stars: 1,012
• Watchers: 14
• Forks: 93
• Open Issues: 41
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Python MSS

[![PyPI version](https://badge.fury.io/py/mss.svg)](https://badge.fury.io/py/mss)

[![Anaconda version](https://anaconda.org/conda-forge/python-mss/badges/version.svg)](https://anaconda.org/conda-forge/python-mss)

[![Tests workflow](https://github.com/BoboTiG/python-mss/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/BoboTiG/python-mss/actions/workflows/tests.yml)

[![Downloads](https://static.pepy.tech/personalized-badge/mss?period=total&units=international_system&left_color=black&right_color=orange&left_text=Downloads)](https://pepy.tech/project/mss)

```python

from mss import mss

# The simplest use, save a screenshot 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.9+**, PEP8 compliant, no dependency, thread-safe;

- very basic, it will grab one screenshot by monitor or a screenshot 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 screenshots (like AI, Computer Vision);

- get the [source code on GitHub](https://github.com/BoboTiG/python-mss);

- learn with a [bunch of examples](https://python-mss.readthedocs.io/examples.html);

- you can [report a bug](https://github.com/BoboTiG/python-mss/issues);

- need some help? Use the tag *python-mss* on [Stack Overflow](https://stackoverflow.com/questions/tagged/python-mss);

- and there is a [complete, and beautiful, documentation](https://python-mss.readthedocs.io) :)

- **MSS** stands for Multiple ScreenShots;

## Installation

You can install it with pip:

```shell

python -m pip install -U --user mss

```

Or you can install it with Conda:

```shell

conda install -c conda-forge python-mss

```