Creating a Windows Service with Python

README.md

Creating a Windows Service with Python 3

Requirements

• Python 3.*
• Visual C++ Build Tools 2015
• PyInstaller 3.2

Build

(env)$ pyinstaller -F --hidden-import=win32timezone WindowsService.py

Run

(env) dist\WindowsService.exe install
Installing service TestService
Service installed

(env) dist\WindowsService.exe start
Starting service TestService

Clean

(env) dist\WindowsService.exe stop
(env) dist\WindowsService.exe remove

Use Cases / Examples

• File Sync Service
• Ping Service
• FTP <> Database Sync Service
• System Performance Monitoring Service
• Client - Server Endpoint Services (Custom - SSH over endpoint)

WindowsService.py

import servicemanager
import socket
import sys
import win32event
import win32service
import win32serviceutil

class TestService(win32serviceutil.ServiceFramework):
    _svc_name_ = "TestService" #Service Name (exe)
    _svc_display_name_ = "Test Service" #Service Name which will display in the Winfows Services Window 
    _svc_description_ = "My service description" ##Service Name which will display in the Winfows Services Window

    def __init__(self, args):
      '''
      Used to initialize the service utility. 
      '''
        win32serviceutil.ServiceFramework.__init__(self, args)
        self.hWaitStop = win32event.CreateEvent(None, 0, 0, None)
        socket.setdefaulttimeout(60)

    def SvcStop(self):
      '''
      Used to stop the service utility (restart / timeout / shutdown)
      '''
        self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING)
        win32event.SetEvent(self.hWaitStop)

    def SvcDoRun(self):
      '''
      Used to execute all the piece of code that you want service to perform.
      '''
        rc = None
        while rc != win32event.WAIT_OBJECT_0:
            with open('C:\\TestService.log', 'a') as f:
                f.write('test service running...\n')
            rc = win32event.WaitForSingleObject(self.hWaitStop, 5000)


if __name__ == '__main__':
    if len(sys.argv) == 1:
        servicemanager.Initialize()
        servicemanager.PrepareToHostSingle(TestService)
        servicemanager.StartServiceCtrlDispatcher()
    else:
        win32serviceutil.HandleCommandLine(TestService)

https://www.mssqltips.com/sqlservertip/7318/python-as-a-windows-service/