pixel-forge


Namepixel-forge JSON
Version 0.1.1 PyPI version JSON
download
home_pageNone
SummaryUltra-fast screen capture in Rust with Python bindings
upload_time2024-04-20 19:57:58
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8.0
licenseNone
keywords screenshot window capture
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pixel forge  [![Python Version]][Python Version URL] [![Rust]][Rust URL] [![Version]][Version URL] [![Licence]][License URL] [![Build Status]][Build Status URL] [![Docs Status]][Docs URL]


[Licence]: https://img.shields.io/badge/license-MIT-blue
[License URL]: https://github.com/amacati/pixel_forge/blob/master/LICENSE

[Build Status]: https://img.shields.io/github/actions/workflow/status/amacati/pixel_forge/CI.yml
[Build Status URL]: https://github.com/amacati/pixel_forge

[Version]: https://img.shields.io/pypi/v/pixel-forge
[Version URL]: https://pypi.org/project/pixel-forge/

[Python Version]: https://img.shields.io/pypi/pyversions/pixel-forge?logo=python
[Python Version URL]: https://www.python.org

[Rust]: https://img.shields.io/badge/Rust-x?logo=rust&color=CE412B
[Rust URL]: https://www.rust-lang.org/

[Docs Status]: https://readthedocs.org/projects/pixel-forge/badge/?version=latest
[Docs URL]: https://pixel-forge.readthedocs.io/en/latest

<p align="center">
  <img width="256" height="256" src="https://raw.githubusercontent.com/amacati/pixel_forge/master/docs/img/pixel_forge_banner.png">
</p>

Ultra-fast screen capture in Rust with Python bindings

## Installing

The package can be installed via

```bash
pip install pixel_forge
```

## Example

```python
import time

import numpy as np
from pixel_forge import Capture, Monitor, Window, foreground_window

c = Capture()
m = Monitor()
c.start(m)
img = c.frame()
c.stop()
assert isinstance(img, np.ndarray)

w: Window = foreground_window()
c.start(w)
img1 = c.frame()
time.sleep(1)
img2 = c.frame()  # Returns the most recent frame
c.stop()
```

## Documentation
For a more detailed description of the package, visit our [documentation][Docs URL].

