How do you run a Python script as a service in Windows?

python

service-management

windows-services

python-scripts

byNikita Barsukov·Feb 14, 2025

Swiftly transform a python script into a Windows service by using the pywin32 module. Sketch a service class that extends win32serviceutil.ServiceFramework, override the SvcDoRun and SvcStop methods to handle service start and stop events. Install and manage the service from the command line of your python script. Here's an illustrative example:

import win32serviceutil
import win32service
import win32event

class PythonService(win32serviceutil.ServiceFramework):
    _svc_name_ = 'MyPythonService'
    _svc_display_name_ = 'My Python Service'

    def __init__(self, args):
        win32serviceutil.ServiceFramework.__init__(self, args)
        self.is_alive = win32event.CreateEvent(None, 0, 0, None)  # Initiate a life signal. It's alive!

    def SvcStop(self):
        self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING)  
        win32event.SetEvent(self.is_alive)  # Sends the termination signal. This is your one-way ticket, buddy!

    def SvcDoRun(self):
        # Set up a loop that waits for a stop event
        while win32event.WaitForSingleObject(self.is_alive, 5000) == win32event.WAIT_TIMEOUT:
            # Core logic of your script here
            # It's like the life of a programmer: eat, sleep, code, repeat!

if __name__ == '__main__':
    win32serviceutil.HandleCommandLine(PythonService)

Use the following commands to install and start the service:

python YourServiceScript.py install
python YourServiceScript.py start

This offers a resilience solution to run your Python script as a Windows service discretely.

Enhancing your service

Using NSSM to simplify service management

NSSM (Non-Sucking Service Manager) offers a graphical interface that simplifies the operation of running scripts as services. It allows efficient use of batch scripting and setting environment variables, giving you control over the service behavior flexibility.

Registering your service with `sc.exe`

For a more direct command-line approach use sc.exe to register your Python script and executable as a service within windows without any additional lines of code:

sc create PythonScriptService binpath= "C:\Path\To\Python.exe C:\Path\To\YourScript.py"

Leveraging Python and Django for service management

Using the Python scripting language and the Django web framework, build interfaces for managing and observing your services giving you web-based controls and extending flexibility for service management.

Transferring Linux daemon experience

If you hail from a Linux background, you can transfer your knowledge of daemonizing applications to inform the design of Windows services. Although the implementation differs, the concept remains the same.

Managing real-life challenges

Service logging and error handling

Servicemanager can be used for efficient logging and error-handling providing a comprehensive understanding of the service's performance and potential issues, essential for troubleshooting and maintaining audit trails.

Handling environmental variables

Services pulled into different environments (development, staging, production) may be required to behave differently. Implement dynamic configurations based on environment variables to counter this situation.

Managing dependencies

Python services can rely on specific versions or third-party modules of Python. Ensure these dependencies are met using virtual environments and PyInstaller to create standalone executables with all dependencies bundled inside.

Expert service management

Scalability of services

Services might need to scale to manage growth. Use virtual environments to isolate and manage potential scalability issues of your Python services.

Fine-tuning service using registry settings

The service behavior can be controlled at a deeper level by modifying the Windows Registry path HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services, offering a higher degree of customization.

Seamless updates and maintenance

Plan services supporting hot updates and graceful shutdowns ensuring minimal downtime. Consider a rigorous update mechanism allowing the service to be updated without manual interventions.

explain-codes / Python / How do you run a Python script as a service in Windows?

Linked

How to execute a Python script from the Django shell?



What is an alternative to execfile in Python 3?



How do I load a file into the python console?



Should I put #! (shebang) in Python scripts, and what form should it take?



How to call a script from another script?

