|
| 1 | +AppiumFlutterLibrary |
| 2 | +==================== |
| 3 | + |
| 4 | +.. image:: https://img.shields.io/pypi/v/robotframework-appiumflutterlibrary?color=blue |
| 5 | + :target: https://pypi.python.org/pypi/robotframework-appiumflutterlibrary/ |
| 6 | + :alt: Latest PyPI version |
| 7 | + |
| 8 | +.. image:: https://img.shields.io/pypi/dm/robotframework-appiumflutterlibrary |
| 9 | + :target: https://pypi.python.org/pypi/robotframework-appiumflutterlibrary/ |
| 10 | + :alt: Number of PyPI downloads |
| 11 | + |
| 12 | +`AppiumFlutterLibrary`_ is a library for testing Flutter apps with `RobotFramework`_. |
| 13 | + |
| 14 | +The project uses the `Flutter Driver`_ test tools integrated to `Appium`_ as a `RobotFramework`_ library. |
| 15 | + |
| 16 | +Installation |
| 17 | +------------ |
| 18 | + |
| 19 | +The recommended installation method is using |
| 20 | +`pip <http://pip-installer.org>`__:: |
| 21 | + |
| 22 | + pip install --upgrade robotframework-appiumflutterlibrary |
| 23 | + |
| 24 | + |
| 25 | +See `Robot Framework installation instructions`_ for detailed information |
| 26 | +about installing Python and Robot Framework itself. |
| 27 | + |
| 28 | +Keyword documentation |
| 29 | +--------------------- |
| 30 | + |
| 31 | +AppiumFlutterLibrary has a complete `Keyword Documentation`_. |
| 32 | + |
| 33 | +Flutter setup |
| 34 | +------------- |
| 35 | + |
| 36 | +To use AppiumFlutterLibrary you will need to make a simple setup in your Flutter project. |
| 37 | + |
| 38 | +At first, include flutter_driver package to your dev dependencies at *pubspec.yaml*: |
| 39 | + |
| 40 | +.. code:: yaml |
| 41 | + |
| 42 | + dev_dependencies: |
| 43 | + flutter_test: |
| 44 | + sdk: flutter |
| 45 | + flutter_driver: |
| 46 | + sdk: flutter |
| 47 | + |
| 48 | + |
| 49 | +Then go to your `main.dart` file and add enableFlutterDriverExtension() to your main function before runApp() |
| 50 | + |
| 51 | +.. code:: dart |
| 52 | + |
| 53 | + import 'package:flutter/material.dart'; |
| 54 | + import 'package:flutter_driver/driver_extension.dart'; |
| 55 | + |
| 56 | + void main() { |
| 57 | + enableFlutterDriverExtension(); |
| 58 | + runApp(const MyApp()); |
| 59 | + } |
| 60 | + |
| 61 | + ... |
| 62 | + |
| 63 | + |
| 64 | +.. _AppiumFlutterLibrary: https://github.com/igortavtib/robotframework-appiumflutterlibrary |
| 65 | +.. _FlutterDriver: https://flutter.dev/docs/cookbook/testing/integration/introduction |
| 66 | +.. _Robot Framework: https://robotframework.org |
| 67 | +.. _Appium: https://appium.io/ |
| 68 | +.. _Keyword Documentation: http://igortavtib.github.io/robotframework-appiumflutterlibrary/AppiumFlutterLibrary.html |
| 69 | +.. _PyPI: https://pypi.org/project/robotframework-appiumflutterlibrary/ |
| 70 | +.. _Robot Framework installation instructions: https://github.com/robotframework/robotframework/blob/master/INSTALL.rst |
| 71 | +.. _Appium Driver Setup Guide: http://appium.io/docs/en/about-appium/getting-started/?lang=en |
| 72 | +.. _sample project: https://github.com/serhatbolsu/robotframework-appium-sample |
0 commit comments