How to start appium server programmatically in Python

Question

I want to write a android test framework using Appium and python. Appium link: http://appium.io/

So after installing appium with npm, to start its server I need to execute the command "appium" in terminal.It will start the server. It looks something like this after starting:

    ranits-MacBook-Pro:$ appium
[Appium] Welcome to Appium v1.8.1
[Appium] Appium REST http interface listener started on 0.0.0.0:4723

But I need to start the appium server from my code using python?

Any help?

we need more information on what exactly you are trying to do — Ryan Schaefer, Aug 07 '18 at 19:51
Please check [How do I ask a good question](https://stackoverflow.com/help/how-to-ask) — Kay, Aug 07 '18 at 19:52
@AlImran I'm aware of the CoC, could you clarify how this relates to my comment? Particularly as the first link in the "Expectations" box is the same page I linked to? — Kay, Aug 08 '18 at 09:57

score 2 · Answer 1 · answered Apr 25 '19 at 18:37

2

The Python client actually comes with a handy module called AppiumService that you can use to programmatically start/stop an Appium server.

from appium.webdriver.appium_service import AppiumService

appium_service = AppiumService()

To start,

self.appium_service.start()

To stop,

self.appium_service.stop()

That's literally it, and I believe it's a cleaner way to start/stop the Appium server than issuing an OS system command to like in the above solution(s).

answered Apr 25 '19 at 18:37

sohum

44
5

1

Thanks @sohum, how to pass the port number? – Gauthier Buttez Jan 30 '20 at 07:10
Like this: `self.appium_service.start(args=['-p 1000'])`, where `-p` is a port flag and `1000` is the number of your port. – Václav Apr 27 '21 at 10:42

score 1 · Answer 2 · edited Apr 29 '22 at 08:13

1

To start the appium server Programmatically (Python way) all you have to do is execute the below code

import OS
os.System("appium")

This would start the appium server in the backend .Other way to start the appium server is

import os
os.system(/Path/of/ur/main.js)

Enter these code in a py file and execute .. the server will start

edited Apr 29 '22 at 08:13

0m3r

12,286
15
35
71

answered Oct 24 '18 at 06:58

Satyendra Tripathi

11
2

score 1 · Accepted Answer · edited Aug 08 '22 at 15:11

First of all its good to check manually if "appium" command on shell launches the appium server or not(Seems in your case its working fine). In my case it was not with the installation of Appium desktop version. Posting the details of what i did to resolve this in case it helps someone:

Installed npm (as part of node installation, MSI available at nodejs.org)
npm install -g appium

Now to answer your main question, below is what i used in my Python script to start the appium server on a new window so that it runs separately from the rest of the script execution:

import os
os.system("start /B start cmd.exe @cmd /k appium")

In case you want to change the port(e.g. to 4728) of the appium server (may be when you have multiple servers for multiple devices) you can use following:

os.system("start /B start cmd.exe @cmd /k appium -a 127.0.0.1 -p 4728")

if you want to stop that appium service. Add these two lines on your code:

os.system("taskkill /F /IM node.exe")
os.system("taskkill /F /IM cmd.exe")

How to start appium server programmatically in Python

3 Answers3