Skip to main content

A Python package for cross-platform process management, providing process data as dicts/JSON and allowing process control (start, stop, kill) on Windows, Mac, and Linux.

Project description

Process Inspector

Coverage

Overview

A Python package for cross-platform process management, providing process data as dicts/JSON and allowing process/service control (start, stop, kill) on Windows, Mac, and Linux (Raspberry Pi).

Installation

Use uv or pip.

uv add process-inspector
python3 -m pip install process-inspector

Development

To get a list of all commands with descriptions simply run make.

make env
make pip_install_editable

Testing

make pytest
make coverage
make open_coverage

Issues

If you experience any issues, please create an issue on Github.

Example Usage

from process_inspector import NativeApp
from process_inspector import Service
from process_inspector import Teamviewer
from process_inpsector import OperatingSystem

# App control
app = NativeApp('C:/Program Files (x86)/Microsoft/Edge/Application/msedge.exe')
app.open()
app.is_running()
app.get_version()
app.as_dict()
app.process_info()
app.close()

# Teamviewer
tv = Teamviewer()
tv.open()
tv.is_running()
tv.close()
tv.get_teamviewer_info()

# This operation requires sudo priveleges on Linux and Mac
# Service control
service = Service("Spooler")
service.start()
service.is_running()
service.stop()

# This operation requires sudo priveleges on Linux and Mac
OperatingSystem().reboot()

Use with Caution!

To control system services we need to allow passwordless use of specific executables. You should know the security implications of doing this so use at your own risk.

Linux

Use sudo visudo to add the following lines:

%sudo ALL=(ALL) NOPASSWD: /usr/bin/supervisorctl
%sudo ALL=(ALL) NOPASSWD: /usr/bin/systemctl
%sudo ALL=(ALL) NOPASSWD: /usr/sbin/reboot

Save and exit the file (:wq!). Then do:

sudo nano /etc/supervisor/supervisord.conf

Adjust the config so your user can access it:

[unix_http_server]
chmod=0770
chown=root:pi

Then restart supervisor:

sudo systemctl restart supervisor

macOS

Use sudo visudo to add the following lines:

%admin ALL=(ALL) NOPASSWD: /opt/homebrew/bin/supervisorctl
%admin ALL=(ALL) NOPASSWD: /sbin/reboot

Save and exit the file (:wq!).

History

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

0.2.0 (2025-11-13)

  • ADDED - Allow Service to accept a state_change_callback which is called when the is_running status changes (if monitoring).

0.1.9 (2025-11-10)

  • ADDED - Remove log event for ScheduledTask commands. Too verbose.
  • ADDED - On macOS, "ask" the app to quit gracefully via osascript, then if it does not, force kill the process via psutil. This addresses an issue where apps like TeamViewer, which have watchdog processes, will try to restart the app if killed via SIGTERM/SIGKILL.
  • FIXED - Bug with invalidating stale PID/Process cache
  • ADDED - Allow NativeApp and TeamViewer to accept a state_change_callback which is called when the is_running status changes (if monitoring).

0.1.8 (2025-11-04)

  • ADDED - ScheduledTask basic control (start, stop) for Windows only.

0.1.7 (2025-10-10)

  • ADDED - Added UnityApp class which is just an extended NativeApp class with some additional getters to make things easier when working with Unity builds.
  • Added last_seen to process_info for Service and NativeApp

0.1.6 (2025-10-02)

  • CHANGED - Service class on Mac/Linux defaults to supervisorctl
  • ADDED - If you want to use systemctl on Linux you can do from process_inspector.servicecontrol import service_class_factory and then instantiate with Service = service_class_factory('systemctl').

0.1.5 (2025-09-29)

  • CHANGED - get_process_info can fail if the process was killed by the user within Windows/Mac. This fix handles that by resetting the cache so the process is looked up again.

0.1.4 (2025-09-23)

  • CHANGED - Fixed failing Linux tests

0.1.3 (2025-09-16)

  • CHANGED - Improved query times for process running and process info

0.1.2 (2025-09-11)

  • ADDED - Service control (Windows Services or Linux/ Mac supervisorctl processes)
  • ADDED - TeamViewer status and basic control (start, stop)

0.1.1 (2025-09-11)

  • ADDED - more test coverage

0.1.0 (2025-09-11)

  • First release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

process_inspector-0.2.0.tar.gz (28.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

process_inspector-0.2.0-py3-none-any.whl (32.0 kB view details)

Uploaded Python 3

File details

Details for the file process_inspector-0.2.0.tar.gz.

File metadata

  • Download URL: process_inspector-0.2.0.tar.gz
  • Upload date:
  • Size: 28.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for process_inspector-0.2.0.tar.gz
Algorithm Hash digest
SHA256 3253a2f54293c18911d2d1b9f7e3bfcfaa1fcc7f9dd29082a7824819d9296890
MD5 9a1bfe7c5249505b3fb0bbef319f99ff
BLAKE2b-256 620a41fb9839249d751daa25d1abd8a0c2a43a03f5126cc6c17bc3687cdfb8d2

See more details on using hashes here.

File details

Details for the file process_inspector-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for process_inspector-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 04c1620b8f869a15483f2ab39ac22dd5950eb36fa5fa5368157706e8dbca70a2
MD5 9e4d9829e0b99cec9ad24bb99cb78730
BLAKE2b-256 446662aef04c36551b334e451a6f8ecf0dd2153c9399ba4215e3afafbf98bf74

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page