mss


Namemss JSON
Version 10.0.0 PyPI version JSON
download
home_pageNone
SummaryAn ultra fast cross-platform multiple screenshots module in pure python using ctypes.
upload_time2024-11-14 09:37:07
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT License Copyright (c) 2013-2024, Mickaël 'Tiger-222' Schoentgen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords bitblt cggetactivedisplaylist cgimagegetbitsperpixel enumdisplaymonitors xgetimage xgetwindowattributes xrrgetscreenresourcescurrent ctypes monitor screen screencapture screengrab screenshot
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mss",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "Micka\u00ebl Schoentgen <contact@tiger-222.fr>",
    "keywords": "BitBlt, CGGetActiveDisplayList, CGImageGetBitsPerPixel, EnumDisplayMonitors, XGetImage, XGetWindowAttributes, XRRGetScreenResourcesCurrent, ctypes, monitor, screen, screencapture, screengrab, screenshot",
    "author": null,
    "author_email": "Micka\u00ebl Schoentgen <contact@tiger-222.fr>",
    "download_url": "https://files.pythonhosted.org/packages/be/2c/6a50c69793918502b4391729bd5741964c9f8ccc98c8482d4a680384923b/mss-10.0.0.tar.gz",
    "platform": null,
    "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 screenshot 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.9+**, PEP8 compliant, no dependency, thread-safe;\n- very basic, it will grab one screenshot by monitor or a screenshot 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 screenshots (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 [Stack Overflow](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 ScreenShots;\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",
    "bugtrack_url": null,
    "license": "MIT License Copyright (c) 2013-2024, Micka\u00ebl 'Tiger-222' Schoentgen  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "An ultra fast cross-platform multiple screenshots module in pure python using ctypes.",
    "version": "10.0.0",
    "project_urls": {
        "Changelog": "https://github.com/BoboTiG/python-mss/blob/main/CHANGELOG.md",
        "Documentation": "https://python-mss.readthedocs.io",
        "Homepage": "https://github.com/BoboTiG/python-mss",
        "Released Versions": "https://github.com/BoboTiG/python-mss/releases",
        "Source": "https://github.com/BoboTiG/python-mss",
        "Sponsor": "https://github.com/sponsors/BoboTiG",
        "Tracker": "https://github.com/BoboTiG/python-mss/issues"
    },
    "split_keywords": [
        "bitblt",
        " cggetactivedisplaylist",
        " cgimagegetbitsperpixel",
        " enumdisplaymonitors",
        " xgetimage",
        " xgetwindowattributes",
        " xrrgetscreenresourcescurrent",
        " ctypes",
        " monitor",
        " screen",
        " screencapture",
        " screengrab",
        " screenshot"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "29aab897ae9e1c1616e4df9fb319637ef6a9d07cca6d46de6b59c80209f006a4",
                "md5": "6adc75306c9aa1d2f07f631c3b75a43e",
                "sha256": "82cf6460a53d09e79b7b6d871163c982e6c7e9649c426e7b7591b74956d5cb64"
            },
            "downloads": -1,
            "filename": "mss-10.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6adc75306c9aa1d2f07f631c3b75a43e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 24050,
            "upload_time": "2024-11-14T09:37:06",
            "upload_time_iso_8601": "2024-11-14T09:37:06.139741Z",
            "url": "https://files.pythonhosted.org/packages/29/aa/b897ae9e1c1616e4df9fb319637ef6a9d07cca6d46de6b59c80209f006a4/mss-10.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "be2c6a50c69793918502b4391729bd5741964c9f8ccc98c8482d4a680384923b",
                "md5": "a02a98d33d21c0b5dfb93afa599584f6",
                "sha256": "d903e0d51262bf0f8782841cf16eaa6d7e3e1f12eae35ab41c2e318837c6637f"
            },
            "downloads": -1,
            "filename": "mss-10.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a02a98d33d21c0b5dfb93afa599584f6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 83127,
            "upload_time": "2024-11-14T09:37:07",
            "upload_time_iso_8601": "2024-11-14T09:37:07.848283Z",
            "url": "https://files.pythonhosted.org/packages/be/2c/6a50c69793918502b4391729bd5741964c9f8ccc98c8482d4a680384923b/mss-10.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-14 09:37:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "BoboTiG",
    "github_project": "python-mss",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mss"
}
        
Elapsed time: 0.97663s