{ "info": { "author": "Joel Oliveira, Sofia Nunes", "author_email": ", ", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Framework :: Robot Framework :: Library", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Quality Assurance", "Topic :: Software Development :: Testing" ], "description": "# EyesLibrary for Robot Framework\n\n#### Table of Contents\n\n- [Introduction](#Introduction)\n- [Requirements](#Requirements)\n- [Installation](#Installation)\n- [Directory Layout](#Directory%20Layout)\n- [Usage](#Usage)\n- [Running the Demo](#Running%20the%20Demo)\n- [Things to Note When Using Applitools](#Things%20to%20Note%20When%20Using%20Applitools)\n- [Getting Help](#Getting%20Help)\n- [Credits](#Credits)\n\n## Introduction\n\nEyesLibrary is a Robot Framework Library to automate visual software testing verification. EyesLibrary uses a Python SDK called [Eyes-Selenium](https://pypi.python.org/pypi/eyes-selenium) from the tool [Applitools Eyes](http://applitools.com/), and can be used with the [SeleniumLibrary](https://github.com/robotframework/SeleniumLibrary) and/or the [AppiumLibrary](https://github.com/serhatbolsu/robotframework-appiumlibrary) .\n\nThis library is a fork of [Robot-AppEyes](https://github.com/NaviNet/Robot-AppEyes).\nIn order to use EyesLibrary, you are required to [sign up](https://applitools.com/sign-up/) for a free account with Applitools. See the [Usage](https://github.com/joel-oliveira/EyesLibrary#usage) section.\n\n- Information about EyesLibrary keywords can be found on the [Keyword Documentation](https://joel-oliveira.github.io/EyesLibrary/) page.\n\n- The [Applitools Documentation](https://pypi.org/project/eyes-selenium/) may be consulted in order to understand how Eyes works.\n\n- More information about the SeleniumLibrary can be found on the [SeleniumLibrary Repo](https://github.com/robotframework/SeleniumLibrary) and in the [Keyword Documentation](http://robotframework.org/SeleniumLibrary/SeleniumLibrary.html).\n\n- More information about the AppiumLibrary can be found on the [AppiumLibrary Repo](https://github.com/serhatbolsu/robotframework-appiumlibrary) and in the [Keyword Documentation](http://serhatbolsu.github.io/robotframework-appiumlibrary/AppiumLibrary.html).\n\n## Requirements\n\nThe following versions were used to test the library:\n\n- Python 2.7.14 or 3.6.0\n- Robot Framework 3.1.1\n- Eyes-Selenium 3.16.2\n- SeleniumLibrary 3.3.1 (For Web Tests)\n- AppiumLibrary 1.5.0.3 (For Mobile Tests)\n\n## Installation\n\nThe recommended **installation** method is using [pip](http://pip-installer.org):\n\n pip install robotframework-eyeslibrary\n\nTo **update** both the library and all\nits dependencies to the latest version:\n\n pip install --upgrade robotframework-eyeslibrary\n\nTo install a **specific version**:\n\n pip install robotframework-eyeslibrary==(DesiredVersion)\n\n#### Uninstall\n\nTo uninstall EyesLibrary use the following pip command:\n\n pip uninstall robotframework-eyeslibrary\n\n## Directory Layout\n\n**EyesLibrary/**\n\n  The Robot Framework Python Library that makes use of the Applitools Eyes Python SDK\n\n**tests/acceptance/**\n\n  Test files to display what the keywords from EyesLibrary accomplish\n\n**docs/**\n\n  Documentation for the EyesLibrary: Keyword Documentation and ChangeLog\n\n## Usage\n\nYou must create a [free account](https://applitools.com/sign-up/) with Applitools in order to run\nEyesLibrary and return results.\n\nThen, to use the library, follow [EyesLibrary Keyword Documentation](https://joel-oliveira.github.io/EyesLibrary/).\n\nThis is a Robot Framework library. If you're not familiarized with Robot Framework, \nplease consult [Robot Framework User Guide](http://code.google.com/p/robotframework/wiki/UserGuide).\n\n## Running the Demo\n\nAt _tests/acceptance_ directory, you can find Robot Framework tests for:\n\n- Web\n- Android Browser\n- Android Native App\n- Android Hybrid App\n- iOS Browser\n- iOS Native App\n- iOS Hybrid App\n\nBefore running the tests, your Applitools API Key must be set in _tests/acceptance/resources/common.robot_, by replacing \"YourApplitoolsApiKey\" with your own key.\n\nWhen running the mobile tests, you must replace the variables within _tests/acceptance/resources/mobile.robot_ with your own, as well as the ones in _tests/acceptance/resources/android.robot_ or _tests/acceptance/resources/ios.robot_, according to the OS in use.\n\nFor instance, you may want to use a different Remote URL than the one provided in the variables. So, if you are working with [TestingBot](https://testingbot.com/), for example, you'd have to replace the Remote URL variable in _tests/acceptance/resources/mobile.robot_:\n\n ${REMOTE URL} http://${CREDENTIALS}@hub.testingbot.com/wd/hub\n\nBefore running the Android Hybrid App tests, you need to install the Demo App (APK found at _tests/resources_) in your device.\n\nFor in depth detail on how the keywords function, read the Keyword documentation found here: [Keyword Documentation](https://joel-oliveira.github.io/EyesLibrary/)\n\n**Remember to include your Applitools API key otherwise the\ntest will not run.** To run a test, open a command prompt within the _tests/acceptance_ folder and run:\n\n robot FILENAME.robot\n\nFor example, to run the Test Suite for Web:\n\n robot web.robot\n\n**Note:** It is assumed that anyone who wants to use this demo is already able to execute robot tests using SeleniumLibrary (for web tests) and/or AppiumLibrary (for mobile tests). The browser used to navigate with SeleniumLibrary is Google Chrome.\n\n## Things to Note When Using Applitools\n\n- The tests will be accepted automatically by Applitools Eyes after the first run because a new baseline is being created. A second test run will show a comparison between screens.\n- Changing the Applitools baseline parameters will create a new baseline, that is automatically accepted on the first run. (For more information, read the article: [What is a \u2018baseline\u2019 and how is a baseline created?](https://help.applitools.com/hc/en-us/articles/360007188691-What-is-a-baseline-and-how-is-a-baseline-created-)\n- The viewport size should not be set to greater values than the maximum size of the device's window.\n(For more information on using viewports, consult [Using viewports in Eyes](https://applitools.com/docs/topics/general-concepts/using-viewports-in-eyes.html))\n\n## Getting Help\n\nTo be defined. It might be helpful to read [Applitools Documentation](https://applitools.com/docs).\n\n## Credits\n\nEyesLibrary was forked from [Robot-AppEyes](https://github.com/NaviNet/Robot-AppEyes) on version 1.2.\n\nRobot-AppEyes authors:\n\n- [Thomas Armstrong](https://github.com/tbarmstrong)\n- [Simon McMorran](https://github.com/SIMcM)\n- [Gareth Nixon](https://github.com/GarethNixon)\n- [Adam Simmons](https://github.com/adamsimmons)\n\nEyesLibrary then emerged as an independent library from the original one, on version 2.0.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/joel-oliveira/EyesLibrary", "keywords": "robotframework testing testautomation eyes-selenium selenium appium visual-verification", "license": "Apache License 2.0", "maintainer": "", "maintainer_email": "", "name": "robotframework-eyeslibrary", "package_url": "https://pypi.org/project/robotframework-eyeslibrary/", "platform": "any", "project_url": "https://pypi.org/project/robotframework-eyeslibrary/", "project_urls": { "Homepage": "https://github.com/joel-oliveira/EyesLibrary" }, "release_url": "https://pypi.org/project/robotframework-eyeslibrary/2.1/", "requires_dist": [ "robotframework (<4,>3.0)", "eyes-selenium (<4,>=3.16.2)", "six (<2,>1.0.0)", "robotframework-seleniumlibrary", "robotframework-appiumlibrary" ], "requires_python": "", "summary": "Visual verification testing library for Robot Framework", "version": "2.1" }, "last_serial": 5222684, "releases": { "2.0": [ { "comment_text": "", "digests": { "md5": "25e83561a58cd601fa324715269b74f7", "sha256": "c18cfb008d743dc4c52194b865211642410295fb52a75eedb5a7dae42b1e5db3" }, "downloads": -1, "filename": "robotframework-eyeslibrary-2.0.tar.gz", "has_sig": false, "md5_digest": "25e83561a58cd601fa324715269b74f7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6028650, "upload_time": "2019-03-20T12:05:04", "url": "https://files.pythonhosted.org/packages/d4/a6/b79e0ac6e9dd123cf6cf9c947918df3315243f49fc0717d9928261e6c114/robotframework-eyeslibrary-2.0.tar.gz" } ], "2.0.post0": [ { "comment_text": "", "digests": { "md5": "787686d1916dd14e62aaa60256c363b5", "sha256": "1386c2d4c43271921320bb67b7e5e6b4b5986bde2422f9bfd6a67bb681a427f4" }, "downloads": -1, "filename": "robotframework-eyeslibrary-2.0.post0.tar.gz", "has_sig": false, "md5_digest": "787686d1916dd14e62aaa60256c363b5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6028624, "upload_time": "2019-03-20T13:09:01", "url": "https://files.pythonhosted.org/packages/0a/cc/5d4c80728c45ce8e9fe7f6163979e7cebf5006436b5fd93bfc3b775375b0/robotframework-eyeslibrary-2.0.post0.tar.gz" } ], "2.0.post1": [ { "comment_text": "", "digests": { "md5": "dea27f6f0cc5556f7f317a5cf1ca6ac1", "sha256": "a8cf8fca39f0ac1051492956c0f880d22eed59bbc69dff9567fecbb187aabaab" }, "downloads": -1, "filename": "robotframework-eyeslibrary-2.0.post1.tar.gz", "has_sig": false, "md5_digest": "dea27f6f0cc5556f7f317a5cf1ca6ac1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6028361, "upload_time": "2019-03-20T15:34:04", "url": "https://files.pythonhosted.org/packages/35/c1/51d750b6cf5c7b3e0a4fca987a87556e7165899b35854ba919826ff9f8ce/robotframework-eyeslibrary-2.0.post1.tar.gz" } ], "2.1": [ { "comment_text": "", "digests": { "md5": "f14068355ac102a8bab7a238b89e3bf1", "sha256": "ac73a5e07ab679a956c8d63fcbd4a264de66091473199f28952e0bf31a849a2e" }, "downloads": -1, "filename": "robotframework_eyeslibrary-2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "f14068355ac102a8bab7a238b89e3bf1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 24607, "upload_time": "2019-05-03T16:23:16", "url": "https://files.pythonhosted.org/packages/d7/9e/dcf97fd9ed60d2ef72ce2fe628adde80eb55df3a70e3da2bac3941a01194/robotframework_eyeslibrary-2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c802e1a48859d31ae8bcbcc3163c7798", "sha256": "08e2fac4c48ef4b5689bcd2820176b256810a4ba8116f9d8ddeafc1818e149da" }, "downloads": -1, "filename": "robotframework-eyeslibrary-2.1.tar.gz", "has_sig": false, "md5_digest": "c802e1a48859d31ae8bcbcc3163c7798", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20848, "upload_time": "2019-05-03T16:23:17", "url": "https://files.pythonhosted.org/packages/4f/bc/686548d2e7e5db6d01decf99845410fead24d33c0742ae3535ce63b11487/robotframework-eyeslibrary-2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f14068355ac102a8bab7a238b89e3bf1", "sha256": "ac73a5e07ab679a956c8d63fcbd4a264de66091473199f28952e0bf31a849a2e" }, "downloads": -1, "filename": "robotframework_eyeslibrary-2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "f14068355ac102a8bab7a238b89e3bf1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 24607, "upload_time": "2019-05-03T16:23:16", "url": "https://files.pythonhosted.org/packages/d7/9e/dcf97fd9ed60d2ef72ce2fe628adde80eb55df3a70e3da2bac3941a01194/robotframework_eyeslibrary-2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c802e1a48859d31ae8bcbcc3163c7798", "sha256": "08e2fac4c48ef4b5689bcd2820176b256810a4ba8116f9d8ddeafc1818e149da" }, "downloads": -1, "filename": "robotframework-eyeslibrary-2.1.tar.gz", "has_sig": false, "md5_digest": "c802e1a48859d31ae8bcbcc3163c7798", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20848, "upload_time": "2019-05-03T16:23:17", "url": "https://files.pythonhosted.org/packages/4f/bc/686548d2e7e5db6d01decf99845410fead24d33c0742ae3535ce63b11487/robotframework-eyeslibrary-2.1.tar.gz" } ] }