ScreenCapLibrary
================
.. contents::
Introduction
------------
ScreenCapLibrary_ is a `Robot Framework`_ test
library for taking screenshots. The project is hosted on GitHub_
and downloads can be found from PyPI_.
ScreenCapLibrary is operating system independent and supports Python_ 2.7 as well
as Python_ 3.4 or newer.
The library is based on RobotFramework's standard Screenshot_ library. It has almost
the same functionality, except that the screenshots are captured in PNG by default.
ScreenCapLibrary has the following extra features:
- Taking screenshots in PNG, JPG/JPEG, GIF and WebP formats
- Video capture in WebM format, embeddable in log files
- Adjusting the compression/quality of the screenshots
- Support for GIFs
- Taking multiple screenshots in a given amount of time
- Support for partial screen captures
- Configurable monitor screen grabbing for screenshots and recording
Documentation
-------------
See `keyword documentation`_ for available keywords and more information
about the library in general.
For general information about using test libraries with Robot Framework, see
`Robot Framework User Guide`_.
Installation
------------
The recommended installation method is using pip_::
pip install --upgrade robotframework-screencaplibrary
Running this command installs also the latest Robot Framework, mss_,
pillow_, opencv-python_ and imageio_ versions. The minimum supported mss version is
``3.2.1`` and the minimum supported pillow version is ``5.2.0``.
For video capture at least version ``4.0.0.21`` of opencv-python_ is required.
The ``--upgrade`` option can be omitted when installing the library for the
first time.
With recent versions of ``pip`` it is possible to install directly from the
GitHub_ repository. To install latest source from the master branch, use
this command::
pip install git+https://github.com/mihaiparvu/ScreenCapLibrary.git
Alternatively you can download the source distribution from PyPI_, extract
it, and install it::
python setup.py install
Usage
-----
To use ScreenCapLibrary in Robot Framework tests, the library needs to first be
imported using the Library setting as any other library.
When using Robot Framework, it is generally recommended to write as
easy-to-understand tests as possible.
.. code:: robotframework
*** Settings ***
Documentation This example demonstrates capturing a screenshot on the local
... machine.
Library ScreenCapLibrary
Library OperatingSystem
Test Teardown Remove File screenshot_1.jpg
*** Test Cases ***
Take A Low File Size Jpg Screenshot
Take Screenshot name=screenshot format=jpg quality=0
File Should Exist screenshot_1.jpg
Using with VNC
--------------
At the time of this release ``mss``, does not work on GNU/Linux with VNC virtual desktop.
As a workaround you can change the ``screenshot_module`` value at library import to ``PyGTK``.
.. code:: robotframework
*** Settings ***
Library ScreenCapLibrary screenshot_module=PyGTK
For this to work you need to have the following dependencies installed.
- With Python 2::
sudo apt install python-gtk2
- With Python 3::
sudo apt install python-gi python-gi-cairo python3-gi python3-gi-cairo gir1.2-gtk-3.0
Support
-------
If the provided documentation is not enough, there are various support forums
available:
- `robotframework-users`_ mailing list
- channels in Robot Framework `Slack community`_
- ScreenCapLibrary `issue tracker`_ for bug reports and concrete enhancement
requests
.. _Robot Framework: http://robotframework.org
.. _Robot Framework User Guide: http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#using-test-libraries
.. _ScreenCapLibrary: https://github.com/mihaiparvu/ScreenCapLibrary
.. _GitHub: https://github.com/mihaiparvu/ScreenCapLibrary
.. _Python: http://python.org
.. _pip: http://pip-installer.org
.. _PyPI: https://pypi.python.org/pypi/robotframework-screencaplibrary
.. _mss: https://python-mss.readthedocs.io
.. _pillow: https://pillow.readthedocs.io
.. _opencv-python: https://opencv-python-tutroals.readthedocs.io
.. _imageio: https://imageio.github.io/
.. _Screenshot: http://robotframework.org/robotframework/latest/libraries/Screenshot.html
.. _Keyword Documentation: https://mihaiparvu.github.io/ScreenCapLibrary/ScreenCapLibrary.html
.. _robotframework-users: http://groups.google.com/group/robotframework-users
.. _Slack community: https://robotframework-slack-invite.herokuapp.com
.. _issue tracker: https://github.com/mihaiparvu/ScreenCapLibrary/issues
Raw data
{
"_id": null,
"home_page": "https://github.com/mihaiparvu/ScreenCapLibrary",
"name": "robotframework-screencaplibrary",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "robotframework testing testautomation screenshot screencap",
"author": "Mihai P\u00e2rvu",
"author_email": "mihai-catalin.parvu@nokia.com",
"download_url": "https://files.pythonhosted.org/packages/58/a3/de838ca823e652e16dc18343fe0e4f5f5e6d61b08f3f7d3fc1b79fc4f690/robotframework-screencaplibrary-1.6.0.tar.gz",
"platform": "any",
"description": "ScreenCapLibrary\n================\n\n.. contents::\n\nIntroduction\n------------\n\nScreenCapLibrary_ is a `Robot Framework`_ test\nlibrary for taking screenshots. The project is hosted on GitHub_\nand downloads can be found from PyPI_.\n\nScreenCapLibrary is operating system independent and supports Python_ 2.7 as well\nas Python_ 3.4 or newer.\n\nThe library is based on RobotFramework's standard Screenshot_ library. It has almost\nthe same functionality, except that the screenshots are captured in PNG by default.\n\nScreenCapLibrary has the following extra features:\n - Taking screenshots in PNG, JPG/JPEG, GIF and WebP formats\n - Video capture in WebM format, embeddable in log files\n - Adjusting the compression/quality of the screenshots\n - Support for GIFs\n - Taking multiple screenshots in a given amount of time\n - Support for partial screen captures\n - Configurable monitor screen grabbing for screenshots and recording\n\nDocumentation\n-------------\n\nSee `keyword documentation`_ for available keywords and more information\nabout the library in general.\n\nFor general information about using test libraries with Robot Framework, see\n`Robot Framework User Guide`_.\n\nInstallation\n------------\n\nThe recommended installation method is using pip_::\n\n pip install --upgrade robotframework-screencaplibrary\n\nRunning this command installs also the latest Robot Framework, mss_,\npillow_, opencv-python_ and imageio_ versions. The minimum supported mss version is\n``3.2.1`` and the minimum supported pillow version is ``5.2.0``.\nFor video capture at least version ``4.0.0.21`` of opencv-python_ is required.\nThe ``--upgrade`` option can be omitted when installing the library for the\nfirst time.\n\nWith recent versions of ``pip`` it is possible to install directly from the\nGitHub_ repository. To install latest source from the master branch, use\nthis command::\n\n pip install git+https://github.com/mihaiparvu/ScreenCapLibrary.git\n\nAlternatively you can download the source distribution from PyPI_, extract\nit, and install it::\n\n python setup.py install\n\nUsage\n-----\n\nTo use ScreenCapLibrary in Robot Framework tests, the library needs to first be\nimported using the Library setting as any other library.\n\nWhen using Robot Framework, it is generally recommended to write as\neasy-to-understand tests as possible.\n\n.. code:: robotframework\n\n *** Settings ***\n Documentation This example demonstrates capturing a screenshot on the local\n ... machine.\n\n Library ScreenCapLibrary\n Library OperatingSystem\n Test Teardown Remove File screenshot_1.jpg\n\n *** Test Cases ***\n Take A Low File Size Jpg Screenshot\n Take Screenshot name=screenshot format=jpg quality=0\n File Should Exist screenshot_1.jpg\n\n\nUsing with VNC\n--------------\n\nAt the time of this release ``mss``, does not work on GNU/Linux with VNC virtual desktop.\nAs a workaround you can change the ``screenshot_module`` value at library import to ``PyGTK``.\n\n.. code:: robotframework\n\n *** Settings ***\n Library ScreenCapLibrary screenshot_module=PyGTK\n\nFor this to work you need to have the following dependencies installed.\n\n- With Python 2::\n\n sudo apt install python-gtk2\n\n- With Python 3::\n\n sudo apt install python-gi python-gi-cairo python3-gi python3-gi-cairo gir1.2-gtk-3.0\n\nSupport\n-------\n\nIf the provided documentation is not enough, there are various support forums\navailable:\n\n- `robotframework-users`_ mailing list\n- channels in Robot Framework `Slack community`_\n- ScreenCapLibrary `issue tracker`_ for bug reports and concrete enhancement\n requests\n\n.. _Robot Framework: http://robotframework.org\n.. _Robot Framework User Guide: http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#using-test-libraries\n.. _ScreenCapLibrary: https://github.com/mihaiparvu/ScreenCapLibrary\n.. _GitHub: https://github.com/mihaiparvu/ScreenCapLibrary\n.. _Python: http://python.org\n.. _pip: http://pip-installer.org\n.. _PyPI: https://pypi.python.org/pypi/robotframework-screencaplibrary\n.. _mss: https://python-mss.readthedocs.io\n.. _pillow: https://pillow.readthedocs.io\n.. _opencv-python: https://opencv-python-tutroals.readthedocs.io\n.. _imageio: https://imageio.github.io/\n.. _Screenshot: http://robotframework.org/robotframework/latest/libraries/Screenshot.html\n.. _Keyword Documentation: https://mihaiparvu.github.io/ScreenCapLibrary/ScreenCapLibrary.html\n.. _robotframework-users: http://groups.google.com/group/robotframework-users\n.. _Slack community: https://robotframework-slack-invite.herokuapp.com\n.. _issue tracker: https://github.com/mihaiparvu/ScreenCapLibrary/issues",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Robot Framework test library for taking screenshots",
"version": "1.6.0",
"project_urls": {
"Homepage": "https://github.com/mihaiparvu/ScreenCapLibrary"
},
"split_keywords": [
"robotframework",
"testing",
"testautomation",
"screenshot",
"screencap"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "58a3de838ca823e652e16dc18343fe0e4f5f5e6d61b08f3f7d3fc1b79fc4f690",
"md5": "4639c347e56db4b2812280f03f02b0be",
"sha256": "0bd6fcb56452125121d9a0cb1a110ea069a87de1937882193320ba4af4c6a132"
},
"downloads": -1,
"filename": "robotframework-screencaplibrary-1.6.0.tar.gz",
"has_sig": false,
"md5_digest": "4639c347e56db4b2812280f03f02b0be",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15699,
"upload_time": "2022-02-21T12:27:16",
"upload_time_iso_8601": "2022-02-21T12:27:16.492923Z",
"url": "https://files.pythonhosted.org/packages/58/a3/de838ca823e652e16dc18343fe0e4f5f5e6d61b08f3f7d3fc1b79fc4f690/robotframework-screencaplibrary-1.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-02-21 12:27:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mihaiparvu",
"github_project": "ScreenCapLibrary",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "robotframework-screencaplibrary"
}
JSON
