# 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 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](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 [StackOverflow](https://stackoverflow.com/questions/tagged/python-mss);
- and there is a [complete, and beautiful, documentation](https://python-mss.readthedocs.io) :)
- **MSS** stands for Multiple Screen Shots;
## 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
```
## Maintenance
For the maintainers, here are commands to upload a new release:
```shell
rm -rf build dist
python -m build
twine check dist/*
twine upload dist/*
```
Raw data
{
"_id": null,
"home_page": "https://github.com/BoboTiG/python-mss",
"name": "mss",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "screen,screenshot,screencapture,screengrab",
"author": "Micka\u00ebl 'Tiger-222' Schoentgen",
"author_email": "contact@tiger-222.fr",
"download_url": "https://files.pythonhosted.org/packages/88/ac/d98826a39267b67d8c07bda0137fb68f3d08345e96a308d2c0f2578f7beb/mss-9.0.1.tar.gz",
"platform": "Darwin",
"description": "# Python MSS\n\n[![PyPI version](https://badge.fury.io/py/mss.svg)](https://badge.fury.io/py/mss)\n[![Anaconda version](https://anaconda.org/conda-forge/python-mss/badges/version.svg)](https://anaconda.org/conda-forge/python-mss)\n[![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)\n[![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)\n\n```python\nfrom mss import mss\n\n# The simplest use, save a screen shot of the 1st monitor\nwith mss() as sct:\n sct.shot()\n```\n\nAn ultra fast cross-platform multiple screenshots module in pure python using ctypes.\n\n- **Python 3.8+**, PEP8 compliant, no dependency, thread-safe;\n- very basic, it will grab one screen shot by monitor or a screen shot of all monitors and save it to a PNG file;\n- but you can use PIL and benefit from all its formats (or add yours directly);\n- integrate well with Numpy and OpenCV;\n- 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);\n- get the [source code on GitHub](https://github.com/BoboTiG/python-mss);\n- learn with a [bunch of examples](https://python-mss.readthedocs.io/examples.html);\n- you can [report a bug](https://github.com/BoboTiG/python-mss/issues);\n- need some help? Use the tag *python-mss* on [StackOverflow](https://stackoverflow.com/questions/tagged/python-mss);\n- and there is a [complete, and beautiful, documentation](https://python-mss.readthedocs.io) :)\n- **MSS** stands for Multiple Screen Shots;\n\n\n## Installation\n\nYou can install it with pip:\n\n```shell\npython -m pip install -U --user mss\n```\n\nOr you can install it with conda:\n\n```shell\nconda install -c conda-forge python-mss\n```\n\n## Maintenance\n\nFor the maintainers, here are commands to upload a new release:\n\n```shell\nrm -rf build dist\npython -m build\ntwine check dist/*\ntwine upload dist/*\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An ultra fast cross-platform multiple screenshots module in pure python using ctypes.",
"version": "9.0.1",
"split_keywords": [
"screen",
"screenshot",
"screencapture",
"screengrab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1c22e61c6c9fa3730f5ac816f12514947ebfbd42340c56807a7a81b4b7cd5786",
"md5": "779925d3d77306ac416a20215319a79e",
"sha256": "7ee44db7ab14cbea6a3eb63813c57d677a109ca5979d3b76046e4bddd3ca1a0b"
},
"downloads": -1,
"filename": "mss-9.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "779925d3d77306ac416a20215319a79e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 22193,
"upload_time": "2023-04-20T05:46:41",
"upload_time_iso_8601": "2023-04-20T05:46:41.795605Z",
"url": "https://files.pythonhosted.org/packages/1c/22/e61c6c9fa3730f5ac816f12514947ebfbd42340c56807a7a81b4b7cd5786/mss-9.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "88acd98826a39267b67d8c07bda0137fb68f3d08345e96a308d2c0f2578f7beb",
"md5": "d4518ae452d7a9f996f9bba5fa161a97",
"sha256": "6eb7b9008cf27428811fa33aeb35f3334db81e3f7cc2dd49ec7c6e5a94b39f12"
},
"downloads": -1,
"filename": "mss-9.0.1.tar.gz",
"has_sig": false,
"md5_digest": "d4518ae452d7a9f996f9bba5fa161a97",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 87504,
"upload_time": "2023-04-20T05:46:45",
"upload_time_iso_8601": "2023-04-20T05:46:45.394473Z",
"url": "https://files.pythonhosted.org/packages/88/ac/d98826a39267b67d8c07bda0137fb68f3d08345e96a308d2c0f2578f7beb/mss-9.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-20 05:46:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "BoboTiG",
"github_project": "python-mss",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mss"
}