{"id":21944751,"url":"https://github.com/browserstack/behave-appium-app-browserstack","last_synced_at":"2025-07-23T06:03:34.942Z","repository":{"id":43699469,"uuid":"108263511","full_name":"browserstack/behave-appium-app-browserstack","owner":"browserstack","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-20T07:06:35.000Z","size":35370,"stargazers_count":3,"open_issues_count":3,"forks_count":10,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-06-19T11:50:46.755Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/browserstack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-10-25T11:57:25.000Z","updated_at":"2025-05-20T18:45:23.000Z","dependencies_parsed_at":"2024-11-20T08:38:04.195Z","dependency_job_id":null,"html_url":"https://github.com/browserstack/behave-appium-app-browserstack","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/browserstack/behave-appium-app-browserstack","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fbehave-appium-app-browserstack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fbehave-appium-app-browserstack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fbehave-appium-app-browserstack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fbehave-appium-app-browserstack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/browserstack","download_url":"https://codeload.github.com/browserstack/behave-appium-app-browserstack/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fbehave-appium-app-browserstack/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266626115,"owners_count":23958344,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-29T04:17:02.709Z","updated_at":"2025-07-23T06:03:34.918Z","avatar_url":"https://github.com/browserstack.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# behave-appium-app-browserstack\n\nThis repository demonstrates how to run Appium Behave tests on BrowserStack App Automate using SDK.\n\n### Requirements\n\n* Python3\n\n## Setup\n\n* Clone the repo with `git clone -b sdk https://github.com/browserstack/pytest-appium-app-browserstack.git`\n* It is recommended to use a virtual environment to install dependencies. To create a virtual environment:\n  ```\n  python3 -m venv env\n  source env/bin/activate # on Mac\n  env\\Scripts\\activate # on Windows\n  ```\n* Install dependencies `pip install -r requirements.txt`\n* To run your automated tests using BrowserStack, you must provide a valid username and access key. This can be done either by providing your username and access key in the `browserstack.yml` configuration file, or by setting the `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY` environment variables.\n\n## Getting Started\n\nGetting Started with Appium tests in Behave on real BrowserStack couldn't be easier!\n\n### **Run first test :**\n\n**1. Upload your Android or iOS App**\n\nSpecify your Android app (.apk or .aab file) or iOS app (.ipa file) in the `browserstack.yml` configuration file. Here is an example app config :\n\n```\napp: '/path/to/local/app.apk'\n```\n\nSet `app` to use the appliction under test for Appium sessions. Available options: app: `/path/to/local/app.apk` OR app: `bs://\u003capp-id\u003e` i.e App URL returned when uploading the app to BrowserStack manually. Visit https://www.browserstack.com/docs/app-automate/appium/set-up-tests/specify-app for more options\n\n**Note**: If you do not have an .apk or .ipa file and are looking to simply try App Automate, you can download and test using our [sample Android app](https://www.browserstack.com/app-automate/sample-apps/android/WikipediaSample.apk) or [sample iOS app](https://www.browserstack.com/app-automate/sample-apps/ios/BStackSampleApp.ipa).\n\n**2. Configure and run your first single test**\n\nOpen `browserstack.yml` file in `android` folder for Android and `ios` folder for iOS:\n\n- Replace `YOUR_USERNAME` \u0026 `YOUR_ACCESS_KEY` in the `browserstack.yml` configuration file. Get your BrowserStack access credentials from [here](https://www.browserstack.com/accounts/settings)\n\n- Replace `app: bs://\u003capp-id\u003e` with the URL obtained from app upload step or mention the path to your apk file.\n\n- Run the below command to execute a Android test on BrowserStack AppAutomate:\n    ```\n    cd android\n    browserstack-sdk behave features/first_test.feature\n    ```\n\n- Run the below command to execute a iOS test on BrowserStack AppAutomate:\n    ```\n    cd ios\n    browserstack-sdk behave features/first_test.feature\n    ```\n\n- You can access the test execution results, and debugging information such as video recording, network logs on [App Automate dashboard](https://app-automate.browserstack.com/dashboard)\n\n### **Use Local testing for apps that access resources hosted in development or testing environments :**\n\nOpen `browserstack.yml` file in `android` folder for Android and `ios` folder for iOS:\n\n- Replace `YOUR_USERNAME` \u0026 `YOUR_ACCESS_KEY` in the `browserstack.yml` configuration file. Get your BrowserStack access credentials from [here](https://www.browserstack.com/accounts/settings)\n\n- Replace `app: bs://\u003capp-id\u003e` with the URL obtained from app upload step or mention the path to your apk file.\n\n- Run the below command to execute a Android test on BrowserStack AppAutomate:\n    ```\n    cd android\n    browserstack-sdk behave features/first_test.feature\n    ```\n\n- Run the below command to execute a iOS test on BrowserStack AppAutomate:\n    ```\n    cd ios\n    browserstack-sdk behave features/first_test.feature\n    ```\n\n- You can access the test execution results, and debugging information such as video recording, network logs on [App Automate dashboard](https://app-automate.browserstack.com/dashboard)\n\n**Note**: If you are facing any issues, refer [Getting Help section](#Getting-Help)\n\n## Integration with other python frameworks\n\nFor other Python frameworks samples, refer to following repositories :\n\n- [Lettuce](https://github.com/browserstack/lettuce-appium-app-browserstack)\n- [Python Native](https://github.com/browserstack/python-appium-app-browserstack)\n\nNote: For other test frameworks supported by App-Automate refer our [Developer documentation](https://www.browserstack.com/docs/)\n\n## Getting Help\n\nIf you are running into any issues or have any queries, please check [Browserstack Support page](https://www.browserstack.com/support/app-automate) or [get in touch with us](https://www.browserstack.com/contact?ref=help).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrowserstack%2Fbehave-appium-app-browserstack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrowserstack%2Fbehave-appium-app-browserstack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrowserstack%2Fbehave-appium-app-browserstack/lists"}