## Credit
This package started as a rewrite of [windows-capture](https://github.com/NiiightmareXD/windows-capture), and a good chunk of the implementation is taken directly from that project. Full credit goes to [NiiightmareXD](https://github.com/NiiightmareXD) for those parts.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pixel-forge",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8.0",
    "maintainer_email": null,
    "keywords": "screenshot, window, capture",
    "author": null,
    "author_email": "Martin Schuck <real.amacati@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/92/ef/aa7dafbdfbbbff8486c4b3355b7cce1bf2eace42e0299dc2191c1cfd7b56/pixel_forge-0.1.1.tar.gz",
    "platform": null,
    "description": "# pixel forge&emsp; [![Python Version]][Python Version URL] [![Rust]][Rust URL] [![Version]][Version URL] [![Licence]][License URL] [![Build Status]][Build Status URL] [![Docs Status]][Docs URL]\r\n\r\n\r\n[Licence]: https://img.shields.io/badge/license-MIT-blue\r\n[License URL]: https://github.com/amacati/pixel_forge/blob/master/LICENSE\r\n\r\n[Build Status]: https://img.shields.io/github/actions/workflow/status/amacati/pixel_forge/CI.yml\r\n[Build Status URL]: https://github.com/amacati/pixel_forge\r\n\r\n[Version]: https://img.shields.io/pypi/v/pixel-forge\r\n[Version URL]: https://pypi.org/project/pixel-forge/\r\n\r\n[Python Version]: https://img.shields.io/pypi/pyversions/pixel-forge?logo=python\r\n[Python Version URL]: https://www.python.org\r\n\r\n[Rust]: https://img.shields.io/badge/Rust-x?logo=rust&color=CE412B\r\n[Rust URL]: https://www.rust-lang.org/\r\n\r\n[Docs Status]: https://readthedocs.org/projects/pixel-forge/badge/?version=latest\r\n[Docs URL]: https://pixel-forge.readthedocs.io/en/latest\r\n\r\n<p align=\"center\">\r\n  <img width=\"256\" height=\"256\" src=\"https://raw.githubusercontent.com/amacati/pixel_forge/master/docs/img/pixel_forge_banner.png\">\r\n</p>\r\n\r\nUltra-fast screen capture in Rust with Python bindings\r\n\r\n## Installing\r\n\r\nThe package can be installed via\r\n\r\n```bash\r\npip install pixel_forge\r\n```\r\n\r\n## Example\r\n\r\n```python\r\nimport time\r\n\r\nimport numpy as np\r\nfrom pixel_forge import Capture, Monitor, Window, foreground_window\r\n\r\nc = Capture()\r\nm = Monitor()\r\nc.start(m)\r\nimg = c.frame()\r\nc.stop()\r\nassert isinstance(img, np.ndarray)\r\n\r\nw: Window = foreground_window()\r\nc.start(w)\r\nimg1 = c.frame()\r\ntime.sleep(1)\r\nimg2 = c.frame()  # Returns the most recent frame\r\nc.stop()\r\n```\r\n\r\n## Documentation\r\nFor a more detailed description of the package, visit our [documentation][Docs URL].\r\n\r\n## Credit\r\nThis package started as a rewrite of [windows-capture](https://github.com/NiiightmareXD/windows-capture), and a good chunk of the implementation is taken directly from that project. Full credit goes to [NiiightmareXD](https://github.com/NiiightmareXD) for those parts.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Ultra-fast screen capture in Rust with Python bindings",
    "version": "0.1.1",
    "project_urls": {
        "Documentation": "https://pixel-forge.readthedocs.io/en/latest",
        "Repository": "https://github.com/amacati/pixel_forge"
    },
    "split_keywords": [
        "screenshot",
        " window",
        " capture"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1c33f94bf86e4ced4c49fb2124fca7ab71d882b3c4aa8930dc7a95872482683d",
                "md5": "b7b0dcc96186f8cb1934a34430426b4c",
                "sha256": "96aa1b8ebe5d6a2a1d58a4ba08c3e11a7f2e97cff2f4a32440ee34f417e215e5"
            },
            "downloads": -1,
            "filename": "pixel_forge-0.1.1-cp310-none-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "b7b0dcc96186f8cb1934a34430426b4c",
            "packagetype": "bdist_wheel",
            "python_version": "cp310",
            "requires_python": ">=3.8.0",
            "size": 170938,
            "upload_time": "2024-04-20T19:57:49",
            "upload_time_iso_8601": "2024-04-20T19:57:49.880022Z",
            "url": "https://files.pythonhosted.org/packages/1c/33/f94bf86e4ced4c49fb2124fca7ab71d882b3c4aa8930dc7a95872482683d/pixel_forge-0.1.1-cp310-none-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ce5416b16c5b78e1383e012312485254599bcf280c716d39623eb2ef2b2bd534",
                "md5": "1ee0129c8b9bb2e147e39a17a3c1858d",
                "sha256": "c121e0326c255acf4e29b0cf4c875a6b0f960bec5ed10df9afd98bdc77c91622"
            },
            "downloads": -1,
            "filename": "pixel_forge-0.1.1-cp311-none-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "1ee0129c8b9bb2e147e39a17a3c1858d",
            "packagetype": "bdist_wheel",
            "python_version": "cp311",
            "requires_python": ">=3.8.0",
            "size": 171085,
            "upload_time": "2024-04-20T19:57:51",
            "upload_time_iso_8601": "2024-04-20T19:57:51.783806Z",
            "url": "https://files.pythonhosted.org/packages/ce/54/16b16c5b78e1383e012312485254599bcf280c716d39623eb2ef2b2bd534/pixel_forge-0.1.1-cp311-none-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "97d499ef241c09d7714ad12aa011f2e5a5e319975524dba356482b6b7d8b0eb7",
                "md5": "ad61e8d6274178899ef4768fc04eb1d4",
                "sha256": "fca17eedab3662a88e0424e22794a7ed2b45215326d3f3181ce0817695a38c82"
            },
            "downloads": -1,
            "filename": "pixel_forge-0.1.1-cp312-none-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "ad61e8d6274178899ef4768fc04eb1d4",
            "packagetype": "bdist_wheel",
            "python_version": "cp312",
            "requires_python": ">=3.8.0",
            "size": 169194,
            "upload_time": "2024-04-20T19:57:53",
            "upload_time_iso_8601": "2024-04-20T19:57:53.575692Z",
            "url": "https://files.pythonhosted.org/packages/97/d4/99ef241c09d7714ad12aa011f2e5a5e319975524dba356482b6b7d8b0eb7/pixel_forge-0.1.1-cp312-none-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0438863fef17f13631ca2c3480e22fe015309c0538a8ed0a494ffcf11115101b",
                "md5": "d228a6332117735c3e2e1e85f2c4f224",
                "sha256": "8ebe1ce97e1873f59ddd093adbd44c8dfc2fcf1427ab459aa7b8d39ad4bd1490"
            },
            "downloads": -1,
            "filename": "pixel_forge-0.1.1-cp38-none-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "d228a6332117735c3e2e1e85f2c4f224",
            "packagetype": "bdist_wheel",
            "python_version": "cp38",
            "requires_python": ">=3.8.0",
            "size": 171051,
            "upload_time": "2024-04-20T19:57:55",
            "upload_time_iso_8601": "2024-04-20T19:57:55.362367Z",
            "url": "https://files.pythonhosted.org/packages/04/38/863fef17f13631ca2c3480e22fe015309c0538a8ed0a494ffcf11115101b/pixel_forge-0.1.1-cp38-none-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fd60b72eb5ea7edee359fa5b09e670ea7ecdbac8fbc967b89d6407a9bb2da23c",
                "md5": "016ad24c5a7a87b3505a6df7bb3e0184",
                "sha256": "7e06c0fd05276d84da389c4edcec264d2320a835f891af2cd6b56f517fa99490"
            },
            "downloads": -1,
            "filename": "pixel_forge-0.1.1-cp39-none-win_amd64.whl",
            "has_sig": false,
            "md5_digest": "016ad24c5a7a87b3505a6df7bb3e0184",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.8.0",
            "size": 170816,
            "upload_time": "2024-04-20T19:57:57",
            "upload_time_iso_8601": "2024-04-20T19:57:57.256461Z",
            "url": "https://files.pythonhosted.org/packages/fd/60/b72eb5ea7edee359fa5b09e670ea7ecdbac8fbc967b89d6407a9bb2da23c/pixel_forge-0.1.1-cp39-none-win_amd64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "92efaa7dafbdfbbbff8486c4b3355b7cce1bf2eace42e0299dc2191c1cfd7b56",
                "md5": "4f584b0c743be77b8b8d54d29285455c",
                "sha256": "ca68118acf950cc1991465e6c94d5b0a87161260c15f9c541a6e3b6ebce00fca"
            },
            "downloads": -1,
            "filename": "pixel_forge-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "4f584b0c743be77b8b8d54d29285455c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.0",
            "size": 168663,
            "upload_time": "2024-04-20T19:57:58",
            "upload_time_iso_8601": "2024-04-20T19:57:58.931527Z",
            "url": "https://files.pythonhosted.org/packages/92/ef/aa7dafbdfbbbff8486c4b3355b7cce1bf2eace42e0299dc2191c1cfd7b56/pixel_forge-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-20 19:57:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "amacati",
    "github_project": "pixel_forge",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pixel-forge"
}
        
Elapsed time: 0.21877s