Kazuaki Matsuo
3e98cc98f3
* fix: fix urls in docs (#14910) * docs: Update generated docs [ci skip] (#14913) Co-authored-by: runner <runner@Mac-1606273407156.local> * feat: Add Mac2Driver (#14911) * docs: Add Mac2Driver documentation (#14914) * chore: add scripts for doing releases (#14918) * docs: Update push-file.yml (#14920) * chore: fix a link in appium.io (#14929) * fix links * fix * docs: Update generated docs [ci skip] (#14930) Co-authored-by: runner <runner@Mac-1607067954655.local> * docs: removed deprecated method (#14934) assert.equal was deprecated — since v9.9.0 - use strictEqual() instead. * docs: add links to mac2 driver in caps and settings (#14942) * cods: add links to mac2 driver in caps and settings * tweak naming * chore: remove authorize-ios from package (#14946) * chore: add 1.19.1 in changelog (#14947) * feat: add --keep-alive-timeout CLI arg to adjust server keepalive and connection timeout * rename release-candidate.sh to release * chore: Switch to GitHub CI (#14978) * docs: changelog for Appium v1.20 (#14985) * docs: swap out hamcrest.org reference * docs: fix example comment (#14995) changed the app name in a comment for the notepad example from AlarmClock to Notepad * docs: update README with english tutorial version to learn Appium with Python (#14999) * update README * Update README.md * remove duplicated lib/parser.js * install fakedriver Co-authored-by: Appium Triager <maintainers@appium.io> Co-authored-by: runner <runner@Mac-1606273407156.local> Co-authored-by: Mykola Mokhnach <mokhnach@gmail.com> Co-authored-by: Dan Graham <dpgraham.85@gmail.com> Co-authored-by: Ilija Boshkov <ilija.boshkov@gmail.com> Co-authored-by: runner <runner@Mac-1607067954655.local> Co-authored-by: roman-olshevskiy <56480723+roman-olshevskiy@users.noreply.github.com> Co-authored-by: Jonathan Lipps <jlipps@gmail.com> Co-authored-by: BoldAsLove <john.wojner@gmail.com> Co-authored-by: Maria Clara dos Santos Bezerra <clarinhab@gmail.com>
Appium
Appium is an open-source, cross-platform test automation tool for native, hybrid, and mobile web and desktop apps. We support simulators (iOS), emulators (Android), and real devices (iOS, Android, Windows, Mac).
Want to skip straight to the action? Check out our getting started doc.
Supported Platforms
Appium supports app automation across a variety of platforms, like iOS, Android, and Windows. Each platform is supported by one or more "drivers", which know how to automate that particular platform. Choose a driver below for specific information about how that driver works and how to set it up:
- iOS
- The XCUITest Driver
- (DEPRECATED) The UIAutomation Driver
- Android
- The Espresso Driver
- The UiAutomator2 Driver
- (DEPRECATED) The UiAutomator Driver
- The Windows Driver (for Windows Desktop apps)
- The Mac Driver (for Mac Desktop apps)
Why Appium?
- You don't have to recompile your app or modify it in any way, due to the use of standard automation APIs on all platforms.
- You can write tests with your favorite dev tools using any WebDriver-compatible language such as Java, Objective-C, JavaScript (Node), PHP, Python, Ruby, C#, Clojure, or Perl with the Selenium WebDriver API and language-specific client libraries.
- You can use any testing framework.
- Appium has built-in mobile web and hybrid app support. Within the same script, you can switch seamlessly between native app automation and webview automation, all using the WebDriver model that's already the standard for web automation.
Investing in the WebDriver protocol means you are betting on a single, free, and open protocol for testing that has become a web standard. Don't lock yourself into a proprietary stack.
For example, if you use Apple's XCUITest library without Appium you can only write tests using Obj-C/Swift, and you can only run tests through Xcode. Similarly, with Google's UiAutomator or Espresso, you can only write tests in Java/Kotlin. Appium opens up the possibility of true cross-platform native app automation, for mobile and beyond. Finally!
If you're new to Appium or want a more comprehensive description of what this is all about, please read our Introduction to Appium Concepts.
Requirements
Your environment needs to be set up for the particular platforms that you want to run tests on. Each of the drivers above documents the requirements for their particular brand of automation. At a minimum, you will need to be able to run Node.js 10+.
Get Started
Check out our Getting Started guide to get going with Appium.
There is also a sample code that contains many examples of tests in a variety of different languages!
Documentation
For prettily-rendered docs, please visit appium.io. You can always find the full list of Appium doc pages at Appium's GitHub Repo as well.
update-appium-io.yml creates a PR by CI job. in the appium.io repository with the documentation update.
Once the PR has been merged, the latest documentation will be in appium.io
Contributing
Please take a look at our contribution documentation for instructions on how to build, test, and run Appium from the source.
Roadmap
Interested in where Appium is heading in the future? Check out the Roadmap
Project History, Credits & Inspiration
User Forums
Announcements and debates often take place on the Discussion Group, be sure to sign up!
Troubleshooting
We put together a troubleshooting guide. Please have a look here first if you run into any problems. It contains instructions for checking a lot of common errors and how to get in touch with the community if you're stumped.
License
